DockerCompose@1 - Tarefa Docker Compose v1

2025-06-24

Crie, envie ou execute aplicativos Docker de vários contêineres. A tarefa pode ser usada com o Docker ou o Registro de Contêiner do Azure.

Sintaxe

# Docker Compose v1
# Build, push or run multi-container Docker applications. Task can be used with Docker or Azure Container registry.
- task: DockerCompose@1
  inputs:
    containerregistrytype: 'Azure Container Registry' # 'Azure Container Registry' | 'Container Registry'. Required. Container Registry Type. Default: Azure Container Registry.
    #dockerRegistryEndpoint: # string. 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. 
    dockerComposeFile: '**/docker-compose.yml' # string. Required. Docker Compose File. Default: **/docker-compose.yml.
    #additionalDockerComposeFiles: # string. Additional Docker Compose Files. 
    #dockerComposeFileArgs: # string. Environment Variables. 
    #projectName: '$(Build.Repository.Name)' # string. Project Name. Default: $(Build.Repository.Name).
    #qualifyImageNames: true # boolean. Qualify Image Names. Default: true.
    action: 'Run a Docker Compose command' # 'Build services' | 'Push services' | 'Run services' | 'Run a specific service' | 'Lock services' | 'Write service image digests' | 'Combine configuration' | 'Run a Docker Compose command'. Required. Action. Default: Run a Docker Compose command.
    #additionalImageTags: # string. Optional. Use when action = Build services || action = Push services. Additional Image Tags. 
    #includeSourceTags: false # boolean. Optional. Use when action = Build services || action = Push services. Include Source Tags. Default: false.
    #includeLatestTag: false # boolean. Optional. Use when action = Build services || action = Push services. Include Latest Tag. Default: false.
    #buildImages: true # boolean. Optional. Use when action = Run services. Build Images. Default: true.
    #serviceName: # string. Required when action = Run a specific service. Service Name. 
    #containerName: # string. Optional. Use when action = Run a specific service. Container Name. 
    #ports: # string. Optional. Use when action = Run a specific service. Ports. 
    #workingDirectory: # string. Alias: workDir. Optional. Use when action = Run a specific service. Working Directory. 
    #entrypoint: # string. Optional. Use when action = Run a specific service. Entry Point Override. 
    #containerCommand: # string. Optional. Use when action = Run a specific service. Command. 
    #detached: true # boolean. Optional. Use when action = Run services || action = Run a specific service. Run in Background. Default: true.
    #abortOnContainerExit: true # boolean. Optional. Use when action = Run services && detached == false. Abort on Container Exit. Default: true.
    #imageDigestComposeFile: '$(Build.StagingDirectory)/docker-compose.images.yml' # string. Required when action = Write service image digests. Image Digest Compose File. Default: $(Build.StagingDirectory)/docker-compose.images.yml.
    #removeBuildOptions: false # boolean. Optional. Use when action = Lock services || action = Combine configuration. Remove Build Options. Default: false.
    #baseResolveDirectory: # string. Optional. Use when action = Lock services || action = Combine configuration. Base Resolve Directory. 
    #outputDockerComposeFile: '$(Build.StagingDirectory)/docker-compose.yml' # string. Required when action = Lock services || action = Combine configuration. Output Docker Compose File. Default: $(Build.StagingDirectory)/docker-compose.yml.
    #dockerComposeCommand: # string. Required when action = Run a Docker Compose command. Command. 
    #arguments: # string. Optional. Use when action != Lock services && action != Combine configuration && action != Write service image digests. Arguments. 
  # Advanced Options
    #dockerHostEndpoint: # string. Docker Host Service Connection. 
    #nopIfNoDockerComposeFile: false # boolean. No-op if no Docker Compose File. Default: false.
    #requireAdditionalDockerComposeFiles: false # boolean. Require Additional Docker Compose Files. Default: false.
    #currentWorkingDirectory: '$(System.DefaultWorkingDirectory)' # string. Alias: cwd. Working Directory. Default: $(System.DefaultWorkingDirectory).
    #dockerComposePath: # string. Docker Compose executable Path.

Insumos

containerregistrytype - Tipo de Registro de Contêiner
string. Obrigatório Valores permitidos: Azure Container Registry, Container Registry. Valor predefinido: Azure Container Registry.

Selecione um tipo de registro de contêiner.

dockerRegistryEndpoint - de Conexão do Serviço de Registro do Docker
string. Opcional. Use quando containerregistrytype = Container Registry.

Selecione uma conexão de serviço de registro do Docker. Necessário para comandos que precisam ser autenticados com um registro.

azureSubscription - de assinatura do Azure
Alias de entrada: azureSubscriptionEndpoint. string. Opcional. Use quando containerregistrytype = Azure Container Registry.

Selecione uma subscrição do Azure.

azureContainerRegistry - Registro de Contêiner do Azure
string. Opcional. Use quando containerregistrytype = Azure Container Registry.

Selecione um Registro de Contêiner do Azure.

dockerComposeFile - Arquivo de composição do Docker
string. Obrigatório Valor predefinido: **/docker-compose.yml.

Caminho para o arquivo Docker Compose primário a ser usado.

additionalDockerComposeFiles - Arquivos de composição adicionais do Docker
string.

Arquivos adicionais do Docker Compose a serem combinados com o arquivo Docker Compose primário. Os caminhos relativos são resolvidos em relação ao diretório que contém o arquivo Docker Compose primário. Se um arquivo especificado não for encontrado, ele será ignorado. Especifique cada caminho de arquivo em uma nova linha.

dockerComposeFileArgs - Variáveis de ambiente
string.

Variáveis de ambiente a serem definidas durante o comando. Especifique cada par name=value em uma nova linha.

projectName - nome do projeto
string. Valor predefinido: $(Build.Repository.Name).

Nome do projeto usado para nomenclatura padrão de imagens e contêineres.

qualifyImageNames - Qualificar nomes de imagens
boolean. Valor predefinido: true.

Qualifique nomes de imagem para serviços criados com o nome de host da conexão do serviço de registro do Docker, se não especificado de outra forma.

action - Ação
string. Obrigatório Valores permitidos: Build services (Criar imagens de serviço), Push services (Enviar imagens de serviço), Run services (Executar imagens de serviço), Run a specific service (Executar uma imagem de serviço específica), Lock services (Bloquear imagens de serviço), Write service image digests, Combine configurationRun a Docker Compose command. Valor predefinido: Run a Docker Compose command.

Selecione uma ação Docker Compose.

additionalImageTags - Tags de imagem adicionais
string. Opcional. Use quando action = Build services || action = Push services.

Tags adicionais para as imagens do Docker que estão sendo criadas ou enviadas por push.

includeSourceTags - incluir tags de origem
boolean. Opcional. Use quando action = Build services || action = Push services. Valor predefinido: false.

Inclua tags Git ao criar ou enviar imagens do Docker.

includeLatestTag - Incluir de tags mais recentes
boolean. Opcional. Use quando action = Build services || action = Push services. Valor predefinido: false.

Inclua a tag 'mais recente' ao criar ou enviar imagens do Docker.

buildImages - Criar imagens
boolean. Opcional. Use quando action = Run services. Valor predefinido: true.

Crie imagens antes de iniciar contêineres de serviço.

serviceName - nome do serviço
string. Necessário quando action = Run a specific service.

Nome do serviço específico a ser executado.

containerName - nome do contêiner
string. Opcional. Use quando action = Run a specific service.

Nome do contêiner de serviço específico a ser executado.

ports - Portos
string. Opcional. Use quando action = Run a specific service.

Portas no contêiner de serviço específico para publicar no host. Especifique cada ligação host-port:container-port em uma nova linha.

workingDirectory - Diretório de Trabalho
Alias de entrada: workDir. string. Opcional. Use quando action = Run a specific service.

O diretório de trabalho para o contêiner de serviço específico.

entrypoint - de substituição de ponto de entrada
string. Opcional. Use quando action = Run a specific service.

Substitua o ponto de entrada padrão para o contêiner de serviço específico.

containerCommand - de comando
string. Opcional. Use quando action = Run a specific service.

Comando a ser executado no contêiner de serviço específico. Por exemplo, se a imagem contiver uma simples aplicação web Python Flask, você pode especificar 'python app.py' para iniciar a aplicação web.

detached - Executar em segundo plano
boolean. Opcional. Use quando action = Run services || action = Run a specific service. Valor predefinido: true.

Execute os contêineres de serviço em segundo plano.

abortOnContainerExit - Abortar no de saída do contêiner
boolean. Opcional. Use quando action = Run services && detached == false. Valor predefinido: true.

Pare todos os contentores quando algum contentor sair.

imageDigestComposeFile - de arquivo de composição do Image Digest
string. Necessário quando action = Write service image digests. Valor predefinido: $(Build.StagingDirectory)/docker-compose.images.yml.

Caminho para um arquivo Docker Compose que é criado e preenchido com os resumos completos do repositório de imagens da imagem do Docker de cada serviço.

removeBuildOptions - Remover opções de compilação
boolean. Opcional. Use quando action = Lock services || action = Combine configuration. Valor predefinido: false.

Remova as opções de compilação do arquivo Docker Compose de saída.

baseResolveDirectory - do diretório de resolução de base
string. Opcional. Use quando action = Lock services || action = Combine configuration.

O diretório base a partir do qual os caminhos relativos no arquivo Docker Compose de saída devem ser resolvidos.

outputDockerComposeFile - de arquivo de composição do Docker de saída
string. Necessário quando action = Lock services || action = Combine configuration. Valor predefinido: $(Build.StagingDirectory)/docker-compose.yml.

Caminho para um arquivo Docker Compose de saída.

dockerComposeCommand - de comando
string. Necessário quando action = Run a Docker Compose command.

Comando Docker Compose para executar com argumentos. Por exemplo, 'rm --all' para remover todos os contêineres de serviço interrompidos.

arguments - Argumentos
string. Opcional. Use quando action != Lock services && action != Combine configuration && action != Write service image digests.

Opções de comando Docker Compose. Ex.:
Para o comando build,
--pull --compress --paralelo.

dockerHostEndpoint - de Conexão do Serviço de Host do Docker
string.

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

nopIfNoDockerComposeFile - No-op se nenhum arquivo de composição do Docker
boolean. Valor predefinido: false.

Se o arquivo Docker Compose não existir, ignore esta tarefa. Isso é útil quando a tarefa oferece um comportamento opcional com base na existência de um arquivo Docker Compose no repositório.

requireAdditionalDockerComposeFiles - exigir arquivos de composição adicionais do Docker
boolean. Valor predefinido: false.

Produz um erro se os arquivos adicionais do Docker Compose não existirem. Isso substitui o comportamento padrão que é ignorar um arquivo se ele não existir.

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

Diretório de trabalho para o comando Docker Compose.

dockerComposePath - de caminho executável do Docker Compose
string.

Este executável docker-compose será usado se o caminho for fornecido.

Opções de controlo de tarefas

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

Variáveis de saída

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

DockerComposeOutput
O caminho do(s) arquivo(s) que contém a saída do comando. Isso pode conter vários caminhos de arquivo (separados por caracteres de nova linha) no caso do comando dockerComposeRun (um para execução e outro para baixo), dockerPush (um para cada imagem enviada), dockerBuild (a própria compilação e todos os comandos de tag) e dockerDigest (um para cada imagem puxada). Os outros comandos produzem apenas um arquivo.

Requerimentos

Requisito	Descrição
Tipos de pipeline	YAML, Construção clássica, Versão clássica
Funciona em	Agente, DeploymentGroup
Exigências	Nenhum
Capacidades	Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes no trabalho.
Restrições de comando	Qualquer
Variáveis configuráveis	Qualquer
Versão do agente	Todas as versões de agente suportadas.
Categoria de tarefa	Construir