Dela via


Docker@1 – Docker v1-uppgift

Skapa, tagga, pusha eller kör Docker-avbildningar eller kör ett Docker-kommando. Använd den här uppgiften med Docker eller Azure Container Registry.

Anmärkning

Docker@2 är en nyare version av den här uppgiften som förenklar aktiviteten genom att ta bort indata som kan skickas som argument till kommandot.

Syntax

# Docker v1
# Build, tag, push, or run Docker images, or run a Docker command.
- task: Docker@1
  inputs:
  # Container Registry
    #containerregistrytype: 'Azure Container Registry' # 'Azure Container Registry' | 'Container Registry'. Required when command != logout. Container registry type. Default: Azure Container Registry.
    #dockerRegistryEndpoint: # string. Optional. Use when containerregistrytype = Container Registry && command != logout. Docker registry service connection. 
    #azureSubscriptionEndpoint: # string. Optional. Use when containerregistrytype = Azure Container Registry && command != logout. Azure subscription. 
    #azureContainerRegistry: # string. Optional. Use when containerregistrytype = Azure Container Registry && command != logout. Azure container registry. 
  # Commands
    #addBaseImageData: true # boolean. Add base image metadata to image(s). Default: true.
    command: 'Build an image' # 'Build an image' | 'Tag image' | 'Push an image' | 'Run an image' | 'login' | 'logout'. Required. Command. Default: Build an image.
    #dockerFile: '**/Dockerfile' # string. Required when command = Build an image || command = build. Dockerfile. Default: **/Dockerfile.
    #arguments: # string. Optional. Use when command != login && command != logout. Arguments. 
    #pushMultipleImages: false # boolean. Optional. Use when command = Push an image || command = push. Push multiple images. Default: false.
    #tagMultipleImages: false # boolean. Optional. Use when command = Tag image || command = tag. Tag multiple images. Default: false.
    #imageName: '$(Build.Repository.Name):$(Build.BuildId)' # string. Required when command = Build an image || command = build || command = Run an image || command = run || pushMultipleImages = false || tagMultipleImages = false. Image name. Default: $(Build.Repository.Name):$(Build.BuildId).
    #imageNamesPath: # string. Required when tagMultipleImages = true || pushMultipleImages = true. Image names path. 
    #qualifyImageName: true # boolean. Optional. Use when command = Build an image || command = build || command = Tag image || command = tag || command = Push an image || command = push || command = Run an image || command = run. Qualify image name. Default: true.
    #qualifySourceImageName: false # boolean. Optional. Use when command = Tag image || command = tag. Qualify source image name. Default: false.
    #includeSourceTags: false # boolean. Optional. Use when command = Build an image || command = build || command = Tag image || command = tag  || command = Push an image || command = push. Include source tags. Default: false.
    #includeLatestTag: false # boolean. Optional. Use when command = Build an image || command = build. Include latest tag. Default: false.
    #addDefaultLabels: true # boolean. Optional. Use when addDefaultLabels = false. Add default labels. Default: true.
    #useDefaultContext: true # boolean. Optional. Use when command = Build an image || command = build. Use default build context. Default: true.
    #buildContext: # string. Optional. Use when useDefaultContext = false. Build context. 
    #imageDigestFile: # string. Optional. Use when command = Push an image || command = push. Image digest file. 
    #containerName: # string. Optional. Use when command = Run an image || command = run. Container name. 
    #ports: # string. Optional. Use when command = Run an image || command = run. Ports. 
    #volumes: # string. Optional. Use when command = Run an image || command = run. Volumes. 
    #envVars: # string. Optional. Use when command = Run an image || command = run. Environment variables. 
    #workingDirectory: # string. Optional. Use when command = Run an image || command = run. Working directory. 
    #entrypointOverride: # string. Optional. Use when command = Run an image || command = run. Entry point override. 
    #containerCommand: # string. Optional. Use when command = Run an image || command = run. Container command. 
    #runInBackground: true # boolean. Optional. Use when command = Run an image || command = run. Run in background. Default: true.
    restartPolicy: 'no' # 'no' | 'onFailure' | 'always' | 'unlessStopped'. Required when runInBackground = true. Restart policy. Default: no.
    #maxRestartRetries: # string. Optional. Use when runInBackground = true && restartPolicy = onFailure. Maximum restart retries. 
  # Advanced Options
    #dockerHostEndpoint: # string. Optional. Use when command != login && command != logout. Docker host service connection. 
    #enforceDockerNamingConvention: true # boolean. Optional. Use when command != login && command != logout. Force image name to follow Docker naming convention. Default: true.
    #memoryLimit: # string. Optional. Use when command != login && command != logout. Memory limit.
# Docker v1
# Build, tag, push, or run Docker images, or run a Docker command.
- task: Docker@1
  inputs:
  # Container Registry
    #containerregistrytype: 'Azure Container Registry' # 'Azure Container Registry' | 'Container Registry'. Required when command != logout. Container registry type. Default: Azure Container Registry.
    #dockerRegistryEndpoint: # string. Optional. Use when containerregistrytype = Container Registry && command != logout. Docker registry service connection. 
    #azureSubscriptionEndpoint: # string. Optional. Use when containerregistrytype = Azure Container Registry && command != logout. Azure subscription. 
    #azureContainerRegistry: # string. Optional. Use when containerregistrytype = Azure Container Registry && command != logout. Azure container registry. 
  # Commands
    command: 'Build an image' # 'Build an image' | 'Tag image' | 'Push an image' | 'Run an image' | 'login' | 'logout'. Required. Command. Default: Build an image.
    #dockerFile: '**/Dockerfile' # string. Required when command = Build an image || command = build. Dockerfile. Default: **/Dockerfile.
    #arguments: # string. Optional. Use when command != login && command != logout. Arguments. 
    #pushMultipleImages: false # boolean. Optional. Use when command = Push an image || command = push. Push multiple images. Default: false.
    #tagMultipleImages: false # boolean. Optional. Use when command = Tag image || command = tag. Tag multiple images. Default: false.
    #imageName: '$(Build.Repository.Name):$(Build.BuildId)' # string. Required when command = Build an image || command = build || command = Run an image || command = run || pushMultipleImages = false || tagMultipleImages = false. Image name. Default: $(Build.Repository.Name):$(Build.BuildId).
    #imageNamesPath: # string. Required when tagMultipleImages = true || pushMultipleImages = true. Image names path. 
    #qualifyImageName: true # boolean. Optional. Use when command = Build an image || command = build || command = Tag image || command = tag || command = Push an image || command = push || command = Run an image || command = run. Qualify image name. Default: true.
    #qualifySourceImageName: false # boolean. Optional. Use when command = Tag image || command = tag. Qualify source image name. Default: false.
    #includeSourceTags: false # boolean. Optional. Use when command = Build an image || command = build || command = Tag image || command = tag  || command = Push an image || command = push. Include source tags. Default: false.
    #includeLatestTag: false # boolean. Optional. Use when command = Build an image || command = build. Include latest tag. Default: false.
    #addDefaultLabels: true # boolean. Optional. Use when addDefaultLabels = false. Add default labels. Default: true.
    #useDefaultContext: true # boolean. Optional. Use when command = Build an image || command = build. Use default build context. Default: true.
    #buildContext: # string. Optional. Use when useDefaultContext = false. Build context. 
    #imageDigestFile: # string. Optional. Use when command = Push an image || command = push. Image digest file. 
    #containerName: # string. Optional. Use when command = Run an image || command = run. Container name. 
    #ports: # string. Optional. Use when command = Run an image || command = run. Ports. 
    #volumes: # string. Optional. Use when command = Run an image || command = run. Volumes. 
    #envVars: # string. Optional. Use when command = Run an image || command = run. Environment variables. 
    #workingDirectory: # string. Optional. Use when command = Run an image || command = run. Working directory. 
    #entrypointOverride: # string. Optional. Use when command = Run an image || command = run. Entry point override. 
    #containerCommand: # string. Optional. Use when command = Run an image || command = run. Container command. 
    #runInBackground: true # boolean. Optional. Use when command = Run an image || command = run. Run in background. Default: true.
    restartPolicy: 'no' # 'no' | 'onFailure' | 'always' | 'unlessStopped'. Required when runInBackground = true. Restart policy. Default: no.
    #maxRestartRetries: # string. Optional. Use when runInBackground = true && restartPolicy = onFailure. Maximum restart retries. 
  # Advanced Options
    #dockerHostEndpoint: # string. Optional. Use when command != login && command != logout. Docker host service connection. 
    #enforceDockerNamingConvention: true # boolean. Optional. Use when command != login && command != logout. Force image name to follow Docker naming convention. Default: true.
    #memoryLimit: # string. Optional. Use when command != login && command != logout. Memory limit.

Ingångar

containerregistrytype - containerregistertyp
string. Krävs när command != logout. Tillåtna värden: Azure Container Registry, Container Registry. Standardvärde: Azure Container Registry.

Anger att Azure Container Registry ska ansluta med hjälp av en Azure-tjänstanslutning. Välj ett Azure Container Registry för att ansluta till en Docker Hub eller något annat privat containerregister.


addBaseImageData - Lägg till basbildmetadata i bilder
boolean. Standardvärde: true.

Standardvärdet lägger till basavbildningsdata, till exempel basavbildningens namn och sammandrag, för att hjälpa till med spårning. Du kan avregistrera dig från det här standardbeteendet genom att ange det här värdet till false.


dockerRegistryEndpoint - Docker-registertjänstanslutning
string. Valfritt. Använd när containerregistrytype = Container Registry && command != logout.

Anger en Docker-registertjänstanslutning. Krävs för kommandon som autentiserar med hjälp av ett register.


azureSubscriptionEndpoint - Azure-prenumeration
string. Valfritt. Använd när containerregistrytype = Azure Container Registry && command != logout.

Anger en Azure-prenumeration.


azureContainerRegistry - Azure-containerregister
string. Valfritt. Använd när containerregistrytype = Azure Container Registry && command != logout.

Anger ett Azure Container Registry i den valda Azure-prenumerationen. Containeravbildningen skapas och skickas till det här containerregistret.


command - kommando
string. Obligatoriskt. Tillåtna värden: Build an image (build), Tag image (tagg), Push an image (push), Run an image (kör), login, logout. Standardvärde: Build an image.

Anger det docker-kommando som ska köras.


dockerFile - Dockerfile (på engelska)
string. Krävs när command = Build an image || command = build. Standardvärde: **/Dockerfile.

Anger sökvägen till Docker-filen. Uppgiften använder den första Docker-filen som den hittar för att skapa avbildningen.


arguments - argument
string. Valfritt. Använd när command != login && command != logout.

Anger ytterligare argument som ska skickas till docker-klienten. Om du använder värdet buildAndPush i kommandoparametern ignoreras egenskapen argument.


pushMultipleImages - Skicka flera bilder
boolean. Valfritt. Använd när command = Push an image || command = push. Standardvärde: false.

Anger en lista i en textfil med Docker-avbildningar som ska skickas. Visa en lista över varje bildnamn i formatet Imagename1:tag1 på en separat rad. Om du anger ett avbildningsnamn utan taggar, till exempel Imagename2, skickas alla taggar i Imagename2-containern.


tagMultipleImages - Tagga flera bilder
boolean. Valfritt. Använd när command = Tag image || command = tag. Standardvärde: false.

Anger en lista över flera bildtaggar och Docker-avbildningar som ska taggas i en textfil. Visa en lista över varje bildnamn i formatet Imagename1:tag1 på en separat rad. Bilder som visas utan tagg som Imagename2 taggas som senaste som standard.


imageName - Bildnamn
string. Krävs när command = Build an image || command = build || command = Run an image || command = run || pushMultipleImages = false || tagMultipleImages = false. Standardvärde: $(Build.Repository.Name):$(Build.BuildId).

Anger namnet på Docker-avbildningen som ska skapas, pushas eller köras.


sökväg imageNamesPath - Bildnamn
string. Krävs när tagMultipleImages = true || pushMultipleImages = true.

Anger sökvägen till en textfil som innehåller namnen på Docker-avbildningarna som ska taggas eller pushas. Visa en lista över varje bildnamn på en separat rad.


qualifyImageName - Kvalificera avbildningsnamn
boolean. Valfritt. Använd när command = Build an image || command = build || command = Tag image || command = tag || command = Push an image || command = push || command = Run an image || command = run. Standardvärde: true.

Anger ett kvalificerat avbildningsnamn med Docker-registertjänstanslutningens värdnamn.


qualifySourceImageName - Kvalificera källbildnamn
boolean. Valfritt. Använd när command = Tag image || command = tag. Standardvärde: false.

Anger ett kvalificerat avbildningsnamn med Docker-registertjänstanslutningens värdnamn.


includeSourceTags - Inkludera källtaggar
boolean. Valfritt. Använd när command = Build an image || command = build || command = Tag image || command = tag || command = Push an image || command = push. Standardvärde: false.

Anger Git-taggar som ska inkluderas när du skapar eller push-överför Docker-avbildningen.


includeLatestTag - Ta med den senaste taggen
boolean. Valfritt. Använd när command = Build an image || command = build. Standardvärde: false.

Anger om du vill använda taggen senaste när du skapar Docker-avbildningen.


addDefaultLabels - Lägg till standardetiketter
boolean. Valfritt. Använd när addDefaultLabels = false. Standardvärde: true.

Anger om du vill lägga till CI/CD-metadata i containeravbildningen med hjälp av Docker-etiketter, till exempel lagringsplats, incheckning, bygg- och versionsinformation.


useDefaultContext - Använd standardversionskontext
boolean. Valfritt. Använd när command = Build an image || command = build. Standardvärde: true.

Anger hur du lägger till eller tar bort byggkontexten i katalogen som innehåller Docker-filen.


buildContext - Skapa kontext
string. Valfritt. Använd när useDefaultContext = false.

Anger sökvägen till byggkontexten.


imageDigestFile - bildsammandragsfil
string. Valfritt. Använd när command = Push an image || command = push.

Anger sökvägen till en fil som skapas och fylls i med den fullständiga avbildningslagringsplatsens sammanfattning av Docker-avbildningen som push-överfördes.


containerName - Containernamn
string. Valfritt. Använd när command = Run an image || command = run.

Anger namnet på Docker-containern som ska köras.


ports - portar
string. Valfritt. Använd när command = Run an image || command = run.

Anger portarna i Docker-containern som ska publiceras på värden. Lista varje host-port:container-port bindning på en separat rad.


volumes - volymer
string. Valfritt. Använd när command = Run an image || command = run.

Anger de volymer som ska monteras från värden. Visa en lista över varje host-dir:container-dir på en separat rad.


envVars - Miljövariabler
string. Valfritt. Använd när command = Run an image || command = run.

Anger miljövariabler för Docker-containern. Visa en lista över varje name=value par på en separat rad.


workingDirectory - Arbetskatalog
string. Valfritt. Använd när command = Run an image || command = run.

Anger arbetskatalogen för Docker-containern.


entrypointOverride - åsidosättning av startpunkt
string. Valfritt. Använd när command = Run an image || command = run.

Anger om standardinmatningspunkten för Docker-containern ska åsidosättas.


containerCommand - containerkommando
string. Valfritt. Använd när command = Run an image || command = run.

Anger ett Docker-körningskommando. Kommandot docker run skapar först ett skrivbart containerlager över den angivna avbildningen och startar det sedan med hjälp av det angivna körningskommandot. Om avbildningen till exempel innehåller ett enkelt Python Flask-webbprogram kan du ange python app.py för att starta webbprogrammet.


runInBackground - Kör i bakgrunden
boolean. Valfritt. Använd när command = Run an image || command = run. Standardvärde: true.

Anger om Docker-containern ska köras i bakgrunden.


restartPolicy - Starta om princip
string. Krävs när runInBackground = true. Tillåtna värden: no, onFailure (vid fel), always, unlessStopped (om det inte har stoppats). Standardvärde: no.

Anger när en omstartsprincip ska köras.


maxRestartRetries - Maximalt antal omstartsförsök
string. Valfritt. Använd när runInBackground = true && restartPolicy = onFailure.

Anger det maximala antalet omstartsförsök som Docker-daemonförsöken ska utföra.


dockerHostEndpoint - Docker-värdtjänstanslutning
string. Valfritt. Använd när command != login && command != logout.

Anger en Docker-värdtjänstanslutning. Standardvärdet är agentens värd.


enforceDockerNamingConvention - Tvinga avbildningsnamnet att följa Docker-namngivningskonventionen
boolean. Valfritt. Använd när command != login && command != logout. Standardvärde: true.

Standardvärdet ändrar Docker-avbildningsnamnet enligt Docker-namngivningskonventionerna. Konvertera till exempel versaler till gemener och ta bort blanksteg.


memoryLimit - minnesgräns
string. Valfritt. Använd när command != login && command != logout.

Anger den maximala mängden minne som är tillgängligt för containern som ett heltal med valfria suffix som 2GB.


Kontrollalternativ för aktivitet

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.

DockerOutput
Lagrar utdata från docker-kommandot

DockerOutputPath
Sökvägen till filen som innehåller utdata från build-kommandot.

Den här uppgiften definierar följande utdatavariabler, som du kan använda i underordnade steg, jobb och steg.

DockerOutput
Lagrar utdata från docker-kommandot

Anmärkningar

Docker@2 är en nyare version av den här uppgiften som förenklar aktiviteten genom att ta bort indata som kan skickas som argument till kommandot.

Krav

Krav Beskrivning
Pipelinetyper YAML, klassisk version, klassisk version
Körs på Agent, DeploymentGroup
kräver Ingen
funktioner 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

Se även