Docker@1 - Docker v1 タスク

Docker イメージをビルド、タグ付け、プッシュ、または実行するか、Docker コマンドを実行します。 このタスクは、Docker または Azure Container レジストリで使用します。

注意

Docker@2 は、コマンドに引数として渡すことができる入力を削除することでタスクを簡略化するこのタスクの新しいバージョンです。

構文

# Docker v1
# Build, tag, push, or run Docker images, or run a Docker command.
- task: Docker@1
  inputs:
  # Container Registry
    #containerregistrytype: 'Azure Container Registry' # 'Azure Container Registry' | 'Container Registry'. Required when command != logout. Container registry type. Default: Azure Container Registry.
    #dockerRegistryEndpoint: # string. Optional. Use when containerregistrytype = Container Registry && command != logout. Docker registry service connection. 
    #azureSubscriptionEndpoint: # string. Optional. Use when containerregistrytype = Azure Container Registry && command != logout. Azure subscription. 
    #azureContainerRegistry: # string. Optional. Use when containerregistrytype = Azure Container Registry && command != logout. Azure container registry. 
  # Commands
    #addBaseImageData: true # boolean. Add base image metadata to image(s). Default: true.
    command: 'Build an image' # 'Build an image' | 'Tag image' | 'Push an image' | 'Run an image' | 'login' | 'logout'. Required. Command. Default: Build an image.
    #dockerFile: '**/Dockerfile' # string. Required when command = Build an image || command = build. Dockerfile. Default: **/Dockerfile.
    #arguments: # string. Optional. Use when command != login && command != logout. Arguments. 
    #pushMultipleImages: false # boolean. Optional. Use when command = Push an image || command = push. Push multiple images. Default: false.
    #tagMultipleImages: false # boolean. Optional. Use when command = Tag image || command = tag. Tag multiple images. Default: false.
    #imageName: '$(Build.Repository.Name):$(Build.BuildId)' # string. Required when command = Build an image || command = build || command = Run an image || command = run || pushMultipleImages = false || tagMultipleImages = false. Image name. Default: $(Build.Repository.Name):$(Build.BuildId).
    #imageNamesPath: # string. Required when tagMultipleImages = true || pushMultipleImages = true. Image names path. 
    #qualifyImageName: true # boolean. Optional. Use when command = Build an image || command = build || command = Tag image || command = tag || command = Push an image || command = push || command = Run an image || command = run. Qualify image name. Default: true.
    #qualifySourceImageName: false # boolean. Optional. Use when command = Tag image || command = tag. Qualify source image name. Default: false.
    #includeSourceTags: false # boolean. Optional. Use when command = Build an image || command = build || command = Tag image || command = tag  || command = Push an image || command = push. Include source tags. Default: false.
    #includeLatestTag: false # boolean. Optional. Use when command = Build an image || command = build. Include latest tag. Default: false.
    #addDefaultLabels: true # boolean. Optional. Use when addDefaultLabels = false. Add default labels. Default: true.
    #useDefaultContext: true # boolean. Optional. Use when command = Build an image || command = build. Use default build context. Default: true.
    #buildContext: # string. Optional. Use when useDefaultContext = false. Build context. 
    #imageDigestFile: # string. Optional. Use when command = Push an image || command = push. Image digest file. 
    #containerName: # string. Optional. Use when command = Run an image || command = run. Container name. 
    #ports: # string. Optional. Use when command = Run an image || command = run. Ports. 
    #volumes: # string. Optional. Use when command = Run an image || command = run. Volumes. 
    #envVars: # string. Optional. Use when command = Run an image || command = run. Environment variables. 
    #workingDirectory: # string. Optional. Use when command = Run an image || command = run. Working directory. 
    #entrypointOverride: # string. Optional. Use when command = Run an image || command = run. Entry point override. 
    #containerCommand: # string. Optional. Use when command = Run an image || command = run. Container command. 
    #runInBackground: true # boolean. Optional. Use when command = Run an image || command = run. Run in background. Default: true.
    restartPolicy: 'no' # 'no' | 'onFailure' | 'always' | 'unlessStopped'. Required when runInBackground = true. Restart policy. Default: no.
    #maxRestartRetries: # string. Optional. Use when runInBackground = true && restartPolicy = onFailure. Maximum restart retries. 
  # Advanced Options
    #dockerHostEndpoint: # string. Optional. Use when command != login && command != logout. Docker host service connection. 
    #enforceDockerNamingConvention: true # boolean. Optional. Use when command != login && command != logout. Force image name to follow Docker naming convention. Default: true.
    #memoryLimit: # string. Optional. Use when command != login && command != logout. Memory limit.

入力

containerregistrytype - コンテナー レジストリの種類
string. command != logout の場合に必要です。 使用できる値: Azure Container Registry、Container Registry。 既定値: Azure Container Registry。

Azure サービス接続を使用して接続するAzure Container Registryを指定します。 Docker Hubまたはその他のプライベート コンテナー レジストリに接続するAzure Container Registryを選択します。

addBaseImageData - 基本イメージ メタデータをイメージに追加する
boolean. 既定値: true。

既定値では、追跡可能性に役立つ基本イメージ名やダイジェストなどの基本イメージ データが追加されます。 この既定の動作をオプトアウトするには、この値を に設定します false。

dockerRegistryEndpoint - Docker レジストリ サービス接続
string. 省略可能。 の場合は containerregistrytype = Container Registry && command != logoutを使用します。

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

azureSubscriptionEndpoint - Azure サブスクリプション
string. 省略可能。 の場合は containerregistrytype = Azure Container Registry && command != logoutを使用します。

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

azureContainerRegistry - Azure コンテナー レジストリ
string. 省略可能。 の場合は containerregistrytype = Azure Container Registry && command != logoutを使用します。

選択した Azure サブスクリプションのAzure Container Registryを指定します。 コンテナー イメージがビルドされ、このコンテナー レジストリにプッシュされます。

command - コマンド
string. 必須です。 使用できる値: Build an image (ビルド)、 Tag image (タグ)、 Push an image (プッシュ)、 Run an image (実行)、 login、 logout。 既定値: Build an image。

実行する docker コマンドを指定します。

dockerFile - Dockerfile
string. command = Build an image || command = build の場合に必要です。 既定値: **/Dockerfile。

Docker ファイルへのパスを指定します。 タスクは、見つかった最初の Docker ファイルを使用してイメージをビルドします。

arguments - 引数
string. 省略可能。 の場合は command != login && command != logoutを使用します。

Docker クライアントに渡す追加の引数を指定します。 コマンド パラメーターで 値 buildAndPush を使用すると、arguments プロパティは無視されます。

pushMultipleImages - 複数の画像をプッシュする
boolean. 省略可能。 の場合は command = Push an image || command = pushを使用します。 既定値: false。

プッシュする Docker イメージのテキスト ファイル内のリストを指定します。 各イメージ名を別の行の形式 Imagename1:tag1 で一覧表示します。 たとえば Imagename2、タグのないイメージ名を一覧表示すると、コンテナー内のすべてのタグが Imagename2 プッシュされます。

tagMultipleImages - 複数の画像にタグを付けます
boolean. 省略可能。 の場合は command = Tag image || command = tagを使用します。 既定値: false。

テキスト ファイルでタグ付けする複数のイメージ タグと Docker イメージの一覧を指定します。 各イメージ名を別の行の形式 Imagename1:tag1 で一覧表示します。 タグ Imagename2 なしで表示される画像は、既定で 最新 のタグとしてタグ付けされます。

imageName - イメージ名
string. command = Build an image || command = build || command = Run an image || command = run || pushMultipleImages = false || tagMultipleImages = false の場合に必要です。 既定値: $(Build.Repository.Name):$(Build.BuildId)。

ビルド、プッシュ、または実行する Docker イメージの名前を指定します。

imageNamesPath - イメージ名のパス
string. tagMultipleImages = true || pushMultipleImages = true の場合に必要です。

タグ付けまたはプッシュする Docker イメージの名前を含むテキスト ファイルへのパスを指定します。 各イメージ名を個別の行に一覧表示します。

qualifyImageName - イメージ名を修飾する
boolean. 省略可能。 の場合は command = Build an image || command = build || command = Tag image || command = tag || command = Push an image || command = push || command = Run an image || command = runを使用します。 既定値: true。

Docker レジストリ サービス接続のホスト名を持つ修飾イメージ名を指定します。

qualifySourceImageName - ソース イメージ名を修飾する
boolean. 省略可能。 の場合は command = Tag image || command = tagを使用します。 既定値: false。

Docker レジストリ サービス接続のホスト名を持つ修飾イメージ名を指定します。

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

Docker イメージをビルドまたはプッシュするときに含める Git タグを指定します。

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

Docker イメージをビルドするときに 最新 のタグを使用するかどうかを指定します。

addDefaultLabels - 既定のラベルを追加する
boolean. 省略可能。 の場合は addDefaultLabels = falseを使用します。 既定値: true。

リポジトリ、コミット、ビルド、リリース情報などの Docker ラベルを使用して、CI/CD メタデータをコンテナー イメージに追加するかどうかを指定します。

useDefaultContext - 既定のビルド コンテキストを使用する
boolean. 省略可能。 の場合は command = Build an image || command = buildを使用します。 既定値: true。

Docker ファイルを含むディレクトリへのビルド コンテキストの追加または削除を指定します。

buildContext - ビルド コンテキスト
string. 省略可能。 の場合は useDefaultContext = falseを使用します。

ビルド コンテキストへのパスを指定します。

imageDigestFile - イメージ ダイジェスト ファイル
string. 省略可能。 の場合は command = Push an image || command = pushを使用します。

プッシュされた Docker イメージの完全なイメージ リポジトリ ダイジェストが作成され、設定されるファイルへのパスを指定します。

containerName - コンテナー名
string. 省略可能。 の場合は command = Run an image || command = runを使用します。

実行する Docker コンテナーの名前を指定します。

ports - ポート
string. 省略可能。 の場合は command = Run an image || command = runを使用します。

ホストに発行する Docker コンテナー内のポートを指定します。 各 host-port:container-port バインドを個別の行に一覧表示します。

volumes - ボリューム
string. 省略可能。 の場合は command = Run an image || command = runを使用します。

ホストからマウントするボリュームを指定します。 それぞれ host-dir:container-dir を個別の行に一覧表示します。

envVars - 環境変数
string. 省略可能。 の場合は command = Run an image || command = runを使用します。

Docker コンテナーの環境変数を指定します。 各 name=value ペアを個別の行に一覧表示します。

workingDirectory - 作業ディレクトリ
string. 省略可能。 の場合は command = Run an image || command = runを使用します。

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

entrypointOverride - エントリ ポイントのオーバーライド
string. 省略可能。 の場合は command = Run an image || command = runを使用します。

Docker コンテナーの既定のエントリ ポイントをオーバーライドするかどうかを指定します。

containerCommand - Container コマンド
string. 省略可能。 の場合は command = Run an image || command = runを使用します。

Docker run コマンドを指定します。 docker run コマンドは、最初に、指定したイメージに書き込み可能なコンテナー レイヤーを作成し、指定した run コマンドを使用して開始します。 たとえば、イメージに単純な Python Flask Web アプリケーションが含まれている場合は、Web アプリケーションを起動するように指定 python app.py できます。

runInBackground - バックグラウンドで実行する
boolean. 省略可能。 の場合は command = Run an image || command = runを使用します。 既定値: true。

Docker コンテナーをバックグラウンドで実行するかどうかを指定します。

restartPolicy - 再起動ポリシー
string. runInBackground = true の場合に必要です。 使用できる値: no、 onFailure (失敗した場合) always、、( unlessStopped 停止しない限り)。 既定値: no。

再起動ポリシーを実行するタイミングを指定します。

maxRestartRetries - 再起動の最大再試行回数
string. 省略可能。 の場合は runInBackground = true && restartPolicy = onFailureを使用します。

Docker デーモンが再試行する再起動の最大数を指定します。

dockerHostEndpoint - Docker ホスト サービス接続
string. 省略可能。 の場合は command != login && command != logoutを使用します。

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

enforceDockerNamingConvention - Docker の名前付け規則に従うようにイメージ名を強制する
boolean. 省略可能。 の場合は command != login && command != logoutを使用します。 既定値: true。

既定値は、Docker の名前付け規則に従って Docker イメージ名を変更します。 たとえば、大文字を小文字に変換し、スペースを削除します。

memoryLimit - メモリ制限
string. 省略可能。 の場合は command != login && command != logoutを使用します。

コンテナーで使用できる最大メモリ量を、省略可能なサフィックスを持つ整数として指定します (例: 2GB)。

タスク制御オプション

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

出力変数

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

DockerOutput
docker コマンドの出力を格納します

DockerOutputPath
ビルド コマンドの出力を含むファイルのパス。

注釈

Docker@2 は、コマンドに引数として渡すことができる入力を削除することでタスクを簡略化するこのタスクの新しいバージョンです。

要件

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

こちらもご覧ください

• Docker@2