Docker@1 - Docker v1 工作

建置、標記、推送或執行 Docker 映像，或執行 Docker 命令。 將此工作與 Docker 或 Azure Container Registry 搭配使用。

備註

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。 選取 Azure Container Registry 以連線到 Docker Hub 或任何其他私人容器登錄。

addBaseImageData - 將基底映射元數據新增至 image（s）
boolean。 預設值：true。

默認值會新增基底映射數據，例如基底映像名稱和摘要，以協助追蹤。 您可以將此值設定為 false，以退出宣告此預設行為。

dockerRegistryEndpoint - Docker 登錄服務連線
string。 選擇性。 containerregistrytype = Container Registry && command != logout時使用 。

指定 Docker 登錄服務連線。 使用登入認證的指令需要 。

azureSubscriptionEndpoint - Azure 訂用帳戶
string。 選擇性。 containerregistrytype = Azure Container Registry && command != logout時使用 。

指定 Azure 訂用帳戶。

azureContainerRegistry - Azure Container Registry
string。 選擇性。 containerregistrytype = Azure Container Registry && command != logout時使用 。

指定所選 Azure 訂用帳戶中的 Azure Container Registry。 容器映像會建置並推送至此容器登錄。

command - 命令
string。 必須的。 允許的值：Build an image（build）、Tag image（tag）、Push an image（push）、Run an image（run）、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 - 容器命令
string。 選擇性。 command = Run an image || command = run時使用 。

指定 Docker 執行命令。 docker run 命令會先在指定的映像上建立可寫入的容器層，然後使用指定的執行命令加以啟動。 例如，如果映像包含簡單的 Python Flask Web 應用程式，您可以指定要啟動 Web 應用程式的 python app.py。

在背景中執行 runInBackground -
boolean。 選擇性。 command = Run an image || command = run時使用 。 預設值：true。

指定是否要在背景中執行 Docker 容器。

restartPolicy - 重新啟動原則
string。 runInBackground = true時為必要項。 允許的值：no、onFailure（失敗時）、alwaysunlessStopped（除非停止）。 預設值：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、傳統組建、傳統版本
執行於	Agent、DeploymentGroup
需求	沒有
功能	此工作不符合作業中後續工作的任何需求。
命令限制	任意
Settable 變數	任意
代理程式版本	所有支援的代理程式版本。
工作類別	建造

另請參閱

• Docker@2