Docker@0 - Docker v0 タスク

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

注意

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

構文

# Docker v0
# Build, tag, push, or run Docker images, or run a Docker command.
- task: Docker@0
  inputs:
    containerregistrytype: 'Azure Container Registry' # 'Azure Container Registry' | 'Container Registry'. Required. Container Registry Type. Default: Azure Container Registry.
    #dockerRegistryConnection: # string. Alias: dockerRegistryEndpoint. 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. 
    action: 'Build an image' # 'Build an image' | 'Tag images' | 'Push an image' | 'Push images' | 'Run an image' | 'Run a Docker command'. Required. Action. Default: Build an image.
    #dockerFile: '**/Dockerfile' # string. Required when action = Build an image. Docker File. Default: **/Dockerfile.
    #buildArguments: # string. Optional. Use when action = Build an image. Build Arguments. 
    #defaultContext: true # boolean. Optional. Use when action = Build an image. Use Default Build Context. Default: true.
    #context: # string. Optional. Use when action = Build an image && defaultContext = false. Build Context. 
    #imageName: '$(Build.Repository.Name):$(Build.BuildId)' # string. Required when action == Build an image || action == Push an image || action == Run an image. Image Name. Default: $(Build.Repository.Name):$(Build.BuildId).
    #imageNamesPath: # string. Required when action == Tag images || action == Push images. Image Names Path. 
    #qualifyImageName: true # boolean. Optional. Use when action = Build an image || action = Tag images || action = Push an image || action = Push images || action = Run an image. Qualify Image Name. Default: true.
    #additionalImageTags: # string. Optional. Use when action = Build an image || action = Tag images || action = Push an image || action = Push images. Additional Image Tags. 
    #includeSourceTags: false # boolean. Optional. Use when action = Build an image || action = Tag image || action = Push an image || action = Push images. Include Source Tags. Default: false.
    #includeLatestTag: false # boolean. Optional. Use when action = Build an image || action = Push an image || action = Push images. Include Latest Tag. Default: false.
    #imageDigestFile: # string. Optional. Use when action = Push an image || action = Push images. Image Digest File. 
    #containerName: # string. Optional. Use when action = Run an image. Container Name. 
    #ports: # string. Optional. Use when action = Run an image. Ports. 
    #volumes: # string. Optional. Use when action = Run an image. Volumes. 
    #envVars: # string. Optional. Use when action = Run an image. Environment Variables. 
    #workDir: # string. Optional. Use when action = Run an image. Working Directory. 
    #entrypoint: # string. Optional. Use when action = Run an image. Entry Point Override. 
    #containerCommand: # string. Optional. Use when action = Run an image. Command. 
    #detached: true # boolean. Optional. Use when action = Run an image. Run In Background. Default: true.
    #restartPolicy: 'no' # 'no' | 'onFailure' | 'always' | 'unlessStopped'. Required when action = Run an image && detached = true. Restart Policy. Default: no.
    #restartMaxRetries: # string. Optional. Use when action = Run an image && detached = true && restartPolicy = onFailure. Maximum Restart Retries. 
    #customCommand: # string. Required when action = Run a Docker command. Command. 
  # commands
    #addBaseImageData: true # boolean. Add base image metadata to image(s). Default: true.
  # Advanced Options
    #dockerHostEndpoint: # string. Docker Host Service Connection. 
    #enforceDockerNamingConvention: true # boolean. Force image name to follow Docker naming convention. Default: true.
    #workingDirectory: '$(System.DefaultWorkingDirectory)' # string. Alias: cwd. Working Directory. Default: $(System.DefaultWorkingDirectory).
    #memory: # string. Memory limit.

入力

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

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

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

Docker レジストリ サービス接続を指定します。 レジストリで認証する必要があるコマンドでは必須です。

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

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

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

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

action - アクション
string. 必須です。 使用できる値: Build an image、Tag images、、Push an image、Push images、Run an image。 Run a Docker command 既定値: Build an image。

Docker アクションを指定します。

dockerFile - Docker ファイル
string. action = Build an image の場合に必要です。 既定値: **/Dockerfile。

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

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

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

buildArguments - ビルド引数
string. 省略可能。 の場合は action = Build an imageを使用します。

Docker ファイルのビルド時変数を指定します。 各 name=value ペアを新しい行に書式設定します。

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

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

context - ビルド コンテキスト
string. 省略可能。 の場合は action = Build an image && defaultContext = falseを使用します。

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

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

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

imageNamesPath - イメージ名のパス
string. action == Tag images || action == Push images の場合に必要です。

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

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

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

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

ビルドまたはプッシュされる Docker イメージの追加タグを指定します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

再起動ポリシーを指定します。

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

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

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

実行する Docker コマンドと引数を指定します。 たとえば、 は rmi -f image-name イメージを削除します。

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

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

enforceDockerNamingConvention - Docker の名前付け規則に従うようにイメージ名を強制する
boolean. 既定値: true。

有効になっている場合は、Docker の名前付け規則に従って Docker イメージ名を変更します。 たとえば、大文字を小文字に変換し、スペースを削除します。

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

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

memory - メモリ制限
string.

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

タスク制御オプション

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

出力変数

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

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

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

注釈

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

要件

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

こちらもご覧ください

• Docker@2