Docker@0 - Tarefa do Docker v0

Artigo
07/02/2024

Criar, etiquetar, emitir, executar imagens do Docker ou executar um comando do Docker. Utilize esta tarefa com o Docker ou o Azure Container Registry.

Nota

Docker@2 é uma versão mais recente desta tarefa que simplifica a tarefa ao remover entradas que podem ser transmitidas como argumentos para o comando.

Syntax

# 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.

# 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. 
  # 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.

# Docker v0
# Build, tag, push, or run Docker images, or run a Docker command. Task can be used with Docker or Azure Container registry.
- 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. 
  # 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.

Entradas

containerregistrytype - Tipo de Registo de Contentor
string. Obrigatório. Valores permitidos: Azure Container Registry, Container Registry. Valor predefinido: Azure Container Registry.

Selecione "Azure Container Registry" para ligar ao mesmo com uma Ligação de Serviço do Azure. Selecione "Registo de contentor" para ligar ao Docker Hub ou a qualquer outro registo de contentor privado.

dockerRegistryConnection - Ligação do Serviço de Registo do Docker
Alias de entrada: dockerRegistryEndpoint. string. Opcional. Utilize quando containerregistrytype = Container Registry.

Especifica uma ligação do serviço de registo do Docker. Necessário para comandos que precisam de ser autenticados com um registo.

azureSubscription - Subscrição do Azure
Alias de entrada: azureSubscriptionEndpoint. string. Opcional. Utilize quando containerregistrytype = Azure Container Registry.

Especifica uma subscrição do Azure.

azureContainerRegistry - Azure Container Registry
string. Opcional. Utilize quando containerregistrytype = Azure Container Registry.

Especifica uma Azure Container Registry na Subscrição do Azure selecionada. A imagem de contentor é criada e, em seguida, enviada para este registo de contentor.

action - Ação
string. Obrigatório. Valores permitidos: Build an image, , Tag imagesPush an image, Push images, Run an image, Run a Docker command. Valor predefinido: Build an image.

Especifica uma ação do Docker.

dockerFile - Ficheiro do Docker
string. Necessário quando action = Build an image. Valor predefinido: **/Dockerfile.

Especifica o caminho para o ficheiro do Docker. A tarefa utiliza o primeiro ficheiro do Docker que encontra para criar a imagem.

addBaseImageData - Adicionar metadados de imagem de base a imagens
boolean. Valor predefinido: true.

O valor predefinido adiciona dados de imagem de base, como, por exemplo, o nome da imagem de base e o resumo para ajudar na rastreabilidade. Pode optar ativamente por não participar ao definir o valor como false.

buildArguments - Argumentos de Compilação
string. Opcional. Utilize quando action = Build an image.

Especifica variáveis de tempo de compilação para o ficheiro do Docker. Formate cada name=value par numa nova linha.

defaultContext - Utilizar o Contexto de Compilação Predefinido
boolean. Opcional. Utilize quando action = Build an image. Valor predefinido: true.

Especifica o contexto de compilação do diretório que contém o ficheiro do Docker.

context - Contexto de Compilação
string. Opcional. Utilize quando action = Build an image && defaultContext = false.

Especifica o caminho para o contexto de compilação.

imageName - Nome da Imagem
string. Necessário quando action == Build an image || action == Push an image || action == Run an image. Valor predefinido: $(Build.Repository.Name):$(Build.BuildId).

Especifica o nome da imagem do Docker para compilar, emitir ou executar.

imageNamesPath - Caminho dos Nomes de Imagem
string. Necessário quando action == Tag images || action == Push images.

Especifica o caminho para um ficheiro de texto que contém os nomes das imagens do Docker para etiquetar ou emitir. Liste cada nome de imagem numa linha separada.

qualifyImageName - Qualificar Nome da Imagem
boolean. Opcional. Utilize quando action = Build an image || action = Tag images || action = Push an image || action = Push images || action = Run an image. Valor predefinido: true.

Especifica um nome de imagem elegível com o nome de anfitrião da ligação do serviço de registo do Docker.

additionalImageTags - Etiquetas de Imagem Adicionais
string. Opcional. Utilize quando action = Build an image || action = Tag images || action = Push an image || action = Push images.

Especifica etiquetas adicionais para a imagem do Docker que está a ser criada ou enviada.

includeSourceTags - Incluir Etiquetas de Origem
boolean. Opcional. Utilize quando action = Build an image || action = Tag image || action = Push an image || action = Push images. Valor predefinido: false.

Especifica se deve incluir etiquetas git ao criar ou emitir a imagem do Docker.

includeLatestTag - Incluir Etiqueta Mais Recente
boolean. Opcional. Utilize quando action = Build an image || action = Push an image || action = Push images. Valor predefinido: false.

Especifica se pretende incluir a etiqueta mais recente ao criar ou emitir a imagem do Docker.

imageDigestFile - Ficheiro de Resumo da Imagem
string. Opcional. Utilize quando action = Push an image || action = Push images.

Especifica o caminho para um ficheiro que é criado e preenchido com o resumo completo do repositório de imagens da imagem do Docker que foi enviada.

containerName - Nome do Contentor
string. Opcional. Utilize quando action = Run an image.

Especifica o nome do contentor do Docker a executar.

ports - Portas
string. Opcional. Utilize quando action = Run an image.

Especifica as portas no contentor do Docker a publicar no anfitrião. Liste cada host-port:container-port enlace numa nova linha.

volumes - Volumes
string. Opcional. Utilize quando action = Run an image.

Especifica os volumes a montar a partir do anfitrião. Liste cada host-dir:container-dir uma numa nova linha.

envVars - Variáveis de Ambiente
string. Opcional. Utilize quando action = Run an image.

Especifica variáveis de ambiente para o contentor do Docker. Listar cada name=value par numa nova linha.

workDir - Diretório de Trabalho
string. Opcional. Utilize quando action = Run an image.

Especifica o diretório de trabalho do contentor do Docker.

entrypoint - Substituição do Ponto de Entrada
string. Opcional. Utilize quando action = Run an image.

Especifica uma substituição do ponto de entrada predefinido para o contentor do Docker.

containerCommand - Comando
string. Opcional. Utilize quando action = Run an image.

Especifica um comando de execução do Docker. O comando docker run cria primeiro uma camada de contentor gravável sobre a imagem especificada e, em seguida, inicia-a com o comando run especificado. Por exemplo, se a imagem contiver uma aplicação Web Do Python Flask simples, pode especificar python app.py para iniciar a aplicação Web.

detached - Executar em Segundo Plano
boolean. Opcional. Utilize quando action = Run an image. Valor predefinido: true.

Especifica se pretende executar o contentor do Docker em segundo plano.

restartPolicy - Reiniciar Política
string. Necessário quando action = Run an image && detached = true. Valores permitidos: no, onFailure (Falha ativada), always, unlessStopped (A menos que tenha parado). Valor predefinido: no.

Especifica uma política de reinício.

restartMaxRetries - Máximo de Repetições de Reinício
string. Opcional. Utilize quando action = Run an image && detached = true && restartPolicy = onFailure.

Especifica o número máximo de repetições de reinício que o daemon do Docker tenta.

customCommand - Comando
string. Necessário quando action = Run a Docker command.

Especifica o comando e os argumentos do Docker a executar. Por exemplo, rmi -f image-name remove uma imagem.

dockerHostEndpoint - Ligação do Serviço de Anfitrião do Docker
string.

Especifica uma ligação do serviço de anfitrião do Docker. Predefinição para o anfitrião do agente.

enforceDockerNamingConvention - Forçar o nome da imagem a seguir a convenção de nomenclatura do Docker
boolean. Valor predefinido: true.

Se estiver ativado, modifica o nome da imagem do Docker de acordo com as convenções de nomenclatura do Docker. Por exemplo, converta carateres maiúsculos em minúsculas e remova espaços.

workingDirectory - Diretório de Trabalho
Alias de entrada: cwd. string. Valor predefinido: $(System.DefaultWorkingDirectory).

Especifica o diretório de trabalho para o comando do Docker.

memory - Limite de memória
string.

Especifica a quantidade máxima de memória disponível para o contentor como um número inteiro com sufixos opcionais, por exemplo 2GB.

Opções de controlo de tarefas

Todas as tarefas têm opções de controlo para além das entradas de tarefas. Para obter mais informações, veja Opções de controlo e propriedades de tarefas comuns.

Variáveis de saída

Esta tarefa define as seguintes variáveis de saída, que pode consumir em passos, tarefas e fases a jusante.

DockerOutput
Armazena a saída do comando docker.

DockerOutputPath
O caminho do ficheiro que contém a saída do comando de compilação.

Esta tarefa define as seguintes variáveis de saída, que pode consumir em passos, tarefas e fases a jusante.

DockerOutput
Armazena a saída do comando docker

Observações

Docker@2 é uma versão mais recente desta tarefa que simplifica a tarefa ao remover entradas que podem ser transmitidas como argumentos para o comando.

Requisitos

Requisito	Description
Tipos de pipeline	YAML, Compilação clássica, Versão clássica
É executado em	Agente, DeploymentGroup
Exigências	Nenhuma
Capacidades	Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa.
Restrições de comandos	Qualquer
Variáveis de tabelas definidas	Qualquer
Versão do agente	Todas as versões de agente suportadas.
Categoria da tarefa	Compilação

Ver também

Docker@2

Partilhar via