ServiceFabricComposeDeploy@0 - Service Fabric Compose deploy v0 タスク

このタスクを使用して、Docker Compose アプリケーションを Service Fabric クラスターにデプロイします。 このタスクでは、Compose ファイルで定義されている設定に従って、Azure Service Fabric アプリケーションをクラスターにデプロイします。

注意

このタスクでは、ワークフロー ID フェデレーションを使用した Azure Resource Manager認証はサポートされていません。

構文

# Service Fabric Compose deploy v0
# Deploy a Docker Compose application to an Azure Service Fabric cluster.
- task: ServiceFabricComposeDeploy@0
  inputs:
    clusterConnection: # string. Alias: serviceConnectionName. Required. Cluster Service Connection. 
    composeFilePath: '**/docker-compose.yml' # string. Required. Compose File Path. Default: **/docker-compose.yml.
    applicationName: 'fabric:/Application1' # string. Required. Application Name. Default: fabric:/Application1.
  # Registry Settings
    registryCredentials: 'AzureResourceManagerEndpoint' # 'AzureResourceManagerEndpoint' | 'ContainerRegistryEndpoint' | 'UsernamePassword' | 'None'. Required. Registry Credentials Source. Default: AzureResourceManagerEndpoint.
    #dockerRegistryConnection: # string. Alias: dockerRegistryEndpointName. Optional. Use when registryCredentials = ContainerRegistryEndpoint. Docker Registry Service Connection. 
    azureSubscription: # string. Alias: azureSubscriptionEndpoint. Required when registryCredentials = AzureResourceManagerEndpoint. Azure subscription. 
    #registryUserName: # string. Optional. Use when registryCredentials = UsernamePassword. Registry User Name. 
    #registryPassword: # string. Optional. Use when registryCredentials = UsernamePassword. Registry Password. 
    #passwordEncrypted: true # boolean. Optional. Use when registryCredentials = UsernamePassword. Password Encrypted. Default: true.
  # Advanced Settings
    #upgrade: false # boolean. Upgrade. Default: false.
    #deployTimeoutSec: # string. Deploy Timeout (s). 
    #removeTimeoutSec: # string. Remove Timeout (s). 
    #getStatusTimeoutSec: # string. Get Status Timeout (s).
# Service Fabric Compose Deploy v0
# Deploy a docker-compose application to a Service Fabric cluster.
- task: ServiceFabricComposeDeploy@0
  inputs:
    clusterConnection: # string. Alias: serviceConnectionName. Required. Cluster Service Connection. 
    composeFilePath: '**/docker-compose.yml' # string. Required. Compose File Path. Default: **/docker-compose.yml.
    applicationName: 'fabric:/Application1' # string. Required. Application Name. Default: fabric:/Application1.
  # Registry Settings
    registryCredentials: 'AzureResourceManagerEndpoint' # 'AzureResourceManagerEndpoint' | 'ContainerRegistryEndpoint' | 'UsernamePassword' | 'None'. Required. Registry Credentials Source. Default: AzureResourceManagerEndpoint.
    #dockerRegistryConnection: # string. Alias: dockerRegistryEndpointName. Optional. Use when registryCredentials = ContainerRegistryEndpoint. Docker Registry Service Connection. 
    azureSubscription: # string. Alias: azureSubscriptionEndpoint. Required when registryCredentials = AzureResourceManagerEndpoint. Azure subscription. 
    #registryUserName: # string. Optional. Use when registryCredentials = UsernamePassword. Registry User Name. 
    #registryPassword: # string. Optional. Use when registryCredentials = UsernamePassword. Registry Password. 
    #passwordEncrypted: true # boolean. Optional. Use when registryCredentials = UsernamePassword. Password Encrypted. Default: true.
  # Advanced Settings
    #upgrade: false # boolean. Upgrade. Default: false.
    #deployTimeoutSec: # string. Deploy Timeout (s). 
    #removeTimeoutSec: # string. Remove Timeout (s). 
    #getStatusTimeoutSec: # string. Get Status Timeout (s).

入力

clusterConnection - クラスター サービス接続
入力エイリアス: serviceConnectionNamestring. 必須です。

クラスターへの接続に使用する Azure Service Fabric サービス接続を指定します。 新しいサービス接続を登録することを選択 Manage します。


composeFilePath - ファイル パスの作成
string. 必須です。 既定値: **/docker-compose.yml

展開する作成ファイルへのパスを指定します。 パス では、変数とワイルドカードを使用できます。 例: $(System.DefaultWorkingDirectory)/**/drop/projectartifacts/**/docker-compose.yml.

Note

作成ファイルの組み合わせは、このタスクの一部としてサポートされていません。


applicationName - アプリケーション名
string. 必須です。 既定値: fabric:/Application1

デプロイされたアプリケーションの Service Fabric アプリケーション名を指定します。 プレフィックスとして fabric:/ を使います。 Service Fabric クラスター内のアプリケーション名は一意である必要があります。


registryCredentials - レジストリ資格情報ソース
string. 必須です。 使用できる値: AzureResourceManagerEndpoint (Azure Resource Manager サービス接続)、 ContainerRegistryEndpoint (Container Registry サービス接続) UsernamePassword 、(ユーザー名とパスワード)、None。 既定値: AzureResourceManagerEndpoint

Docker コンテナー レジストリの資格情報をデプロイ タスクに提供する方法を指定します。 使用できる値は、次のとおりです。

  • AzureResourceManagerEndpoint(Azure Resource Manager サービス接続): を使用azureSubscriptionして、Azure Container Registryのサービス プリンシパル ID とキーを取得します。
  • ContainerRegistryEndpoint (コンテナー レジストリ サービス接続): を使用 dockerRegistryConnection して Docker レジストリ サービス接続を選択します。 クラスター サービス接続のサーバー証明書拇印に一致する証明書がビルド エージェントにインストールされている場合は、パスワードの暗号化に使用されます。それ以外の場合、パスワードは暗号化されません。
  • UsernamePassword(ユーザー名とパスワード): と を使用registryUsernameregistryPasswordして、Docker レジストリのユーザー名とパスワードを格納します。 オプションを指定して Invoke-ServiceFabricEncryptText を 使用してパスワードを暗号化する Password Encrypted 必要があります。 でパスワードが暗号化 Invoke-ServiceFabricEncryptTextされておらず、クラスター接続のサーバー証明書拇印に一致する証明書がビルド エージェントにインストールされている場合、証明書はパスワードの暗号化に使用されます。 それ以外の場合、パスワードは暗号化されず、クリア テキストで送信されます。
  • None: レジストリ資格情報は提供されません。 これは、パブリック コンテナー レジストリにアクセスするために使用されます。

dockerRegistryConnection - Docker レジストリ サービス接続
入力エイリアス: dockerRegistryEndpointNamestring. 省略可能。 の場合は registryCredentials = ContainerRegistryEndpointを使用します。

Docker レジストリ サービス接続を指定します。 クラスター サービス接続のサーバー証明書拇印に一致する証明書がビルド エージェントにインストールされている場合は、パスワードの暗号化に使用されます。それ以外の場合、パスワードは暗号化されません。


azureSubscription - Azure サブスクリプション
入力エイリアス: azureSubscriptionEndpointstring. registryCredentials = AzureResourceManagerEndpoint の場合に必要です。

Azure サブスクリプションを指定します。


registryUserName - レジストリ ユーザー名
string. 省略可能。 の場合は registryCredentials = UsernamePasswordを使用します。

Docker レジストリのユーザー名を指定します。


registryPassword - レジストリ パスワード
string. 省略可能。 の場合は registryCredentials = UsernamePasswordを使用します。

Docker レジストリのパスワードを指定します。 パスワードが暗号化されていない場合は、カスタム リリース パイプライン シークレット変数を使用してパスワードを格納することをお勧めします。


passwordEncrypted - Password Encrypted
boolean. 省略可能。 の場合は registryCredentials = UsernamePasswordを使用します。 既定値: true

Invoke-ServiceFabricEncryptText を使用してパスワードを暗号化します。 パスワードを暗号化せず、クラスター サービス接続のサーバー証明書拇印に一致する証明書がビルド エージェントにインストールされている場合は、パスワードの暗号化に使用されます。それ以外の場合は、エラーが発生します。


upgrade - アップグレード
boolean. 既定値: false

既存のデプロイを削除するのではなく、アップグレードします。


deployTimeoutSec - Deploy Timeout (s)
string.

アプリケーションをデプロイするためのタイムアウトを秒単位で指定します。


removeTimeoutSec - タイムアウトの削除
string.

既存のアプリケーションを削除するためのタイムアウトを秒単位で指定します。


getStatusTimeoutSec - Get Status Timeout (s)
string.

既存のアプリケーションの状態を取得するためのタイムアウトを秒単位で指定します。


タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。

出力変数

[なし] :

解説

このタスクは、Service Fabric クラスターに Docker-compose アプリケーションをデプロイするために使います。 このタスクでは、Compose ファイルで定義されている設定に従って、Azure Service Fabric アプリケーションをクラスターにデプロイします。

注意

このタスクは現在プレビュー段階であり、Compose デプロイをサポートする Service Fabric のプレビュー バージョンが必要です。 「Azure Service Fabric での Docker Compose のデプロイのサポート」をご覧ください。

Service Fabric

  • このタスクでは、Service Fabric インストールを使用し、Service Fabric クラスターに接続してデプロイします。
  • Azure Service Fabric Core SDK をダウンロードしてビルド エージェントにインストールします。

要件

要件 説明
パイプラインの種類 YAML、クラシック ビルド、クラシック リリース
実行日 エージェント、DeploymentGroup
確認要求 セルフホステッド エージェントには、このタスクを使用するジョブを実行するための次の要求に一致する機能が必要です。 Cmd
Capabilities このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限 Any
設定可能な変数 Any
エージェントのバージョン 1.95.0 以上
タスクのカテゴリ 配置