Compartilhar via


Docker@1 – Tarefa do Docker v1

Crie, marque, pressione ou execute imagens do Docker ou execute um comando do Docker. Use essa tarefa com o Docker ou o Registro de Contêiner do Azure.

Observação

Docker@2 é uma versão mais recente dessa tarefa que simplifica a tarefa removendo entradas que podem ser passadas como argumentos para o comando.

Sintaxe

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

Entradas

containerregistrytype - tipo de registro de contêiner
string. Necessário quando command != logout. Valores permitidos: Azure Container Registry, Container Registry. Valor padrão: Azure Container Registry.

Especifica o Registro de Contêiner do Azure para se conectar usando uma Conexão de Serviço do Azure. Selecione um Registro de Contêiner do Azure para se conectar a um Hub do Docker ou a qualquer outro registro de contêiner privado.


addBaseImageData - Adicionar metadados de imagem base a imagens
boolean. Valor padrão: true.

O valor padrão adiciona dados de imagem base, como o nome da imagem base e o resumo, para ajudar na rastreabilidade. Você pode recusar esse comportamento padrão definindo esse valor como false.


de conexão do serviço de registro do Docker dockerRegistryEndpoint -
string. Opcional. Use quando containerregistrytype = Container Registry && command != logout.

Especifica uma conexão de serviço do Registro do Docker. Necessário para comandos que se autenticam usando um registro.


azureSubscriptionEndpoint - assinatura do Azure
string. Opcional. Use quando containerregistrytype = Azure Container Registry && command != logout.

Especifica uma assinatura do Azure.


azureContainerRegistry - registro de contêiner do Azure
string. Opcional. Use quando containerregistrytype = Azure Container Registry && command != logout.

Especifica um Registro de Contêiner do Azure na Assinatura do Azure selecionada. A imagem do contêiner é criada e enviada por push para esse registro de contêiner.


comando command -
string. Obrigatório Valores permitidos: Build an image (build), Tag image (marca), Push an image (push), Run an image (execução), login, logout. Valor padrão: Build an image.

Especifica o comando docker a ser executado.


do Dockerfile dockerFile -
string. Necessário quando command = Build an image || command = build. Valor padrão: **/Dockerfile.

Especifica o caminho para o arquivo do Docker. A tarefa usa o primeiro arquivo docker encontrado para criar a imagem.


argumentos arguments -
string. Opcional. Use quando command != login && command != logout.

Especifica argumentos adicionais a serem passados para o cliente docker. Usar o valor buildAndPush no parâmetro de comando ignora a propriedade arguments.


pushMultipleImages - efetuar push de várias imagens
boolean. Opcional. Use quando command = Push an image || command = push. Valor padrão: false.

Especifica uma lista em um arquivo de texto de imagens do Docker a serem enviadas por push. Liste cada nome de imagem no formato Imagename1:tag1 em uma linha separada. Listar um nome de imagem sem marcas, por exemplo, Imagename2, envia por push todas as marcas no contêiner Imagename2.


tagMultipleImages - Marcar várias imagens
boolean. Opcional. Use quando command = Tag image || command = tag. Valor padrão: false.

Especifica uma lista de várias marcas de imagem e imagens do Docker para marcar em um arquivo de texto. Liste cada nome de imagem no formato Imagename1:tag1 em uma linha separada. As imagens listadas sem uma marca como Imagename2 são marcadas como mais recentes por padrão.


imageName - nome da imagem
string. Necessário quando command = Build an image || command = build || command = Run an image || command = run || pushMultipleImages = false || tagMultipleImages = false. Valor padrão: $(Build.Repository.Name):$(Build.BuildId).

Especifica o nome da imagem do Docker a ser criada, enviada por push ou executada.


imageNamesPath - caminho de nomes de imagem
string. Necessário quando tagMultipleImages = true || pushMultipleImages = true.

Especifica o caminho para um arquivo de texto que contém os nomes das imagens do Docker para marcar ou enviar por push. Liste cada nome de imagem em uma linha separada.


qualifyImageName - Qualifique o nome da imagem
boolean. Opcional. Use quando command = Build an image || command = build || command = Tag image || command = tag || command = Push an image || command = push || command = Run an image || command = run. Valor padrão: true.

Especifica um nome de imagem de qualificação com o nome do host da conexão de serviço do Registro do Docker.


qualifySourceImageName - Qualificar o nome da imagem de origem
boolean. Opcional. Use quando command = Tag image || command = tag. Valor padrão: false.

Especifica um nome de imagem de qualificação com o nome do host da conexão de serviço do Registro do Docker.


includeSourceTags - Incluir marcas de origem
boolean. Opcional. Use quando command = Build an image || command = build || command = Tag image || command = tag || command = Push an image || command = push. Valor padrão: false.

Especifica as marcas git a serem incluídas ao compilar ou enviar por push a imagem do Docker.


includeLatestTag - Incluir a marca mais recente
boolean. Opcional. Use quando command = Build an image || command = build. Valor padrão: false.

Especifica se o marca de mais recente ao compilar a imagem do Docker.


addDefaultLabels - Adicionar rótulos padrão
boolean. Opcional. Use quando addDefaultLabels = false. Valor padrão: true.

Especifica se os metadados de CI/CD devem ser adicionados à imagem de contêiner usando rótulos do Docker, como repositório, confirmação, compilação e informações de versão.


useDefaultContext - Usar o contexto de build padrão
boolean. Opcional. Use quando command = Build an image || command = build. Valor padrão: true.

Especifica a adição ou remoção do contexto de build ao diretório que contém o arquivo do Docker.


buildContext - contexto de build
string. Opcional. Use quando useDefaultContext = false.

Especifica o caminho para o contexto de build.


imageDigestFile - de arquivo de resumo de imagem
string. Opcional. Use quando command = Push an image || command = push.

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


containerName - nome do contêiner
string. Opcional. Use quando command = Run an image || command = run.

Especifica o nome do contêiner do Docker a ser executado.


portas ports -
string. Opcional. Use quando command = Run an image || command = run.

Especifica as portas no contêiner do Docker a serem publicadas no host. Liste cada associação host-port:container-port em uma linha separada.


volumes - volumes
string. Opcional. Use quando command = Run an image || command = run.

Especifica os volumes a serem montados do host. Liste cada host-dir:container-dir em uma linha separada.


variáveis de ambiente envVars -
string. Opcional. Use quando command = Run an image || command = run.

Especifica variáveis de ambiente para o contêiner do Docker. Liste cada par name=value em uma linha separada.


do diretório de trabalho do
string. Opcional. Use quando command = Run an image || command = run.

Especifica o diretório de trabalho para o contêiner do Docker.


substituição do ponto de entrada entrypointOverride -
string. Opcional. Use quando command = Run an image || command = run.

Especifica se o ponto de entrada padrão deve ser substituído para o contêiner do Docker.


containerCommand - de comando contêiner
string. Opcional. Use quando command = Run an image || command = run.

Especifica um comando de execução do Docker. O comando de execução do Docker primeiro cria uma camada de contêiner gravável sobre a imagem especificada e, em seguida, inicia-a usando o comando de execução especificado. Por exemplo, se a imagem contiver um aplicativo Web Simples do Python Flask, você poderá especificar python app.py para iniciar o aplicativo Web.


runInBackground - Executar em segundo plano
boolean. Opcional. Use quando command = Run an image || command = run. Valor padrão: true.

Especifica se o contêiner do Docker deve ser executado em segundo plano.


restartPolicy - de política de reinicialização
string. Necessário quando runInBackground = true. Valores permitidos: no, onFailure (Em falha), always, unlessStopped (a menos que parado). Valor padrão: no.

Especifica quando executar uma política de reinicialização.


maxRestartRetries - Tentativas máximas de reinicialização
string. Opcional. Use quando runInBackground = true && restartPolicy = onFailure.

Especifica o número máximo de tentativas de reinicialização das tentativas de daemon do Docker.


dockerHostEndpoint - de conexão do serviço de host do Docker
string. Opcional. Use quando command != login && command != logout.

Especifica uma conexão de serviço de host do Docker. O padrão é o host do agente.


enforceDockerNamingConvention - Forçar o nome da imagem para seguir a convenção de nomenclatura do Docker
boolean. Opcional. Use quando command != login && command != logout. Valor padrão: true.

O valor padrão modifica o nome da imagem do Docker de acordo com as convenções de nomenclatura do Docker. Por exemplo, converta caracteres maiúsculas em minúsculas e remova espaços.


memoryLimit - limite de memória
string. Opcional. Use quando command != login && command != logout.

Especifica a quantidade máxima de memória disponível para o contêiner como um inteiro com sufixos opcionais, como 2GB.


Opções de controle de tarefa

Todas as tarefas têm opções de controle além das suas entradas de tarefas. Para obter mais informações, consulte as opções de Controle de e as propriedades comuns da tarefa.

Variáveis de saída

Essa tarefa define as seguintes variáveis de saída , que você pode consumir em etapas downstream, trabalhos e estágios.

DockerOutput
Armazena a saída do comando docker

DockerOutputPath
o caminho do arquivo que contém a saída do comando de build.

Observações

Docker@2 é uma versão mais recente dessa tarefa que simplifica a tarefa removendo entradas que podem ser passadas como argumentos para o comando.

Requisitos

Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
Execuções em Agente, DeploymentGroup
de demandas Nenhum
recursos Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
restrições de comando Qualquer
variáveis settable Qualquer
Versão do agente Todas as versões de agente com suporte.
Categoria de tarefa Construir

Consulte também