DockerCompose@0 - Docker Compose v0 タスク

複数コンテナー Docker アプリケーションをビルド、プッシュ、実行します。 このタスクは、Docker または Azure Container レジストリで使用します。

構文

# Docker Compose v0
# Build, push or run multi-container Docker applications. Task can be used with Docker or Azure Container registry.
- task: DockerCompose@0
  inputs:
    containerregistrytype: 'Azure Container Registry' # 'Azure Container Registry' | 'Container Registry'. Required. Container Registry Type. Default: Azure Container Registry.
    #dockerRegistryEndpoint: # string. Optional. Use when containerregistrytype = Container Registry. Docker Registry Service Connection. 
    #azureSubscription: # string. Alias: azureSubscriptionEndpoint. Optional. Use when containerregistrytype = Azure Container Registry. Azure subscription. 
    #azureContainerRegistry: # string. Optional. Use when containerregistrytype = Azure Container Registry. Azure Container Registry. 
    dockerComposeFile: '**/docker-compose.yml' # string. Required. Docker Compose File. Default: **/docker-compose.yml.
    #additionalDockerComposeFiles: # string. Additional Docker Compose Files. 
    #dockerComposeFileArgs: # string. Environment Variables. 
    #projectName: '$(Build.Repository.Name)' # string. Project Name. Default: $(Build.Repository.Name).
    #qualifyImageNames: true # boolean. Qualify Image Names. Default: true.
    action: 'Run a Docker Compose command' # 'Build services' | 'Push services' | 'Run services' | 'Run a specific service' | 'Lock services' | 'Write service image digests' | 'Combine configuration' | 'Run a Docker Compose command'. Required. Action. Default: Run a Docker Compose command.
    #additionalImageTags: # string. Optional. Use when action = Build services || action = Push services. Additional Image Tags. 
    #includeSourceTags: false # boolean. Optional. Use when action = Build services || action = Push services. Include Source Tags. Default: false.
    #includeLatestTag: false # boolean. Optional. Use when action = Build services || action = Push services. Include Latest Tag. Default: false.
    #buildImages: true # boolean. Optional. Use when action = Run services. Build Images. Default: true.
    #serviceName: # string. Required when action = Run a specific service. Service Name. 
    #containerName: # string. Optional. Use when action = Run a specific service. Container Name. 
    #ports: # string. Optional. Use when action = Run a specific service. Ports. 
    #workingDirectory: # string. Alias: workDir. Optional. Use when action = Run a specific service. Working Directory. 
    #entrypoint: # string. Optional. Use when action = Run a specific service. Entry Point Override. 
    #containerCommand: # string. Optional. Use when action = Run a specific service. Command. 
    #detached: true # boolean. Optional. Use when action = Run services || action = Run a specific service. Run in Background. Default: true.
    #abortOnContainerExit: true # boolean. Optional. Use when action = Run services && detached == false. Abort on Container Exit. Default: true.
    #imageDigestComposeFile: '$(Build.StagingDirectory)/docker-compose.images.yml' # string. Required when action = Write service image digests. Image Digest Compose File. Default: $(Build.StagingDirectory)/docker-compose.images.yml.
    #removeBuildOptions: false # boolean. Optional. Use when action = Lock services || action = Combine configuration. Remove Build Options. Default: false.
    #baseResolveDirectory: # string. Optional. Use when action = Lock services || action = Combine configuration. Base Resolve Directory. 
    #outputDockerComposeFile: '$(Build.StagingDirectory)/docker-compose.yml' # string. Required when action = Lock services || action = Combine configuration. Output Docker Compose File. Default: $(Build.StagingDirectory)/docker-compose.yml.
    #dockerComposeCommand: # string. Required when action = Run a Docker Compose command. Command. 
    #arguments: # string. Optional. Use when action != Lock services && action != Combine configuration && action != Write service image digests. Arguments. 
  # Advanced Options
    #dockerHostEndpoint: # string. Docker Host Service Connection. 
    #nopIfNoDockerComposeFile: false # boolean. No-op if no Docker Compose File. Default: false.
    #requireAdditionalDockerComposeFiles: false # boolean. Require Additional Docker Compose Files. Default: false.
    #currentWorkingDirectory: '$(System.DefaultWorkingDirectory)' # string. Alias: cwd. Working Directory. Default: $(System.DefaultWorkingDirectory).
    #dockerComposePath: # string. Docker Compose executable Path.

入力

containerregistrytype - コンテナー レジストリの種類
string. 必須です。 使用できる値: Azure Container Registry、Container Registry。 既定値: Azure Container Registry。

ACR を使用する場合は、Azure Container Registry型を指定します。 他のコンテナー レジストリを使用する場合は、コンテナー レジストリの種類を指定します。

dockerRegistryEndpoint - Docker Registry Service 接続
string. 省略可能。 の場合は containerregistrytype = Container Registryを使用します。

Docker レジストリ サービス接続を指定します。 レジストリを使用してコマンドを認証する必要がある場合に必要です。

azureSubscription - Azure サブスクリプション
入力エイリアス: azureSubscriptionEndpoint。 string. 省略可能。 の場合は containerregistrytype = Azure Container Registryを使用します。

Azure サブスクリプションを指定します。 Azure サービス接続の名前。 接続を手動で設定するには、「Azure Resource Manager サービス接続」を参照してください。

azureContainerRegistry - Azure Container Registry
string. 省略可能。 の場合は containerregistrytype = Azure Container Registryを使用します。

Azure Container Registryを指定します。

dockerComposeFile - Docker Compose ファイル
string. 必須です。 既定値: **/docker-compose.yml。

プライマリ Docker Compose ファイルへのファイル パスを指定します。

additionalDockerComposeFiles - その他の Docker Compose ファイル
string.

プライマリ Docker Compose ファイルと組み合わせる追加の Docker Compose ファイルを指定します。 相対パスは、プライマリ Docker Compose ファイルを含むディレクトリに対して相対的に解決されます。 指定したファイルが見つからない場合は、無視されます。 各ファイルのパスを新しい行に指定します。

dockerComposeFileArgs - 環境変数
string.

設定される環境変数を指定します。

次のように形式を設定します。

• 各 name=value ペアを新しい行に一覧表示します。
• YAML で 演算子を | 使用して、新しい行を保持します。

projectName - プロジェクト名
string. 既定値: $(Build.Repository.Name)。

既定でイメージとコンテナーに名前を付けるために使用するプロジェクト名を指定します。

qualifyImageNames - イメージ名の修飾
boolean. 既定値: true。

既定では、 は Docker レジストリ サービス接続のホスト名を指定します。

action - アクション
string. 必須です。 使用できる値: Build services (サービス イメージのビルド)、 Push services (プッシュ サービス イメージ)、 Run services (サービス イメージの実行) Run a specific service 、(特定のサービス イメージの実行) Lock services 、(サービス イメージのロック)Write service image digests、、、Combine configuration。 Run a Docker Compose command 既定値: Run a Docker Compose command。

許可される値の一覧から Docker Compose アクションを指定します。

additionalImageTags - その他の画像タグ
string. 省略可能。 の場合は action = Build services || action = Push servicesを使用します。

ビルドまたはプッシュされる Docker イメージの追加タグを指定します。 改行 を使用して、それぞれを区切る複数のタグを \n指定できます。

includeSourceTags - ソース タグを含める
boolean. 省略可能。 の場合は action = Build services || action = Push servicesを使用します。 既定値: false。

Docker イメージのビルドまたはプッシュ時に Git タグを指定します。

includeLatestTag - 最新のタグを含める
boolean. 省略可能。 の場合は action = Build services || action = Push servicesを使用します。 既定値: false。

Docker イメージをビルドまたはプッシュするときの 最新 のタグを指定します。

buildImages - イメージのビルド
boolean. 省略可能。 の場合は action = Run servicesを使用します。 既定値: true。

サービス コンテナーを開始する前にビルド イメージを指定します。

serviceName - サービス名
string. action = Run a specific service の場合に必要です。

実行するサービスの名前を指定します。

containerName - コンテナー名
string. 省略可能。 の場合は action = Run a specific serviceを使用します。

使用するサービス コンテナーの名前を指定します。

ports - ポート
string. 省略可能。 の場合は action = Run a specific serviceを使用します。

ホストに発行するサービス コンテナー内のポートを指定します。 新しい行に各 host-port:container-port バインドを追加します。

workingDirectory - 作業ディレクトリ
入力エイリアス: workDir。 string. 省略可能。 の場合は action = Run a specific serviceを使用します。

サービス コンテナーの作業ディレクトリを指定します。

entrypoint - エントリ ポイントのオーバーライド
string. 省略可能。 の場合は action = Run a specific serviceを使用します。

サービス コンテナーの既定のエントリ ポイントのオーバーライド値を指定します。

containerCommand - コマンド
string. 省略可能。 の場合は action = Run a specific serviceを使用します。

サービス コンテナーで実行するコマンドを指定します。 たとえば、イメージに単純な Python Flask Web アプリケーションが含まれている場合は、Web アプリケーションを起動するように指定 python app.py できます。

detached - バックグラウンドで実行
boolean. 省略可能。 の場合は action = Run services || action = Run a specific serviceを使用します。 既定値: true。

バックグラウンドで実行するサービス コンテナーを指定します。

abortOnContainerExit - コンテナーの終了時に中止する
boolean. 省略可能。 の場合は action = Run services && detached == falseを使用します。 既定値: true。

コンテナーが終了したときに停止するすべてのコンテナーを指定します。

imageDigestComposeFile - イメージ ダイジェスト作成ファイル
string. action = Write service image digests の場合に必要です。 既定値: $(Build.StagingDirectory)/docker-compose.images.yml。

各サービスの Docker イメージの完全なイメージ リポジトリ ダイジェストを作成して設定する Docker Compose ファイルへのパスを指定します。

removeBuildOptions - ビルド オプションの削除
boolean. 省略可能。 の場合は action = Lock services || action = Combine configurationを使用します。 既定値: false。

出力 Docker Compose ファイルからビルド オプションを削除するかどうかを指定します。

baseResolveDirectory - 基本解決ディレクトリ
string. 省略可能。 の場合は action = Lock services || action = Combine configurationを使用します。

出力 Docker Compose ファイル内の相対パスを解決するベース ディレクトリを指定します。

outputDockerComposeFile - Docker Compose ファイルを出力する
string. action = Lock services || action = Combine configuration の場合に必要です。 既定値: $(Build.StagingDirectory)/docker-compose.yml。

出力 Docker Compose ファイルへのパスを指定します。

dockerComposeCommand - コマンド
string. action = Run a Docker Compose command の場合に必要です。

引数を指定して実行する Docker Compose コマンドを指定します。 たとえば、 rm --all 停止したすべてのサービス コンテナーを削除する場合です。

arguments - 引数
string. 省略可能。 の場合は action != Lock services && action != Combine configuration && action != Write service image digestsを使用します。

Docker Compose コマンド オプションを指定します。

例: ビルド コマンドの場合は 。 --pull --compress --parallel

dockerHostEndpoint - Docker ホスト サービス接続
string.

Docker ホスト サービス接続を指定します。 既定値はエージェントのホストです。

nopIfNoDockerComposeFile - Docker Compose ファイルがない場合は操作なし
boolean. 既定値: false。

Docker Compose ファイルが存在しない場合にタスクをスキップする値を指定します。 このオプションは、タスクがリポジトリ内に Docker Compose ファイルが存在することに基づいてオプションの動作を提供する場合に便利です。

requireAdditionalDockerComposeFiles - 追加の Docker Compose ファイルが必要
boolean. 既定値: false。

追加の Docker Compose ファイルが存在しない場合にエラーを生成する値を指定します。 このオプションは、ファイルが存在しない場合に無視される既定の動作をオーバーライドします。

currentWorkingDirectory - 作業ディレクトリ
入力エイリアス: cwd。 string. 既定値: $(System.DefaultWorkingDirectory)。

Docker Compose コマンドの作業ディレクトリを指定します。

dockerComposePath - Docker Compose 実行可能パス
string.

docker-compose 実行可能ファイルが使用されているかどうかを判断するパスを指定します。

タスク制御オプション

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

出力変数

このタスクでは、ダウンストリームのステップ、ジョブ、およびステージで使用できる次の 出力変数を定義します。

DockerComposeOutput
コマンドの出力を含むファイルへのパス。 これには、dockerComposeRun コマンド (実行用とダウン用)、dockerPush (プッシュされたイメージごとに 1 つ)、dockerBuild (ビルド自体とすべてのタグ コマンド)、dockerDigest (プルされるイメージごとに 1 つ) など、複数のファイル パス (改行文字で区切られた) を含めることができます。 他のコマンドでは、1 つのファイルのみが出力されます。

解説

このタスクを使用して、マルチコンテナー Docker アプリケーションを構築、プッシュ、実行します。 このタスクは、Docker レジストリまたはAzure Container Registryで使用します。

例

• Azure Container Registry
• その他のコンテナー レジストリ
• サービス イメージをビルドする
• サービス イメージをプッシュする
• サービス イメージを実行する
• 特定のサービス イメージを実行する
• サービス イメージをロックする
• サービス イメージ ダイジェストを書き込む
• 構成を結合する
• Docker Compose コマンドを実行する

Azure Container Registry

次の YAML の例では Azure Container Registry の入力を指定します。

variables:
  azureContainerRegistry: Contoso.azurecr.io
  azureSubscriptionEndpoint: Contoso
steps:
- task: DockerCompose@0
  displayName: Container registry login
  inputs:
    containerregistrytype: Azure Container Registry
    azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    azureContainerRegistry: $(azureContainerRegistry)

その他のコンテナー レジストリ

ACR 以外のコンテナー レジストリを使用する場合は、containerregistrytype 値が必要です。 この場合は containerregistrytype: Container Registry を使用します。

次の YAML の例では ACR 以外のコンテナー レジストリを指定します。ここで Contoso は、コンテナー レジストリの Docker レジストリ サービス接続の名前です。

- task: DockerCompose@0
  displayName: Container registry login
  inputs:
    containerregistrytype: Container Registry
    dockerRegistryEndpoint: Contoso

サービス イメージをビルドする

次の YAML の例では、イメージ名が Azure Container Registry に関連する入力に基づいて修飾されるイメージをビルドします。

- task: DockerCompose@0
  displayName: Build services
  inputs:
    action: Build services
    azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    azureContainerRegistry: $(azureContainerRegistry)
    dockerComposeFile: docker-compose.yml
    projectName: $(Build.Repository.Name)
    qualifyImageNames: true
    additionalImageTags: $(Build.BuildId)
    dockerComposeFileArgs: |
      firstArg=$(firstArg)
      secondArg=$(secondArg)

サービス イメージをプッシュする

次の YAML の例では、コンテナー レジストリにイメージをプッシュします。

- task: DockerCompose@0
  displayName: Push services
  inputs:
    action: Push services
    azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    azureContainerRegistry: $(azureContainerRegistry)
    dockerComposeFile: docker-compose.yml
    projectName: $(Build.Repository.Name)
    qualifyImageNames: true
    additionalImageTags: $(Build.BuildId)

サービス イメージを実行する

次の YAML の例では、サービスを実行します。

- task: DockerCompose@0
  displayName: Run services
  inputs:
    action: Run services
    azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    azureContainerRegistry: $(azureContainerRegistry)
    dockerComposeFile: docker-compose.ci.build.yml
    projectName: $(Build.Repository.Name)
    qualifyImageNames: true
    buildImages: true
    abortOnContainerExit: true
    detached: true

特定のサービス イメージを実行する

次 YAML の例では、特定のサービスを実行します。

- task: DockerCompose@0
  displayName: Run a specific service
  inputs:
    action: Run a specific service
    azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    azureContainerRegistry: $(azureContainerRegistry)
    dockerComposeFile: docker-compose.yml
    projectName: $(Build.Repository.Name)
    qualifyImageNames: true
    serviceName: myhealth.web
    ports: 80:80
    detached: true

サービス イメージをロックする

次の YAML の例では、サービスをロックします。

- task: DockerCompose@0
  displayName: Lock services
  inputs:
    action: Lock services
    azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    azureContainerRegistry: $(azureContainerRegistry)
    dockerComposeFile: docker-compose.yml
    projectName: $(Build.Repository.Name)
    qualifyImageNames: true
    outputDockerComposeFile: $(Build.StagingDirectory)/docker-compose.yml

サービス イメージ ダイジェストを書き込む

次の YAML の例では、サービス イメージ ダイジェストを書き込みます。

- task: DockerCompose@0
  displayName: Write service image digests
  inputs:
    action: Write service image digests
    azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    azureContainerRegistry: $(azureContainerRegistry)
    dockerComposeFile: docker-compose.yml
    projectName: $(Build.Repository.Name)
    qualifyImageNames: true
    imageDigestComposeFile: $(Build.StagingDirectory)/docker-compose.images.yml 

構成を結合する

次の YAML の例では構成を結合します。

- task: DockerCompose@0
  displayName: Combine configuration
  inputs:
    action: Combine configuration
    azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    azureContainerRegistry: $(azureContainerRegistry)
    dockerComposeFile: docker-compose.yml
    additionalDockerComposeFiles: docker-compose.override.yml
    projectName: $(Build.Repository.Name)
    qualifyImageNames: true
    outputDockerComposeFile: $(Build.StagingDirectory)/docker-compose.yml

Docker Compose コマンドを実行する

次の YAML の例では、Docker Compose コマンドを実行します。

- task: DockerCompose@0
  displayName: Run a Docker Compose command
  inputs:
    action: Run a Docker Compose command
    azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    azureContainerRegistry: $(azureContainerRegistry)
    dockerComposeFile: docker-compose.yml 
    projectName: $(Build.Repository.Name)
    qualifyImageNames: true
    dockerComposeCommand: rm

要件

要件	説明
パイプラインの種類	YAML、クラシック ビルド、クラシック リリース
実行日	エージェント、DeploymentGroup
確認要求	なし
Capabilities	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	Any
設定可能な変数	Any
エージェントのバージョン	サポートされているすべてのエージェント バージョン。
タスクのカテゴリ	Build