Partager via

DockerCompose@1 - Tâche Docker Compose v1

Générez, envoyez ou exécutez des applications Docker à plusieurs conteneurs. La tâche peut être utilisée avec Docker ou Azure Container Registry.

Syntaxe

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

Données d'entrée

containerregistrytype - type de registre de conteneurs
string. Obligatoire. Valeurs autorisées : Azure Container Registry, Container Registry. Valeur par défaut : Azure Container Registry.

Sélectionnez un type de registre de conteneurs.


dockerRegistryEndpoint - connexion au service De Registre Docker
string. Optionnel. Utilisez quand containerregistrytype = Container Registry.

Sélectionnez une connexion de service de Registre Docker. Obligatoire pour les commandes qui doivent s’authentifier auprès d’un registre.


azureSubscription - abonnement Azure
Alias d’entrée : azureSubscriptionEndpoint. string. Optionnel. Utilisez quand containerregistrytype = Azure Container Registry.

Sélectionnez un abonnement Azure.


azureContainerRegistry - Azure Container Registry
string. Optionnel. Utilisez quand containerregistrytype = Azure Container Registry.

Sélectionnez un registre de conteneurs Azure.


dockerComposeFile - fichier Docker Compose
string. Obligatoire. Valeur par défaut : **/docker-compose.yml.

Chemin d’accès au fichier Docker Compose principal à utiliser.


additionalDockerComposeFiles - fichiers Docker Compose supplémentaires
string.

Fichiers Docker Compose supplémentaires à combiner avec le fichier Docker Compose principal. Les chemins relatifs sont résolus par rapport au répertoire contenant le fichier Docker Compose principal. Si un fichier spécifié est introuvable, il est ignoré. Spécifiez chaque chemin d’accès de fichier sur une nouvelle ligne.


variables d’environnement dockerComposeFileArgs -
string.

Variables d’environnement à définir lors de la commande. Spécifiez chaque paire nom=valeur sur une nouvelle ligne.


projectName - nom du projet
string. Valeur par défaut : $(Build.Repository.Name).

Nom de projet utilisé pour le nommage par défaut des images et des conteneurs.


qualifyImageNames - qualifier les noms d’images
boolean. Valeur par défaut : true.

Qualifiez les noms d’image pour les services générés avec le nom d’hôte de la connexion au service de registre Docker, sauf indication contraire.


action - action
string. Obligatoire. Valeurs autorisées : Build services (Générer des images de service), Push services (images de service Push), Run services (Exécuter des images de service), Run a specific service (Exécuter une image de service spécifique), Lock services (verrouiller les images de service), Write service image digests, Combine configuration, Run a Docker Compose command. Valeur par défaut : Run a Docker Compose command.

Sélectionnez une action Docker Compose.


additionalImageTags - balises d’image supplémentaires
string. Optionnel. Utilisez quand action = Build services || action = Push services.

Balises supplémentaires pour les images Docker en cours de création ou d’envoi.


includeSourceTags - inclure des balises sources
boolean. Optionnel. Utilisez quand action = Build services || action = Push services. Valeur par défaut : false.

Incluez des balises Git lors de la création ou de la diffusion d’images Docker.


includeLatestTag - Inclure la dernière de balise
boolean. Optionnel. Utilisez quand action = Build services || action = Push services. Valeur par défaut : false.

Incluez la balise 'latest' lors de la création ou de la diffusion d’images Docker.


buildImages - générer des images
boolean. Optionnel. Utilisez quand action = Run services. Valeur par défaut : true.

Créez des images avant de démarrer les conteneurs de services.


serviceName - nom du service
string. Obligatoire lorsque action = Run a specific service.

Nom du service spécifique à exécuter.


containerName - nom de conteneur
string. Optionnel. Utilisez quand action = Run a specific service.

Nom du conteneur de service spécifique à exécuter.


ports ports -
string. Optionnel. Utilisez quand action = Run a specific service.

Ports dans le conteneur de service spécifique à publier sur l’hôte. Spécifiez chaque liaison host-port :container-port sur une nouvelle ligne.


workingDirectory - répertoire de travail
Alias d’entrée : workDir. string. Optionnel. Utilisez quand action = Run a specific service.

Répertoire de travail du conteneur de service spécifique.


remplacement de point d’entrée entrypoint -
string. Optionnel. Utilisez quand action = Run a specific service.

Remplacez le point d’entrée par défaut du conteneur de service spécifique.


containerCommand - commande
string. Optionnel. Utilisez quand action = Run a specific service.

Commande à exécuter dans le conteneur de service spécifique. Par exemple, si l’image contient une simple application Web Python Flask, vous pouvez spécifier « python app.py » pour lancer l’application Web.


detached - Exécuter en arrière-plan
boolean. Optionnel. Utilisez quand action = Run services || action = Run a specific service. Valeur par défaut : true.

Exécutez les conteneurs de service en arrière-plan.


abortOnContainerExit - abandonner le de sortie du conteneur
boolean. Optionnel. Utilisez quand action = Run services && detached == false. Valeur par défaut : true.

Arrêtez tous les conteneurs lorsqu’ils sortent.


imageDigestComposeFile - fichier de composition de synthèse d’images
string. Obligatoire lorsque action = Write service image digests. Valeur par défaut : $(Build.StagingDirectory)/docker-compose.images.yml.

Chemin d’accès à un fichier Docker Compose créé et rempli avec les résumés complets du référentiel d’images de l’image Docker de chaque service.


removeBuildOptions - Supprimer les options de génération
boolean. Optionnel. Utilisez quand action = Lock services || action = Combine configuration. Valeur par défaut : false.

Supprimez les options de génération du fichier Docker Compose de sortie.


baseResolveDirectory - d’annuaire de résolution de base
string. Optionnel. Utilisez quand action = Lock services || action = Combine configuration.

Répertoire de base à partir duquel les chemins d’accès relatifs dans le fichier Docker Compose de sortie doivent être résolus.


outputDockerComposeFile - fichier Docker Compose de sortie
string. Obligatoire lorsque action = Lock services || action = Combine configuration. Valeur par défaut : $(Build.StagingDirectory)/docker-compose.yml.

Chemin d’accès à un fichier Docker Compose de sortie.


dockerComposeCommand - commande
string. Obligatoire lorsque action = Run a Docker Compose command.

Docker Compose à exécuter avec des arguments. Par exemple, 'rm --all' pour supprimer tous les conteneurs de service arrêtés.


arguments - arguments
string. Optionnel. Utilisez quand action != Lock services && action != Combine configuration && action != Write service image digests.

Options de la commande Docker Compose. Exemple :
Pour la commande build,
--pull --compress --parallel.


dockerHostEndpoint - connexion au service hôte Docker
string.

Sélectionnez une connexion au service hôte Docker. La valeur par défaut est l’hôte de l’agent.


nopIfNoDockerComposeFile - aucune opération si aucun fichier Docker Compose n'
boolean. Valeur par défaut : false.

Si le fichier Docker Compose n’existe pas, ignorez cette tâche. Cela est utile lorsque la tâche propose un comportement facultatif basé sur l’existence d’un fichier Docker Compose dans le référentiel.


requireAdditionalDockerComposeFiles - exiger des fichiers Docker Compose supplémentaires
boolean. Valeur par défaut : false.

Produit une erreur si les fichiers Docker Compose supplémentaires n’existent pas. Cela remplace le comportement par défaut qui consiste à ignorer un fichier s’il n’existe pas.


currentWorkingDirectory - répertoire de travail
Alias d’entrée : cwd. string. Valeur par défaut : $(System.DefaultWorkingDirectory).

Répertoire de travail pour la commande Docker Compose.


dockerComposePath - chemin d’accès exécutable Docker Compose
string.

Cet exécutable docker-compose sera utilisé si le chemin d’accès est fourni.


Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Cette tâche définit les variables de sortie suivantes, que vous pouvez utiliser en aval, les travaux et les étapes.

DockerComposeOutput
Le chemin du ou des fichiers qui contiennent la sortie de la commande. Il peut contenir plusieurs chemins d’accès aux fichiers (séparés par des caractères de nouvelle ligne) dans le cas de la commande dockerComposeRun (un pour l’exécution et un pour l’arrêt), dockerPush (un pour chaque image poussée), dockerBuild (la construction elle-même et toutes les commandes de balise) et dockerDigest (un pour chaque image extraite). Les autres commandes ne génèrent qu’un seul fichier.

Spécifications

Besoin Descriptif
Types de pipelines YAML, Build Classique, Version Classique
Exécutions sur Agent, DeploymentGroup
demandes Aucun
Capacités Cette tâche ne répond à aucune demande de tâches ultérieures dans le travail.
restrictions de commande N'importe lequel
variables settables N'importe lequel
Version de l’agent Toutes les versions de l’agent prises en charge.
Catégorie de tâche Construire