Start-ServiceFabricComposeDeploymentUpgrade

リファレンス

モジュール:: ServiceFabric

プレビュー。新しい作成ファイルを使用して Service Fabric Compose デプロイをアップグレードします。

構文

Start-ServiceFabricComposeDeploymentUpgrade
     [-DeploymentName] <String>
     [-Compose] <String>
     [[-RegistryUserName] <String>]
     [[-RegistryPassword] <String>]
     [-PasswordEncrypted]
     [-ForceRestart]
     [[-UpgradeReplicaSetCheckTimeoutSec] <UInt32>]
     [-UnmonitoredAuto]
     [-Force]
     [-TimeoutSec <Int32>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-ServiceFabricComposeDeploymentUpgrade
     [-DeploymentName] <String>
     [-Compose] <String>
     [[-RegistryUserName] <String>]
     [[-RegistryPassword] <String>]
     [-PasswordEncrypted]
     [-ForceRestart]
     [[-UpgradeReplicaSetCheckTimeoutSec] <UInt32>]
     [-UnmonitoredManual]
     [-Force]
     [-TimeoutSec <Int32>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-ServiceFabricComposeDeploymentUpgrade
     [-DeploymentName] <String>
     [-Compose] <String>
     [[-RegistryUserName] <String>]
     [[-RegistryPassword] <String>]
     [-PasswordEncrypted]
     [-ForceRestart]
     [[-UpgradeReplicaSetCheckTimeoutSec] <UInt32>]
     [-Monitored]
     -FailureAction <UpgradeFailureAction>
     [-HealthCheckRetryTimeoutSec <UInt32>]
     [-HealthCheckWaitDurationSec <UInt32>]
     [-HealthCheckStableDurationSec <UInt32>]
     [-UpgradeDomainTimeoutSec <UInt32>]
     [-UpgradeTimeoutSec <UInt32>]
     [-ConsiderWarningAsError <Boolean>]
     [-DefaultServiceTypeHealthPolicy <String>]
     [-MaxPercentUnhealthyDeployedApplications <Byte>]
     [-ServiceTypeHealthPolicyMap <Hashtable>]
     [-Force]
     [-TimeoutSec <Int32>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

説明

このコマンドレットはプレビュー段階であり、次のリリースで変更される可能性があります。互換性の保証はありません。

Start-ServiceFabricComposeDeploymentUpgrade コマンドレットは、Service Fabric Compose デプロイをアップグレードします。このコマンドレットは、クラスターでアップグレードを開始します。

Service Fabric クラスターで操作を実行する前に、 Connect-ServiceFabricCluster コマンドレットを使用してクラスターへの接続を確立します。

Service Fabric Compose のデプロイのガイダンスについては、「Service Fabric でのデプロイの作成」を参照してください。

例

例 1: Compose デプロイをアップグレードする

PS C:\> Start-ServiceFabricComposeDeploymentUpgrade -DeploymentName mydeployment -Compose docker-compose.yml -Monitored -FailureAction Rollback

このコマンドは、compose ファイル docker-compose.yml から mydeployment という名前の compose デプロイで、監視対象の自動アップグレードを実行します。監視対象のアップグレードが失敗した場合、アップグレードはロールバックされます。事前にアプリケーションの種類を登録する必要はありません。

パラメーター

-Compose

Service Fabric 作成のデプロイを記述するターゲット作成ファイルへのファイルパスを指定します。

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ConsiderWarningAsError

正常性評価中に警告正常性イベントをエラーイベントとして扱うかどうかを示します。

型:	Boolean
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultServiceTypeHealthPolicy

MaxPercentUnhealthyPartitionsPerService、MaxPercentUnhealthyReplicasPerPartition、MaxPercentUnhealthyServices の形式で、監視対象のアップグレードに使用する既定のサービスの種類に対して正常性ポリシーを指定します。たとえば、5,10,15 は、

MaxPercentUnhealthyPartitionsPerService = 5
MaxPercentUnhealthyReplicasPerPartition = 10
MaxPercentUnhealthyServices = 15

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DeploymentName

compose デプロイの名前を指定します。コマンドレットは、この名前で compose デプロイをアップグレードします。

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-FailureAction

監視対象のアップグレードが失敗した場合に実行するアクションを指定します。このパラメーターの有効値は、次のとおりです。

ロールバック
マニュアル

型:	UpgradeFailureAction
指定可能な値:	Invalid, Rollback, Manual
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Force

このコマンドレットが警告メッセージをスキップし、強制的にアップグレードすることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ForceRestart

新しい作成ファイルでサービスの説明が変更されなかった場合でも、作成ファイル内のすべてのコンテナーを再作成する必要があることを示します。

型:	SwitchParameter
配置:	5
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HealthCheckRetryTimeoutSec

前の正常性チェックが失敗した場合に Service Fabric が正常性チェックを再試行する期間を秒単位で指定します。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HealthCheckStableDurationSec

デプロイされたデプロイを構成するアプリケーションが、次のアップグレードドメインに移行するか、アップグレードを完了する前に安定していることを確認するために、Service Fabric が待機する時間 (秒単位) を指定します。この待機時間により、正常性チェックが実行された直後に検出されない正常性の変更が防止されます。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-HealthCheckWaitDurationSec

アップグレードドメインでのアップグレードが完了した後に、Service Fabric が初期正常性チェックを実行するまで待機する時間 (秒単位) を指定します。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-MaxPercentUnhealthyDeployedApplications

クラスターのアプリケーションの正常性状態がエラーである前に、クラスター内のノードにデプロイされたアプリケーションインスタンスの最大割合を指定します。

型:	Byte
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Monitored

アップグレードモードが監視対象であることを示します。コマンドレットによってアップグレードドメインのアップグレードを完了した後、定義した正常性ポリシーをアップグレードドメインとクラスターの正常性が満たしている場合、Service Fabric は次のアップグレードドメインをアップグレードします。アップグレードドメインまたはクラスターが正常性ポリシーを満たしていない場合、アップグレードは失敗し、Service Fabric は指定されたポリシーに従って、アップグレードドメインのアップグレードをロールバックするか、手動モードに戻ります。これは、運用環境でのデプロイアップグレードの作成に推奨されるモードです。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PasswordEncrypted

RegistryPassword が Invoke-ServiceFabricEncryptText によって暗号化されているかどうかを示します。

型:	SwitchParameter
配置:	4
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RegistryPassword

コンテナーレジストリのパスワードを示します。このパラメーターが指定されている場合は、 RegistryUserName を 一緒に指定する必要があります。

型:	String
配置:	3
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RegistryUserName

コンテナーレジストリのユーザー名を示します。このパラメーターが指定されている場合は、 RegistryPassword を一緒に指定する必要があります。

型:	String
配置:	2
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ServiceTypeHealthPolicyMap

ハッシュテーブルとしてさまざまなサービスの種類に使用する正常性ポリシーのマップを次の形式で指定します:@ {"ServiceTypeName" : "MaxPercentUnhealthyPartitionsPerService,MaxPercentUnhealthyReplicasPerPartition,MaxPercentUnhealthyServices"}。次に例を示します。

@{ "ServiceTypeName01" = "5,10,5";"ServiceTypeName02" = "5,5,5" }

型:	Hashtable
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TimeoutSec

操作のタイムアウト期間を秒単位で指定します。

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UnmonitoredAuto

アップグレードモードが監視対象外の自動であることを示します。 Service Fabric がアップグレードドメインをアップグレードした後、アプリケーションの正常性の状態に関係なく、Service Fabric は次のアップグレードドメインをアップグレードします。このモードは運用環境では推奨されず、作成デプロイの開発中にのみ役立ちます。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UnmonitoredManual

アップグレードモードが監視対象外の手動であることを示します。 Service Fabric は、アップグレードドメインをアップグレードした後、ユーザーが Resume-ServiceFabricApplicationUpgrade コマンドレットを使用して次のアップグレードドメインをアップグレードするまで待機します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UpgradeDomainTimeoutSec

Service Fabric が 1 つのアップグレードドメインをアップグレードするのにかかる最大時間 (秒単位) を指定します。この期間が経過すると、アップグレードは失敗します。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UpgradeReplicaSetCheckTimeoutSec

Service Fabric がアップグレードを続行する前に、Service Fabric がサービスを安全な状態に再構成するまで待機する最大時間を指定します (まだ安全な状態でない場合)。

型:	UInt32
配置:	6
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UpgradeTimeoutSec

Service Fabric がアップグレード全体に要する最大時間 (秒単位) を指定します。この期間が経過すると、アップグレードは失敗します。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

None

出力

System.Object

次の方法で共有

Start-ServiceFabricComposeDeploymentUpgrade

構文

説明

例

例 1: Compose デプロイをアップグレードする

パラメーター

-Compose

-Confirm

-ConsiderWarningAsError

-DefaultServiceTypeHealthPolicy

-DeploymentName

-FailureAction

-Force

-ForceRestart

-HealthCheckRetryTimeoutSec

-HealthCheckStableDurationSec

-HealthCheckWaitDurationSec

-MaxPercentUnhealthyDeployedApplications

-Monitored

-PasswordEncrypted

-RegistryPassword

-RegistryUserName

-ServiceTypeHealthPolicyMap

-TimeoutSec

-UnmonitoredAuto

-UnmonitoredManual

-UpgradeDomainTimeoutSec

-UpgradeReplicaSetCheckTimeoutSec

-UpgradeTimeoutSec

-WhatIf

入力

出力

その他のリソース

次の方法で共有

Start-ServiceFabricComposeDeploymentUpgrade

構文

説明

例

例 1: Compose デプロイをアップグレードする

パラメーター

-Compose

-Confirm

-ConsiderWarningAsError

-DefaultServiceTypeHealthPolicy

-DeploymentName

-FailureAction

-Force

-ForceRestart

-HealthCheckRetryTimeoutSec

-HealthCheckStableDurationSec

-HealthCheckWaitDurationSec

-MaxPercentUnhealthyDeployedApplications

-Monitored

-PasswordEncrypted

-RegistryPassword

-RegistryUserName

-ServiceTypeHealthPolicyMap

-TimeoutSec

-UnmonitoredAuto

-UnmonitoredManual

-UpgradeDomainTimeoutSec

-UpgradeReplicaSetCheckTimeoutSec

-UpgradeTimeoutSec

-WhatIf

入力

出力

関連リンク

その他のリソース