DockerCompose@1 - Tarea de Docker Compose v1

Compile, inserte o ejecute aplicaciones de Docker de varios contenedores. La tarea se puede usar con Docker o Azure Container Registry.

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

tipo de registro de contenedor de containerregistrytype -
string. Obligatorio. Valores permitidos: Azure Container Registry, Container Registry. Valor predeterminado: Azure Container Registry.

Seleccione un tipo de registro de contenedor.

de conexión del servicio del Registro de Docker dockerRegistryEndpoint -
string. Opcional. Use cuando containerregistrytype = Container Registry.

Seleccione una conexión de servicio del registro de Docker. Necesario para los comandos que necesitan autenticarse con un registro.

azureSubscription - de suscripción de Azure
Alias de entrada: azureSubscriptionEndpoint. string. Opcional. Use cuando containerregistrytype = Azure Container Registry.

Seleccione una suscripción a Azure.

azureContainerRegistry - azure Container Registry
string. Opcional. Use cuando containerregistrytype = Azure Container Registry.

Seleccione una instancia de Azure Container Registry.

dockerComposeFile - archivo de Docker Compose
string. Obligatorio. Valor predeterminado: **/docker-compose.yml.

Ruta de acceso al archivo principal de Docker Compose que se va a usar.

additionalDockerComposeFiles - archivos adicionales de Docker Compose
string.

Archivos de Docker Compose adicionales que se combinarán con el archivo principal de Docker Compose. Las rutas de acceso relativas se resuelven en relación con el directorio que contiene el archivo principal de Docker Compose. Si no se encuentra un archivo especificado, se omite. Especifique cada ruta de acceso de archivo en una nueva línea.

dockerComposeFileArgs - variables de entorno
string.

Variables de entorno que se establecerán durante el comando. Especifique cada par nombre=valor en una nueva línea.

de nombre de proyecto de projectName -
string. Valor predeterminado: $(Build.Repository.Name).

Nombre del proyecto utilizado para la nomenclatura predeterminada de imágenes y contenedores.

qualifyImageNames - calificar nombres de imagen
boolean. Valor predeterminado: true.

Califique los nombres de imagen para los servicios compilados con el nombre de host de la conexión del servicio de registro de Docker si no se especifica lo contrario.

action - acción
string. Obligatorio. Valores permitidos: Build services (crear imágenes de servicio), Push services (imágenes de servicio de inserción), Run services (Ejecutar imágenes de servicio), Run a specific service (Ejecutar una imagen de servicio específica), Lock services (bloquear imágenes de servicio), Write service image digests, Combine configuration, Run a Docker Compose command. Valor predeterminado: Run a Docker Compose command.

Seleccione una acción de Docker Compose.

additionalImageTags - etiquetas de imagen adicionales
string. Opcional. Use cuando action = Build services || action = Push services.

Etiquetas adicionales para las imágenes de Docker que se están compilando o insertando.

includeSourceTags - incluir etiquetas de origen
boolean. Opcional. Use cuando action = Build services || action = Push services. Valor predeterminado: false.

Incluya etiquetas de Git al compilar o insertar imágenes de Docker.

includeLatestTag - incluir la etiqueta más reciente
boolean. Opcional. Use cuando action = Build services || action = Push services. Valor predeterminado: false.

Incluya la etiqueta "latest" al compilar o insertar imágenes de Docker.

buildImages - crear imágenes
boolean. Opcional. Use cuando action = Run services. Valor predeterminado: true.

Cree imágenes antes de iniciar los contenedores de servicio.

nombre del servicio de serviceName -
string. Necesario cuando action = Run a specific service.

Nombre del servicio específico que se va a ejecutar.

containerName - nombre de contenedor
string. Opcional. Use cuando action = Run a specific service.

Nombre del contenedor de servicio específico que se va a ejecutar.

puertos de ports -
string. Opcional. Use cuando action = Run a specific service.

Puertos en el contenedor de servicio específico para publicar en el host. Especifique cada enlace host-port:container-port en una nueva línea.

de directorio de trabajo de
Alias de entrada: workDir. string. Opcional. Use cuando action = Run a specific service.

El directorio de trabajo para el contenedor de servicio específico.

de invalidación de punto de entrada de entrypoint -
string. Opcional. Use cuando action = Run a specific service.

Invalide el punto de entrada predeterminado para el contenedor de servicio específico.

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

Comando que se ejecutará en el contenedor de servicio específico. Por ejemplo, si la imagen contiene una aplicación web simple de Python Flask, puede especificar 'python app.py' para iniciar la aplicación web.

detached - Ejecutar en segundo plano
boolean. Opcional. Use cuando action = Run services || action = Run a specific service. Valor predeterminado: true.

Ejecute los contenedores de servicio en segundo plano.

abortOnContainerExit - anular en el de salida del contenedor
boolean. Opcional. Use cuando action = Run services && detached == false. Valor predeterminado: true.

Detenga todos los contenedores cuando salga alguno.

imageDigestComposeFile - archivo de redacción de síntesis de imágenes
string. Necesario cuando action = Write service image digests. Valor predeterminado: $(Build.StagingDirectory)/docker-compose.images.yml.

Ruta de acceso a un archivo de Docker Compose que se crea y rellena con los resúmenes completos del repositorio de imágenes de la imagen de Docker de cada servicio.

removeBuildOptions - quitar opciones de compilación
boolean. Opcional. Use cuando action = Lock services || action = Combine configuration. Valor predeterminado: false.

Quite las opciones de compilación del archivo de Docker Compose de salida.

baseResolveDirectory - de directorio de resolución base
string. Opcional. Use cuando action = Lock services || action = Combine configuration.

El directorio base desde el que se deben resolver las rutas relativas en el archivo de Docker Compose de salida.

de archivo docker compose de salida de outputDockerComposeFile -
string. Necesario cuando action = Lock services || action = Combine configuration. Valor predeterminado: $(Build.StagingDirectory)/docker-compose.yml.

Ruta de acceso a un archivo de Docker Compose de salida.

dockerComposeCommand - comando
string. Necesario cuando action = Run a Docker Compose command.

Docker Compose para ejecutar con argumentos. Por ejemplo, 'rm --all' para quitar todos los contenedores de servicio detenidos.

argumentos de
string. Opcional. Use cuando action != Lock services && action != Combine configuration && action != Write service image digests.

Opciones del comando de Docker Compose. Por ejemplo:
Para el comando de compilación,
--pull --compress --parallel.

dockerHostEndpoint - de conexión del servicio host de Docker
string.

Seleccione una conexión de servicio de host de Docker. El valor predeterminado es el host del agente.

nopIfNoDockerComposeFile - no operativo si no hay ningún archivo de Docker Compose
boolean. Valor predeterminado: false.

Si el archivo de Docker Compose no existe, omita esta tarea. Esto es útil cuando la tarea ofrece un comportamiento opcional basado en la existencia de un archivo de Docker Compose en el repositorio.

requireAdditionalDockerComposeFiles - requerir archivos adicionales de Docker Compose
boolean. Valor predeterminado: false.

Genera un error si los archivos adicionales de Docker Compose no existen. Esto anula el comportamiento predeterminado, que es ignorar un archivo si no existe.

de directorio de trabajo de
Alias de entrada: cwd. string. Valor predeterminado: $(System.DefaultWorkingDirectory).

Directorio de trabajo para el comando Docker Compose.

dockerComposePath - ruta de acceso ejecutable de Docker Compose
string.

Este ejecutable docker-compose se usará si se proporciona la ruta.

Esta tarea define las siguientes variables de salida , que puede consumir en pasos, trabajos y fases de bajada.

DockerComposeOutput
La ruta de los archivos que contienen la salida del comando. Esto puede contener varias rutas de archivo (separadas por caracteres de nueva línea) en el caso de los comandos dockerComposeRun (uno para ejecutar y otro para inactivar), dockerPush (uno para cada imagen insertada), dockerBuild (la compilación en sí y todos los comandos de etiquetas) y dockerDigest (uno para cada imagen extraída). Los demás comandos solo generan un archivo.