PowerShell を使用してアプリケーションのデプロイと削除を実行する

  • [アーティクル]

アプリケーションの種類をパッケージ化した後は、Azure Service Fabric クラスターにデプロイできる状態になっています。 デプロイには、次の 3 つの手順が含まれます。

  1. アプリケーション パッケージをイメージ ストアにアップロードします。
  2. イメージ ストアの相対パスを使用してアプリケーションの種類を登録します。
  3. アプリケーション インスタンスを作成します。

デプロイしたアプリケーションが不要になったら、アプリケーション インスタンスとそのアプリケーションの種類を削除できます。 クラスターからアプリケーションを完全に削除するには、次の手順が必要です。

  1. 実行中のアプリケーションのインスタンスを削除します。
  2. アプリケーションの種類が不要になったら、その登録を解除します。
  3. イメージ ストアからアプリケーション パッケージを削除します。

Visual Studio を使ってローカルの開発クラスターでアプリケーションのデプロイとデバッグを行う場合、前述のすべての手順は、PowerShell スクリプトによって自動的に処理されます。 このスクリプトは、アプリケーション プロジェクトの Scripts フォルダーにあります。 この記事では、これらのスクリプトが実行する内容の背景を説明し、Visual Studio の外部で同じ操作を実行できるようにします。

アプリケーションをデプロイするもう 1 つの方法は、外部のプロビジョニングを使用する方法です。 アプリケーション パッケージは、sfpkg としてパッケージ化して、外部ストアにアップロードできます。 この場合、イメージ ストアへのアップロードは必要ありません。 デプロイには、次の手順が必要です。

  1. sfpkg を外部ストアにアップロードします。 外部ストアには、REST http または https エンドポイントを公開している任意のストアを指定できます。
  2. 外部のダウンロード URI と、アプリケーションの種類の情報を使用してアプリケーションの種類を登録します。
  3. アプリケーション インスタンスを作成します。

クリーンアップでは、アプリケーション インスタンスを削除して、アプリケーションの種類の登録を解除します。 パッケージはイメージ ストアにコピーされないため、クリーンアップが必要な一時保存先はありません。 外部ストアからのプロビジョニングは、Service Fabric バージョン 6.1 以降で使用できます。

Note

Visual Studio は、外部プロビジョニングを現在サポートしていません。

クラスターに接続する

この記事の PowerShell コマンドを実行する前に、必ず最初に Connect-ServiceFabricCluster で Service Fabric クラスターに接続してください。 ローカル開発クラスターに接続するには、次の手順を実行します。

Connect-ServiceFabricCluster

Microsoft Entra ID、X509 証明書、Windows Active Directory で保護されたクラスターまたはリモート クラスターに接続する例については、「セキュリティ保護されたクラスターに接続する」をご覧ください。

アプリケーション パッケージをアップロードする

アプリケーション パッケージをアップロードすると、そのパッケージは内部 Service Fabric コンポーネントがアクセスできる場所に保存されます。 アプリケーション パッケージをローカルで検証する場合は、Test-ServiceFabricApplicationPackage コマンドレットを使用します。

アプリケーション パッケージは、Copy-ServiceFabricApplicationPackage コマンドでクラスター イメージ ストアにアップロードします。

MyApplication という名前のアプリケーションを Visual Studio 2015 でビルドしてパッケージするとします。 ApplicationManifest.xml に既定で表示されるアプリケーション タイプ名は、"MyApplicationType" です。 アプリケーション パッケージ (必要なアプリケーション マニフェスト、サービス マニフェスト、コード/構成/データ パッケージを含む) は、C:\Users<username>\Documents\Visual Studio 2015\Projects\MyApplication\MyApplication\pkg\Debug にあります。

アプリケーション パッケージの内容を一覧表示するには、次のコマンドを使用します。

$path = 'C:\Users\<user\>\Documents\Visual Studio 2015\Projects\MyApplication\MyApplication\pkg\Debug'
tree /f $path

Folder PATH listing for volume OSDisk
Volume serial number is 0459-2393
C:\USERS\USER\DOCUMENTS\VISUAL STUDIO 2015\PROJECTS\MYAPPLICATION\MYAPPLICATION\PKG\DEBUG
│   ApplicationManifest.xml
│
└───Stateless1Pkg
    │   ServiceManifest.xml
    │
    ├───Code
    │       Microsoft.ServiceFabric.Data.dll
    │       Microsoft.ServiceFabric.Data.Interfaces.dll
    │       Microsoft.ServiceFabric.Internal.dll
    │       Microsoft.ServiceFabric.Internal.Strings.dll
    │       Microsoft.ServiceFabric.Services.dll
    │       ServiceFabricServiceModel.dll
    │       Stateless1.exe
    │       Stateless1.exe.config
    │       Stateless1.pdb
    │       System.Fabric.dll
    │       System.Fabric.Strings.dll
    │
    └───Config
            Settings.xml

アプリケーション パッケージが大きい場合や含まれるファイルの数が多い場合は、アプリケーション パッケージを圧縮できます。 圧縮により、ファイルのサイズを小さくし、ファイル数を減らすことができます。 これにより、アプリケーションの種類の登録と登録解除を高速に実行できます。 現時点で、特にパッケージを圧縮する時間を含めると、アップロード操作が遅くなることがあります。

パッケージを圧縮するには、同じ Copy-ServiceFabricApplicationPackage コマンドを使用します。 圧縮は、SkipCopy フラグを使用することによってアップロードとは別に実行することも、アップロード操作と一緒に実行することもできます。 圧縮済みのパッケージに圧縮を適用した場合、何の操作も行われません。 圧縮されているパッケージの圧縮を解除するには、同じ Copy-ServiceFabricApplicationPackage コマンドを UncompressPackage スイッチと共に使用します。

次のコマンドレットでは、パッケージをイメージ ストアにコピーせずに圧縮しています。 このパッケージには、Code パッケージと Config パッケージの zip 圧縮されたファイルが含まれています。 アプリケーション マニフェストとサービス マニフェストは、多くの内部操作 (パッケージ共有、特定の検証のためのアプリケーションの種類名とバージョンの抽出など) に必要なため、zip 圧縮されません。 マニフェストを zip 圧縮すると、これらの操作が非効率的になります。

Copy-ServiceFabricApplicationPackage -ApplicationPackagePath $path -CompressPackage -SkipCopy
tree /f $path

Folder PATH listing for volume OSDisk
Volume serial number is 0459-2393
C:\USERS\USER\DOCUMENTS\VISUAL STUDIO 2015\PROJECTS\MYAPPLICATION\MYAPPLICATION\PKG\DEBUG
|   ApplicationManifest.xml
|
└───Stateless1Pkg
       Code.zip
       Config.zip
       ServiceManifest.xml

大規模なアプリケーション パッケージでは、圧縮に時間がかかります。 最良の結果を得るには、高速の SSD ドライブを使用してください。 圧縮時間と圧縮後のパッケージ サイズもパッケージの内容によって異なります。 例として、いくつかのパッケージの圧縮に関する統計情報を次に示します。ここには、初期パッケージ サイズ、圧縮後のパッケージ サイズ、および圧縮時間が示されています。

初期サイズ (MB) ファイル数 圧縮時間 圧縮後のパッケージ サイズ (MB)
100 100 00:00:03.3547592 60
512 100 00:00:16.3850303 307
1024 500 00:00:32.5907950 615
2048 1000 00:01:04.3775554 1,231
5012 100 00:02:45.2951288 3,074

圧縮したパッケージは、必要に応じて 1 つまたは複数の Service Fabric クラスターにアップロードできます。 デプロイのメカニズムは、圧縮されているパッケージでも圧縮されていないパッケージでも変わりません。 圧縮したパッケージは、クラスターのイメージ ストアなどに格納されます。 パッケージは、アプリケーションの実行前に、ノードで圧縮解除されます。

以下の例では、先ほどのパッケージをイメージ ストアの "MyApplicationV1" という名前のフォルダーにアップロードしています。

Copy-ServiceFabricApplicationPackage -ApplicationPackagePath $path -ApplicationPackagePathInImageStore MyApplicationV1 -TimeoutSec 1800

-ApplicationPackagePathInImageStore パラメーターを指定しなかった場合は、イメージ ストアの "Debug" フォルダーにアプリケーション パッケージがコピーされます。

Note

Copy-ServiceFabricApplicationPackage は、PowerShell セッションが Service Fabric クラスターに接続されている場合に、適切なイメージ ストア接続文字列を自動的に検出します。 5\.6 より古いバージョンの Service Fabric では、 -ImageStoreConnectionString 引数を明示的に指定する必要があります。

PS C:\> Copy-ServiceFabricApplicationPackage -ApplicationPackagePath $path -ApplicationPackagePathInImageStore MyApplicationV1 -ImageStoreConnectionString (Get-ImageStoreConnectionStringFromClusterManifest(Get-ServiceFabricClusterManifest)) -TimeoutSec 1800

Service Fabric SDK PowerShell モジュールの一部である Get-ImageStoreConnectionStringFromClusterManifest コマンドレットは、イメージ ストアの接続文字列の取得に使用します。 SDK モジュールをインポートするには、次のコマンドを実行します。

Import-Module "$ENV:ProgramFiles\Microsoft SDKs\Service Fabric\Tools\PSModule\ServiceFabricSDK\ServiceFabricSDK.psm1"

イメージ ストアとイメージ ストア接続文字列に関する補足情報は、イメージ ストア接続文字列の理解に関するページを参照してください。

パッケージのアップロードにかかる時間は、さまざまな要素に応じて変わってきます。 これらの要素として、パッケージに含まれるファイルの数、パッケージ サイズ、ファイル サイズなどがあります。 ソース コンピューターと Service Fabric クラスターの間のネットワーク速度もアップロード時間に影響を与えます。 Copy-ServiceFabricApplicationPackage の既定のタイムアウトは 30 分です。 説明した要素に応じて、タイムアウトを長くすることが必要になる場合があります。 コピーの呼び出しでパッケージを圧縮する場合は、圧縮時間も考慮する必要があります。

アプリケーション パッケージを登録する

アプリケーション マニフェストで宣言されたアプリケーションの種類とバージョンは、アプリケーション パッケージを登録すると、利用できるようになります。 システムは、前の手順でアップロードされたパッケージを読み取り、パッケージを検証し、パッケージのコンテンツを処理し、処理済みのパッケージを内部システムの場所にコピーします。

アプリケーションの種類をクラスターに登録し、デプロイできる状態にするには、Register-ServiceFabricApplicationType コマンドレットを実行します。

イメージ ストアにコピーされたアプリケーション パッケージを登録する

パッケージが事前にイメージ ストアにコピーされていた場合は、登録操作でイメージ ストアの相対パスを指定します。

Register-ServiceFabricApplicationType -ApplicationPathInImageStore MyApplicationV1

Register application type succeeded

"MyApplicationV1" は、アプリケーション パッケージが格納されるイメージ ストア内のフォルダーです。 アプリケーション タイプ名 "MyApplicationType"、バージョン "1.0.0" (どちらもアプリケーション マニフェストに記述されます) としてアプリケーションの種類がクラスターに登録されます。

外部ストアにコピーされたアプリケーション パッケージを登録する

Service Fabric バージョン 6.1 以降では、プロビジョニングで外部ストアからのパッケージのダウンロードがサポートされます。 ダウンロード URI は、sfpkg アプリケーション パッケージのパスを表し、ここから HTTP または HTTPS プロトコルを使用してアプリケーション パッケージをダウンロードできます。 パッケージは、この外部の場所に事前にアップロードしておく必要があります。 この URI では、Service Fabric がファイルをダウンロードできるように、読み取りアクセスを許可する必要があります。 sfpkg ファイルには拡張子 ".sfpkg" が必要です。 プロビジョニング操作には、アプリケーション マニフェストにあるのと同じアプリケーションの種類の情報を含める必要があります。

Register-ServiceFabricApplicationType -ApplicationPackageDownloadUri "https://sftestresources.blob.core.windows.net:443/sfpkgholder/MyAppPackage.sfpkg" -ApplicationTypeName MyApp -ApplicationTypeVersion V1 -Async

Register-ServiceFabricApplicationType コマンドは、アプリケーション パッケージがシステムによって正常に登録された場合にのみ戻ります。 登録の所要時間は、アプリケーション パッケージのサイズと内容によって異なります。 必要に応じて、 -TimeoutSec パラメーターを使用して、より長いタイムアウトを指定できます (既定のタイムアウトは 60 秒)。

アプリケーション パッケージが大規模な場合やタイムアウトが発生する場合は、 -Async パラメーターを使用します。 このコマンドを実行すると、クラスターが登録コマンドを受け入れたときに制御が返されます。 登録操作は必要に応じて続行されます。 Get-ServiceFabricApplicationType コマンドは、アプリケーションの種類の全バージョンとその登録状態を一覧表示します。 このコマンドを使用して、登録がいつ完了したかを判断できます。

Get-ServiceFabricApplicationType

ApplicationTypeName    : MyApplicationType
ApplicationTypeVersion : 1.0.0
Status                 : Available
DefaultParameters      : { "Stateless1_InstanceCount" = "-1" }

イメージ ストアからのアプリケーション パッケージの削除

イメージ ストアにパッケージがコピーされていた場合は、アプリケーションが正常に登録された後、一時保存先から削除する必要があります。 イメージ ストアからアプリケーション パッケージを削除すると、システム リソースが解放されます。 使用されていないアプリケーション パッケージを保持すると、ディスク ストレージが消費され、アプリケーションのパフォーマンスの問題につながります。

Remove-ServiceFabricApplicationPackage -ApplicationPackagePathInImageStore MyApplicationV1

アプリケーションを作成する

New-ServiceFabricApplication コマンドレットでは、正常に登録されているアプリケーションの種類のバージョンを指定して、アプリケーションをインスタンス化することができます。 各アプリケーションの名前は、 "fabric:" スキームで開始され、各アプリケーション インスタンスに対して一意でなければなりません。 ターゲット アプリケーションの種類のアプリケーション マニフェストに定義されている既定のサービスも作成されます。

New-ServiceFabricApplication fabric:/MyApp MyApplicationType 1.0.0

ApplicationName        : fabric:/MyApp
ApplicationTypeName    : MyApplicationType
ApplicationTypeVersion : 1.0.0
ApplicationParameters  : {}

登録されたアプリケーションの種類の任意のバージョンに対して、複数のアプリケーション インスタンスを作成できます。 各アプリケーション インスタンスは分離して実行され、独自の作業ディレクトリとプロセスを使用します。

クラスターで実行されている名前付きのアプリとサービスを確認するには、それぞれ Get-ServiceFabricApplication コマンドレットと Get-ServiceFabricService コマンドレットを実行します。

Get-ServiceFabricApplication  

ApplicationName        : fabric:/MyApp
ApplicationTypeName    : MyApplicationType
ApplicationTypeVersion : 1.0.0
ApplicationStatus      : Ready
HealthState            : Ok
ApplicationParameters  : {}

Get-ServiceFabricApplication | Get-ServiceFabricService

ServiceName            : fabric:/MyApp/Stateless1
ServiceKind            : Stateless
ServiceTypeName        : Stateless1Type
IsServiceGroup         : False
ServiceManifestVersion : 1.0.0
ServiceStatus          : Active
HealthState            : Ok

アプリケーションの削除

アプリケーション インスタンスが不要になったときは、Remove-ServiceFabricApplication コマンドレットの引数に名前を指定して実行すれば完全に削除できます。 Remove-ServiceFabricApplication を実行すると、アプリケーションに属するサービスもすべて自動的に削除されます。その結果、すべてのサービスの状態が完全に削除されます。

警告

この操作は元に戻せません。また、アプリケーションの状態を復元できません。

Remove-ServiceFabricApplication fabric:/MyApp

Confirm
Continue with this operation?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"):
Remove application instance succeeded

Get-ServiceFabricApplication

アプリケーションの種類の登録解除

特定のバージョンのアプリケーションの種類が不要になった場合は、Unregister-ServiceFabricApplicationType コマンドレットを使用してアプリケーションの種類の登録を解除する必要があります。 使用していないアプリケーションの種類について、その登録を解除すると、アプリケーションの種類ファイルを削除することで、イメージ ストアによって使用されているストレージ領域が解放されます。 イメージ ストアにコピーされたバージョンが使用された場合、アプリケーションの種類の登録を解除しても、イメージ ストアの一時保存先にコピーされたアプリケーション パッケージは削除されません。 あるアプリケーションの種類に対してインスタンス化されたアプリケーションがなく、それを参照している保留中のアプリケーションのアップグレードもない場合に、そのアプリケーションの種類の登録を解除できます。

現在クラスターに登録されているアプリケーションの種類を確認するには、Get-ServiceFabricApplicationType を実行します。

Get-ServiceFabricApplicationType

ApplicationTypeName    : MyApplicationType
ApplicationTypeVersion : 1.0.0
Status                 : Available
DefaultParameters      : { "Stateless1_InstanceCount" = "-1" }

アプリケーションの種類を指定して登録を解除するには、Unregister-ServiceFabricApplicationType を実行します。

Unregister-ServiceFabricApplicationType MyApplicationType 1.0.0

トラブルシューティング

Copy-ServiceFabricApplicationPackage がImageStoreConnectionString を求める

Service Fabric SDK 環境には、適切な既定値を事前に設定しておく必要があります。 ただし、すべてのコマンドの ImageStoreConnectionString が、Service Fabric クラスターによって使用されている値に一致していなければならない場合もあります。 この ImageStoreConnectionString は Get-ServiceFabricClusterManifest コマンドと Get-ImageStoreConnectionStringFromClusterManifest コマンドを使用して取得したクラスター マニフェストで見つけることができます。

Get-ImageStoreConnectionStringFromClusterManifest(Get-ServiceFabricClusterManifest)

Service Fabric SDK PowerShell モジュールの一部である Get-ImageStoreConnectionStringFromClusterManifest コマンドレットは、イメージ ストアの接続文字列の取得に使用します。 SDK モジュールをインポートするには、次のコマンドを実行します。

Import-Module "$ENV:ProgramFiles\Microsoft SDKs\Service Fabric\Tools\PSModule\ServiceFabricSDK\ServiceFabricSDK.psm1"

ImageStoreConnectionString は、クラスター マニフェスト内にあります。

<ClusterManifest xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" Name="Server-Default-SingleNode" Version="1.0" xmlns="http://schemas.microsoft.com/2011/01/fabric">

    [...]

    <Section Name="Management">
      <Parameter Name="ImageStoreConnectionString" Value="file:D:\ServiceFabric\Data\ImageStore" />
    </Section>

    [...]

イメージ ストアとイメージ ストア接続文字列に関する補足情報は、イメージ ストア接続文字列の理解に関するページを参照してください。

大規模なアプリケーション パッケージをデプロイする

問題点:(GB 単位の) 大規模なアプリケーション パッケージで Copy-ServiceFabricApplicationPackage がタイムアウトになる。 次の操作を試してください。

  • TimeoutSec パラメーターを使用して、Copy-ServiceFabricApplicationPackage コマンドのタイムアウト値を大きくします。 既定では、タイムアウトは 30 分です。
  • ソース コンピューターとクラスターの間のネットワーク接続を確認します。 接続が低速な場合は、ネットワーク接続が高速なコンピューターを使用することを検討してください。 クライアント コンピューターがクラスターとは別のリージョンにある場合は、クラスターと同じかより近いリージョンにあるクライアント コンピューターの使用を検討してください。
  • 外部で調整されていないかどうかを確認してください。 たとえば、イメージ ストアが Azure Storage を使用するように構成されている場合、アップロードが調整される可能性があります。

問題点:パッケージのアップロードが正常に完了したが、Register-ServiceFabricApplicationType がタイムアウトになる。次の操作を試してください。

  • イメージ ストアにコピーする前にパッケージを圧縮します。 圧縮によってファイル サイズが小さくなりファイル数が減るため、トラフィックの量と Service Fabric が実行する必要のある処理が減ります。 (圧縮時間を含めた場合は特に) アップロード操作が遅くなる場合がありますが、アプリケーションの種類の登録と登録解除は高速になります。
  • TimeoutSec パラメーターを使用して、Register-ServiceFabricApplicationType コマンドのタイムアウト値を大きくします。
  • Register-ServiceFabricApplicationType に Async スイッチを指定します。 このコマンドは、クラスターがコマンドを受け入れ、アプリケーションの種類の登録が非同期的に続行されると戻ります。 このため、この場合にはより大きなタイムアウト値を指定する必要はありません。 Get-ServiceFabricApplicationType コマンドは、正常に登録されたアプリケーションの種類の全バージョンとその登録状態を一覧表示します。 このコマンドを使用して、登録がいつ完了したかを判断できます。
Get-ServiceFabricApplicationType

ApplicationTypeName    : MyApplicationType
ApplicationTypeVersion : 1.0.0
Status                 : Available
DefaultParameters      : { "Stateless1_InstanceCount" = "-1" }

多数のファイルを含むアプリケーション パッケージをデプロイする

問題点:(数千個の) 多数のファイルを含むアプリケーション パッケージに対する Register-ServiceFabricApplicationType がタイムアウトになる。 次の操作を試してください。

  • イメージ ストアにコピーする前にパッケージを圧縮します。 圧縮により、ファイル数を減らすことができます。
  • TimeoutSec パラメーターを使用して、Register-ServiceFabricApplicationType コマンドのタイムアウト値を大きくします。
  • Register-ServiceFabricApplicationType に Async スイッチを指定します。 このコマンドは、クラスターがコマンドを受け入れ、アプリケーションの種類の登録が非同期的に続行されると戻ります。 このため、この場合にはより大きなタイムアウト値を指定する必要はありません。 Get-ServiceFabricApplicationType コマンドは、正常に登録されたアプリケーションの種類の全バージョンとその登録状態を一覧表示します。 このコマンドを使用して、登録がいつ完了したかを判断できます。
Get-ServiceFabricApplicationType

ApplicationTypeName    : MyApplicationType
ApplicationTypeVersion : 1.0.0
Status                 : Available
DefaultParameters      : { "Stateless1_InstanceCount" = "-1" }

次のステップ

アプリケーションのパッケージ化

Service Fabric アプリケーションのアップグレード

Service Fabric の正常性の概要

Service Fabric サービスの診断とトラブルシューティング

Service Fabric のアプリケーションのモデル化