Anteckning
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
Skapa, push-överföra eller köra Docker-program med flera containrar. Uppgiften kan användas med Docker eller Azure Container Registry.
Syntax
# 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.
Ingångar
containerregistrytype
-
containerregistertyp
string. Obligatoriskt. Tillåtna värden: Azure Container Registry, Container Registry. Standardvärde: Azure Container Registry.
Välj en typ av containerregister.
dockerRegistryEndpoint
-
Anslutning till Docker-registertjänsten
string. Valfritt. Använd när containerregistrytype = Container Registry.
Välj en Docker-registertjänstanslutning. Krävs för kommandon som behöver autentiseras med ett register.
azureSubscription
-
Azure-prenumeration
Indataalias: azureSubscriptionEndpoint.
string. Valfritt. Använd när containerregistrytype = Azure Container Registry.
Välj en Azure-prenumeration.
azureContainerRegistry
-
Azure Container Registry
string. Valfritt. Använd när containerregistrytype = Azure Container Registry.
Välj en Azure Container Registry.
dockerComposeFile
-
Docker Compose-fil
string. Obligatoriskt. Standardvärde: **/docker-compose.yml.
Sökväg till den primära Docker Compose-filen som ska användas.
additionalDockerComposeFiles
-
ytterligare Docker Compose-filer
string.
Ytterligare Docker Compose-filer som ska kombineras med den primära Docker Compose-filen. Relativa sökvägar matchas i förhållande till katalogen som innehåller den primära Docker Compose-filen. Om en angiven fil inte hittas ignoreras den. Ange varje filsökväg på en ny rad.
dockerComposeFileArgs
-
miljövariabler
string.
Miljövariabler som ska ställas in under kommandot. Ange varje name=value-par på en ny rad.
projectName
-
projektnamn
string. Standardvärde: $(Build.Repository.Name).
Projektnamn som används för standardnamngivning av avbildningar och containrar.
qualifyImageNames
-
Kvalificera bildnamn
boolean. Standardvärde: true.
Kvalificera avbildningsnamn för skapade tjänster med Docker-registertjänstanslutningens värdnamn om inget annat anges.
action
-
åtgärd
string. Obligatoriskt. Tillåtna värden: Build services (Skapa tjänstbilder), Push services (Push-tjänstbilder), Run services (Kör tjänstbilder), Run a specific service (Kör en specifik tjänstbild), Lock services (Lås tjänstbilder), Write service image digests, Combine configuration, Run a Docker Compose command. Standardvärde: Run a Docker Compose command.
Välj en Docker Compose-åtgärd.
additionalImageTags
-
ytterligare
string. Valfritt. Använd när action = Build services || action = Push services.
Ytterligare taggar för Docker-avbildningar som skapas eller push-överförs.
includeSourceTags
-
ta med källtaggar
boolean. Valfritt. Använd när action = Build services || action = Push services. Standardvärde: false.
Inkludera Git-taggar när du skapar eller push-överför Docker-avbildningar.
includeLatestTag
-
ta med senaste taggen
boolean. Valfritt. Använd när action = Build services || action = Push services. Standardvärde: false.
Inkludera taggen "senaste" när du skapar eller push-överför Docker-avbildningar.
buildImages
-
Skapa avbildningar
boolean. Valfritt. Använd när action = Run services. Standardvärde: true.
Skapa avbildningar innan du startar tjänstcontainrar.
serviceName
-
tjänstnamn
string. Krävs när action = Run a specific service.
Namnet på den specifika tjänst som ska köras.
containerName
-
containernamn
string. Valfritt. Använd när action = Run a specific service.
Namnet på den specifika tjänstcontainern som ska köras.
ports
-
portar
string. Valfritt. Använd när action = Run a specific service.
Portar i den specifika tjänstcontainern som ska publiceras till värden. Ange varje bindning av host-port:container-port på en ny rad.
workingDirectory
-
Arbetskatalog
Indataalias: workDir.
string. Valfritt. Använd när action = Run a specific service.
Arbetskatalogen för den specifika tjänstcontainern.
entrypoint
-
åsidosättning av startpunkt
string. Valfritt. Använd när action = Run a specific service.
Åsidosätt standardstartpunkten för den specifika tjänstcontainern.
containerCommand
-
kommando
string. Valfritt. Använd när action = Run a specific service.
Kommando för att köra i den specifika tjänstcontainern. Om avbildningen till exempel innehåller ett enkelt Python Flask-webbprogram kan du ange "python app.py" för att starta webbappen.
detached
-
kör i bakgrunden
boolean. Valfritt. Använd när action = Run services || action = Run a specific service. Standardvärde: true.
Kör tjänstcontainrarna i bakgrunden.
abortOnContainerExit
-
Avbryt vid
boolean. Valfritt. Använd när action = Run services && detached == false. Standardvärde: true.
Stoppa alla containrar när en container avslutas.
imageDigestComposeFile
-
string. Krävs när action = Write service image digests. Standardvärde: $(Build.StagingDirectory)/docker-compose.images.yml.
Sökväg till en Docker Compose-fil som skapas och fylls i med de fullständiga avbildningslagringsplatsens sammanfattningar av varje tjänsts Docker-avbildning.
removeBuildOptions
-
Ta bort build-alternativ
boolean. Valfritt. Använd när action = Lock services || action = Combine configuration. Standardvärde: false.
Ta bort byggalternativen från Docker Compose-utdatafilen.
baseResolveDirectory
-
Grundläggande upplösningskatalog
string. Valfritt. Använd när action = Lock services || action = Combine configuration.
Baskatalogen från vilken relativa sökvägar i Docker Compose-utdatafilen ska matchas.
outputDockerComposeFile
-
Docker Compose-fil för utdata
string. Krävs när action = Lock services || action = Combine configuration. Standardvärde: $(Build.StagingDirectory)/docker-compose.yml.
Sökväg till en Docker Compose-utdatafil.
dockerComposeCommand
-
kommando
string. Krävs när action = Run a Docker Compose command.
Docker Compose kommando för att köra med argument. Till exempel "rm --all" för att ta bort alla stoppade tjänstcontainrar.
arguments
-
argument
string. Valfritt. Använd när action != Lock services && action != Combine configuration && action != Write service image digests.
Kommandoalternativ för Docker Compose. Exempel:
För build-kommandot,
--dra --komprimera --parallell.
dockerHostEndpoint
-
Docker-värdtjänstanslutning
string.
Välj en Docker-värdtjänstanslutning. Standardvärdet är agentens värd.
nopIfNoDockerComposeFile
-
no-op om ingen Docker Compose-fil
boolean. Standardvärde: false.
Om Docker Compose-filen inte finns hoppar du över den här uppgiften. Detta är användbart när aktiviteten erbjuder valfritt beteende baserat på att det finns en Docker Compose-fil på lagringsplatsen.
requireAdditionalDockerComposeFiles
-
Kräv ytterligare Docker Compose-filer
boolean. Standardvärde: false.
Skapar ett fel om de ytterligare Docker Compose-filerna inte finns. Detta åsidosätter standardbeteendet, vilket är att ignorera en fil om den inte finns.
currentWorkingDirectory
-
Arbetskatalog
Indataalias: cwd.
string. Standardvärde: $(System.DefaultWorkingDirectory).
Arbetskatalog för kommandot Docker Compose.
dockerComposePath
-
Körbar sökväg för Docker Compose
string.
Den här docker-compose körbara filen används om sökvägen anges.
Alternativ för uppgiftskontroll
Alla aktiviteter har kontrollalternativ utöver sina aktivitetsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.
Utdatavariabler
Den här uppgiften definierar följande utdatavariabler, som du kan använda i underordnade steg, jobb och steg.
DockerComposeOutput
Sökvägen till de filer som innehåller kommandots utdata. Detta kan innehålla flera filsökvägar (avgränsade med radbrytningstecken) vid dockerComposeRun-kommando (ett för att köra och ett för ned), dockerPush (en för varje bild som pushas), dockerBuild (själva bygget och alla taggkommandon) och dockerDigest (en för varje bild som hämtas). De andra kommandona matar bara ut en fil.
Kravspecifikation
| Krav | Beskrivning |
|---|---|
| Pipelinetyper | YAML, klassisk version, klassisk version |
| Körs på | Agent, DeploymentGroup |
| Krav | Ingen |
| Kapaciteter | Den här aktiviteten uppfyller inte några krav på efterföljande uppgifter i jobbet. |
| Kommandobegränsningar | Vilken som helst |
| variabler som kan | Vilken som helst |
| Agentversion | Alla agentversioner som stöds. |
| Aktivitetskategori | Skapa |