次の方法で共有


Start-ServiceFabricComposeDeploymentUpgrade

プレビュー。 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 での Compose デプロイ」を参照してください。

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

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

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

パラメーター

-Compose

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

型: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 がサービスを安全な状態に再構成するまでの最大時間を指定します。その後、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