DockerCompose@1 – Docker Compose v1-Aufgabe

Erstellen, Pushen oder Ausführen von Docker-Anwendungen mit mehreren Containern Die Aufgabe kann in der Docker- oder Azure Container-Registrierung verwendet werden.

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

containerregistrytype - Containerregistrierungstyp
string. Erforderlich. Zulässige Werte: Azure Container Registry, Container Registry. Standardwert: Azure Container Registry.

Wählen Sie einen Container Registry-Typ aus.

dockerRegistryEndpoint - Verbindung mit dem Docker-Registrierungsdienst
string. Wahlfrei. Wird verwendet, wenn containerregistrytype = Container Registry.

Wählen Sie eine Docker-Registrierungsdienstverbindung aus. Erforderlich für Befehle, die sich bei einer Registrierung authentifizieren müssen.

azureSubscription - Azure-Abonnement
Eingabealias: azureSubscriptionEndpoint. string. Wahlfrei. Wird verwendet, wenn containerregistrytype = Azure Container Registry.

Wählen Sie ein Azure-Abonnement aus.

azureContainerRegistry - Azure Container Registry
string. Wahlfrei. Wird verwendet, wenn containerregistrytype = Azure Container Registry.

Wählen Sie eine Azure Container Registry aus.

dockerComposeFile - Docker-Compose-Datei
string. Erforderlich. Standardwert: **/docker-compose.yml.

Pfad zur primären Docker Compose-Datei, die verwendet werden soll.

additionalDockerComposeFiles - zusätzliche Docker Compose Files
string.

Zusätzliche Docker Compose-Dateien, die mit der primären Docker Compose-Datei kombiniert werden sollen. Relative Pfade werden relativ zum Verzeichnis aufgelöst, das die primäre Docker Compose-Datei enthält. Wenn eine angegebene Datei nicht gefunden wird, wird sie ignoriert. Geben Sie jeden Dateipfad in einer neuen Zeile an.

dockerComposeFileArgs - Umgebungsvariablen
string.

Umgebungsvariablen, die während des Befehls festgelegt werden sollen. Geben Sie jedes Name=Wert-Paar in einer neuen Zeile an.

projectName - Projektname
string. Standardwert: $(Build.Repository.Name).

Der Projektname wird für die Standardbenennung von Images und Containern verwendet.

qualifyImageNames - Qualifizieren von Bildnamen
boolean. Standardwert: true.

Qualifizieren Sie Imagenamen für erstellte Dienste mit dem Hostnamen der Docker-Registrierungsdienstverbindung, wenn nicht anders angegeben.

action - Aktion
string. Erforderlich. Zulässige Werte: Build services (Builddienstimages), Push services (Pushdienstimages), Run services (Dienstimages ausführen), Run a specific service (Ausführen eines bestimmten Dienstimages), Lock services (Sperrdienstimages), Write service image digests, Combine configuration, Run a Docker Compose command. Standardwert: Run a Docker Compose command.

Wählen Sie eine Docker Compose-Aktion aus.

additionalImageTags - zusätzliche Bildtags
string. Wahlfrei. Wird verwendet, wenn action = Build services || action = Push services.

Zusätzliche Tags für die Docker-Images, die erstellt oder gepusht werden.

includeSourceTags - Source Tags einschließen
boolean. Wahlfrei. Wird verwendet, wenn action = Build services || action = Push services. Standardwert: false.

Schließen Sie Git-Tags ein, wenn Sie Docker-Images erstellen oder pushen.

includeLatestTag - Neuesten Tag- einschließen
boolean. Wahlfrei. Wird verwendet, wenn action = Build services || action = Push services. Standardwert: false.

Fügen Sie das "latest"-Tag ein, wenn Sie Docker-Images erstellen oder pushen.

buildImages - Erstellen von Images
boolean. Wahlfrei. Wird verwendet, wenn action = Run services. Standardwert: true.

Erstellen Sie Images, bevor Sie Dienstcontainer starten.

serviceName - Dienstname
string. Erforderlich, wenn action = Run a specific service.

Name des spezifischen Diensts, der ausgeführt werden soll.

containerName - Containername
string. Wahlfrei. Wird verwendet, wenn action = Run a specific service.

Name des spezifischen Dienstcontainers, der ausgeführt werden soll.

ports - Häfen
string. Wahlfrei. Wird verwendet, wenn action = Run a specific service.

Ports im jeweiligen Dienstcontainer, die auf dem Host veröffentlicht werden sollen. Geben Sie jede host-port:container-port-Bindung in einer neuen Zeile an.

workingDirectory - Arbeitsverzeichnis-
Eingabealias: workDir. string. Wahlfrei. Wird verwendet, wenn action = Run a specific service.

Das Arbeitsverzeichnis für den jeweiligen Dienstcontainer.

entrypoint - Eintragspunktüberschreibung
string. Wahlfrei. Wird verwendet, wenn action = Run a specific service.

Überschreiben Sie den Standardeinstiegspunkt für den jeweiligen Dienstcontainer.

containerCommand - Befehl
string. Wahlfrei. Wird verwendet, wenn action = Run a specific service.

Befehl, der im jeweiligen Dienstcontainer ausgeführt werden soll. Wenn das Image beispielsweise eine einfache Python-Flask-Webanwendung enthält, können Sie "python app.py" angeben, um die Webanwendung zu starten.

detached - im Hintergrund ausführen
boolean. Wahlfrei. Wird verwendet, wenn action = Run services || action = Run a specific service. Standardwert: true.

Führen Sie die Dienstcontainer im Hintergrund aus.

abortOnContainerExit - beim Beenden von Containern abbrechen
boolean. Wahlfrei. Wird verwendet, wenn action = Run services && detached == false. Standardwert: true.

Stoppen Sie alle Container, wenn ein Container beendet wird.

imageDigestComposeFile - Bilddigest-Erstelldatei
string. Erforderlich, wenn action = Write service image digests. Standardwert: $(Build.StagingDirectory)/docker-compose.images.yml.

Pfad zu einer Docker Compose-Datei, die erstellt und mit den vollständigen Image-Repository-Digests der Docker-Images der einzelnen Dienste gefüllt wird.

removeBuildOptions - Buildoptionen entfernen
boolean. Wahlfrei. Wird verwendet, wenn action = Lock services || action = Combine configuration. Standardwert: false.

Entfernen Sie die Buildoptionen aus der Ausgabedatei Docker Compose.

baseResolveDirectory - Base Resolve Directory-
string. Wahlfrei. Wird verwendet, wenn action = Lock services || action = Combine configuration.

Das Basisverzeichnis, aus dem relative Pfade in der Docker Compose-Ausgabedatei aufgelöst werden sollen.

outputDockerComposeFile - Ausgabe-Docker-Verfassendatei
string. Erforderlich, wenn action = Lock services || action = Combine configuration. Standardwert: $(Build.StagingDirectory)/docker-compose.yml.

Pfad zu einer Docker Compose-Ausgabedatei.

dockerComposeCommand - Befehl
string. Erforderlich, wenn action = Run a Docker Compose command.

Docker Compose-Befehl zum Ausführen mit Argumenten. Beispiel: 'rm --all', um alle gestoppten Dienstcontainer zu entfernen.

arguments - Argumente
string. Wahlfrei. Wird verwendet, wenn action != Lock services && action != Combine configuration && action != Write service image digests.

Optionen für den Befehl Docker Compose. Beispiel:
Für den build-Befehl
--pull --compress --parallel.

dockerHostEndpoint - Docker-Hostdienstverbindung
string.

Wählen Sie eine Docker-Hostdienstverbindung aus. Standardmäßig wird der Host des Agents verwendet.

nopIfNoDockerComposeFile - No-op, wenn keine Docker Compose File
boolean. Standardwert: false.

Wenn die Docker Compose-Datei nicht vorhanden ist, überspringen Sie diese Aufgabe. Dies ist nützlich, wenn die Aufgabe ein optionales Verhalten bietet, das auf dem Vorhandensein einer Docker Compose-Datei im Repository basiert.

requireAdditionalDockerComposeFiles - zusätzliche Docker Compose-Dateien
boolean. Standardwert: false.

Erzeugt einen Fehler, wenn die zusätzlichen Docker Compose-Dateien nicht vorhanden sind. Dadurch wird das Standardverhalten außer Kraft gesetzt, das darin besteht, eine Datei zu ignorieren, wenn sie nicht vorhanden ist.

currentWorkingDirectory - Arbeitsverzeichnis-
Eingabealias: cwd. string. Standardwert: $(System.DefaultWorkingDirectory).

Arbeitsverzeichnis für den Befehl Docker Compose.

dockerComposePath - ausführbaren Pfad zum Verfassen von Docker
string.

Diese ausführbare Datei docker-compose wird verwendet, wenn der Pfad angegeben wird.

Diese Aufgabe definiert die folgenden Ausgabevariablen, die Sie in nachgelagerten Schritten, Aufträgen und Phasen nutzen können.

DockerComposeOutput
Der Pfad der Datei(en), die die Ausgabe des Befehls enthält. Dies kann mehrere Dateipfade (getrennt durch Zeilenumbrüche) enthalten, wenn der Befehl dockerComposeRun (einer zum Ausführen und einer zum Herunterfahren), dockerPush (einer für jedes gepushte Image), dockerBuild (der Build selbst und alle Tag-Befehle) und dockerDigest (einer für jedes abgerufene Image) verwendet werden. Die anderen Befehle geben nur eine Datei aus.