Dela via


Docker@0 – Docker v0-uppgift

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

Anteckning

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

Syntax

# Docker v0
# Build, tag, push, or run Docker images, or run a Docker command.
- task: Docker@0
  inputs:
    containerregistrytype: 'Azure Container Registry' # 'Azure Container Registry' | 'Container Registry'. Required. Container Registry Type. Default: Azure Container Registry.
    #dockerRegistryConnection: # string. Alias: dockerRegistryEndpoint. 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. 
    action: 'Build an image' # 'Build an image' | 'Tag images' | 'Push an image' | 'Push images' | 'Run an image' | 'Run a Docker command'. Required. Action. Default: Build an image.
    #dockerFile: '**/Dockerfile' # string. Required when action = Build an image. Docker File. Default: **/Dockerfile.
    #buildArguments: # string. Optional. Use when action = Build an image. Build Arguments. 
    #defaultContext: true # boolean. Optional. Use when action = Build an image. Use Default Build Context. Default: true.
    #context: # string. Optional. Use when action = Build an image && defaultContext = false. Build Context. 
    #imageName: '$(Build.Repository.Name):$(Build.BuildId)' # string. Required when action == Build an image || action == Push an image || action == Run an image. Image Name. Default: $(Build.Repository.Name):$(Build.BuildId).
    #imageNamesPath: # string. Required when action == Tag images || action == Push images. Image Names Path. 
    #qualifyImageName: true # boolean. Optional. Use when action = Build an image || action = Tag images || action = Push an image || action = Push images || action = Run an image. Qualify Image Name. Default: true.
    #additionalImageTags: # string. Optional. Use when action = Build an image || action = Tag images || action = Push an image || action = Push images. Additional Image Tags. 
    #includeSourceTags: false # boolean. Optional. Use when action = Build an image || action = Tag image || action = Push an image || action = Push images. Include Source Tags. Default: false.
    #includeLatestTag: false # boolean. Optional. Use when action = Build an image || action = Push an image || action = Push images. Include Latest Tag. Default: false.
    #imageDigestFile: # string. Optional. Use when action = Push an image || action = Push images. Image Digest File. 
    #containerName: # string. Optional. Use when action = Run an image. Container Name. 
    #ports: # string. Optional. Use when action = Run an image. Ports. 
    #volumes: # string. Optional. Use when action = Run an image. Volumes. 
    #envVars: # string. Optional. Use when action = Run an image. Environment Variables. 
    #workDir: # string. Optional. Use when action = Run an image. Working Directory. 
    #entrypoint: # string. Optional. Use when action = Run an image. Entry Point Override. 
    #containerCommand: # string. Optional. Use when action = Run an image. Command. 
    #detached: true # boolean. Optional. Use when action = Run an image. Run In Background. Default: true.
    #restartPolicy: 'no' # 'no' | 'onFailure' | 'always' | 'unlessStopped'. Required when action = Run an image && detached = true. Restart Policy. Default: no.
    #restartMaxRetries: # string. Optional. Use when action = Run an image && detached = true && restartPolicy = onFailure. Maximum Restart Retries. 
    #customCommand: # string. Required when action = Run a Docker command. Command. 
  # commands
    #addBaseImageData: true # boolean. Add base image metadata to image(s). Default: true.
  # Advanced Options
    #dockerHostEndpoint: # string. Docker Host Service Connection. 
    #enforceDockerNamingConvention: true # boolean. Force image name to follow Docker naming convention. Default: true.
    #workingDirectory: '$(System.DefaultWorkingDirectory)' # string. Alias: cwd. Working Directory. Default: $(System.DefaultWorkingDirectory).
    #memory: # string. Memory limit.
# Docker v0
# Build, tag, push, or run Docker images, or run a Docker command.
- task: Docker@0
  inputs:
    containerregistrytype: 'Azure Container Registry' # 'Azure Container Registry' | 'Container Registry'. Required. Container Registry Type. Default: Azure Container Registry.
    #dockerRegistryConnection: # string. Alias: dockerRegistryEndpoint. 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. 
    action: 'Build an image' # 'Build an image' | 'Tag images' | 'Push an image' | 'Push images' | 'Run an image' | 'Run a Docker command'. Required. Action. Default: Build an image.
    #dockerFile: '**/Dockerfile' # string. Required when action = Build an image. Docker File. Default: **/Dockerfile.
    #buildArguments: # string. Optional. Use when action = Build an image. Build Arguments. 
    #defaultContext: true # boolean. Optional. Use when action = Build an image. Use Default Build Context. Default: true.
    #context: # string. Optional. Use when action = Build an image && defaultContext = false. Build Context. 
    #imageName: '$(Build.Repository.Name):$(Build.BuildId)' # string. Required when action == Build an image || action == Push an image || action == Run an image. Image Name. Default: $(Build.Repository.Name):$(Build.BuildId).
    #imageNamesPath: # string. Required when action == Tag images || action == Push images. Image Names Path. 
    #qualifyImageName: true # boolean. Optional. Use when action = Build an image || action = Tag images || action = Push an image || action = Push images || action = Run an image. Qualify Image Name. Default: true.
    #additionalImageTags: # string. Optional. Use when action = Build an image || action = Tag images || action = Push an image || action = Push images. Additional Image Tags. 
    #includeSourceTags: false # boolean. Optional. Use when action = Build an image || action = Tag image || action = Push an image || action = Push images. Include Source Tags. Default: false.
    #includeLatestTag: false # boolean. Optional. Use when action = Build an image || action = Push an image || action = Push images. Include Latest Tag. Default: false.
    #imageDigestFile: # string. Optional. Use when action = Push an image || action = Push images. Image Digest File. 
    #containerName: # string. Optional. Use when action = Run an image. Container Name. 
    #ports: # string. Optional. Use when action = Run an image. Ports. 
    #volumes: # string. Optional. Use when action = Run an image. Volumes. 
    #envVars: # string. Optional. Use when action = Run an image. Environment Variables. 
    #workDir: # string. Optional. Use when action = Run an image. Working Directory. 
    #entrypoint: # string. Optional. Use when action = Run an image. Entry Point Override. 
    #containerCommand: # string. Optional. Use when action = Run an image. Command. 
    #detached: true # boolean. Optional. Use when action = Run an image. Run In Background. Default: true.
    #restartPolicy: 'no' # 'no' | 'onFailure' | 'always' | 'unlessStopped'. Required when action = Run an image && detached = true. Restart Policy. Default: no.
    #restartMaxRetries: # string. Optional. Use when action = Run an image && detached = true && restartPolicy = onFailure. Maximum Restart Retries. 
    #customCommand: # string. Required when action = Run a Docker command. Command. 
  # Advanced Options
    #dockerHostEndpoint: # string. Docker Host Service Connection. 
    #enforceDockerNamingConvention: true # boolean. Force image name to follow Docker naming convention. Default: true.
    #workingDirectory: '$(System.DefaultWorkingDirectory)' # string. Alias: cwd. Working Directory. Default: $(System.DefaultWorkingDirectory).
    #memory: # string. Memory limit.
# Docker v0
# Build, tag, push, or run Docker images, or run a Docker command. Task can be used with Docker or Azure Container registry.
- task: Docker@0
  inputs:
    containerregistrytype: 'Azure Container Registry' # 'Azure Container Registry' | 'Container Registry'. Required. Container Registry Type. Default: Azure Container Registry.
    #dockerRegistryConnection: # string. Alias: dockerRegistryEndpoint. 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. 
    action: 'Build an image' # 'Build an image' | 'Tag images' | 'Push an image' | 'Push images' | 'Run an image' | 'Run a Docker command'. Required. Action. Default: Build an image.
    #dockerFile: '**/Dockerfile' # string. Required when action = Build an image. Docker File. Default: **/Dockerfile.
    #buildArguments: # string. Optional. Use when action = Build an image. Build Arguments. 
    #defaultContext: true # boolean. Optional. Use when action = Build an image. Use Default Build Context. Default: true.
    #context: # string. Optional. Use when action = Build an image && defaultContext = false. Build Context. 
    #imageName: '$(Build.Repository.Name):$(Build.BuildId)' # string. Required when action == Build an image || action == Push an image || action == Run an image. Image Name. Default: $(Build.Repository.Name):$(Build.BuildId).
    #imageNamesPath: # string. Required when action == Tag images || action == Push images. Image Names Path. 
    #qualifyImageName: true # boolean. Optional. Use when action = Build an image || action = Tag images || action = Push an image || action = Push images || action = Run an image. Qualify Image Name. Default: true.
    #additionalImageTags: # string. Optional. Use when action = Build an image || action = Tag images || action = Push an image || action = Push images. Additional Image Tags. 
    #includeSourceTags: false # boolean. Optional. Use when action = Build an image || action = Tag image || action = Push an image || action = Push images. Include Source Tags. Default: false.
    #includeLatestTag: false # boolean. Optional. Use when action = Build an image || action = Push an image || action = Push images. Include Latest Tag. Default: false.
    #imageDigestFile: # string. Optional. Use when action = Push an image || action = Push images. Image Digest File. 
    #containerName: # string. Optional. Use when action = Run an image. Container Name. 
    #ports: # string. Optional. Use when action = Run an image. Ports. 
    #volumes: # string. Optional. Use when action = Run an image. Volumes. 
    #envVars: # string. Optional. Use when action = Run an image. Environment Variables. 
    #workDir: # string. Optional. Use when action = Run an image. Working Directory. 
    #entrypoint: # string. Optional. Use when action = Run an image. Entry Point Override. 
    #containerCommand: # string. Optional. Use when action = Run an image. Command. 
    #detached: true # boolean. Optional. Use when action = Run an image. Run In Background. Default: true.
    #restartPolicy: 'no' # 'no' | 'onFailure' | 'always' | 'unlessStopped'. Required when action = Run an image && detached = true. Restart Policy. Default: no.
    #restartMaxRetries: # string. Optional. Use when action = Run an image && detached = true && restartPolicy = onFailure. Maximum Restart Retries. 
    #customCommand: # string. Required when action = Run a Docker command. Command. 
  # Advanced Options
    #dockerHostEndpoint: # string. Docker Host Service Connection. 
    #enforceDockerNamingConvention: true # boolean. Force image name to follow Docker naming convention. Default: true.
    #workingDirectory: '$(System.DefaultWorkingDirectory)' # string. Alias: cwd. Working Directory. Default: $(System.DefaultWorkingDirectory).
    #memory: # string. Memory limit.

Indata

containerregistrytype - Containerregistertyp
string. Krävs. Tillåtna värden: Azure Container Registry, Container Registry. Standardvärde: Azure Container Registry.

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


dockerRegistryConnection - Docker Registry Service-anslutning
Indataalias: dockerRegistryEndpoint. string. Valfritt. Använd när containerregistrytype = Container Registry.

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

Anger en Azure-prenumeration.


azureContainerRegistry - Azure Container Registry
string. Valfritt. Använd när containerregistrytype = Azure Container Registry.

Anger en Azure Container Registry i den valda Azure-prenumerationen. Containeravbildningen skapas och push-överförs sedan till det här containerregistret.


action - Åtgärder
string. Krävs. Tillåtna värden: Build an image, Tag images, Push an image, Push images, Run an image, Run a Docker command. Standardvärde: Build an image.

Anger en Docker-åtgärd.


dockerFile - Docker-fil
string. Krävs när action = Build an image. Standardvärde: **/Dockerfile.

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


addBaseImageData - Lägga till basavbildningsmetadata i avbildningar
boolean. Standardvärde: true.

Standardvärdet lägger till basavbildningsdata som basavbildningens namn och sammandrag för att hjälpa till med spårning. Du kan avregistrera dig genom att ange värdet till false.


buildArguments - Skapa argument
string. Valfritt. Använd när action = Build an image.

Anger byggtidsvariabler för Docker-filen. Formatera varje name=value par på en ny rad.


defaultContext - Använd standardkontext för bygge
boolean. Valfritt. Använd när action = Build an image. Standardvärde: true.

Anger byggkontexten för katalogen som innehåller Docker-filen.


context - Skapa kontext
string. Valfritt. Använd när action = Build an image && defaultContext = false.

Anger sökvägen till byggkontexten.


imageName - Avbildningsnamn
string. Krävs när action == Build an image || action == Push an image || action == Run an image. Standardvärde: $(Build.Repository.Name):$(Build.BuildId).

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


imageNamesPath - Sökväg till bildnamn
string. Krävs när action == Tag images || action == Push images.

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


qualifyImageName - Namn på kvalificera avbildning
boolean. Valfritt. Använd när action = Build an image || action = Tag images || action = Push an image || action = Push images || action = Run an image. Standardvärde: true.

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


additionalImageTags - Ytterligare avbildningstaggar
string. Valfritt. Använd när action = Build an image || action = Tag images || action = Push an image || action = Push images.

Anger ytterligare taggar för Den Docker-avbildning som skapas eller push-överförs.


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

Anger om Du vill inkludera Git-taggar när du skapar eller push-överför Docker-avbildningen.


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

Anger om du vill inkludera den senaste taggen när du skapar eller push-överför Docker-avbildningen.


imageDigestFile - Bildsammandragsfil
string. Valfritt. Använd när action = Push an image || action = Push images.

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


containerName - Containernamn
string. Valfritt. Använd när action = Run an image.

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


ports - Portar
string. Valfritt. Använd när action = Run an image.

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


volumes - Volymer
string. Valfritt. Använd när action = Run an image.

Anger de volymer som ska monteras från värden. Visa var och host-dir:container-dir en på en ny rad.


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

Anger miljövariabler för Docker-containern. Lista varje name=value par på en ny rad.


workDir - Arbetskatalog
string. Valfritt. Använd när action = Run an image.

Anger arbetskatalogen för Docker-containern.


entrypoint - Åsidosättning av startpunkt
string. Valfritt. Använd när action = Run an image.

Anger en åsidosättning av standardinmatningspunkten för Docker-containern.


containerCommand - Kommandot
string. Valfritt. Använd när action = Run an image.

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.


detached - Kör i bakgrunden
boolean. Valfritt. Använd när action = Run an image. Standardvärde: true.

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


restartPolicy - Starta om princip
string. Krävs när action = Run an image && detached = true. Tillåtna värden: no, onFailure (Vid fel), always, unlessStopped (om det inte har stoppats). Standardvärde: no.

Anger en omstartsprincip.


restartMaxRetries - Maximalt antal återförsök vid omstart
string. Valfritt. Använd när action = Run an image && detached = true && restartPolicy = onFailure.

Anger det maximala antalet omstartsförsök som Docker-daemon försöker utföra.


customCommand - Kommandot
string. Krävs när action = Run a Docker command.

Anger det Docker-kommando och argument som ska köras. Tar till exempel rmi -f image-name bort en bild.


dockerHostEndpoint - Docker-värdtjänstanslutning
string.

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


enforceDockerNamingConvention - Tvinga avbildningsnamnet att följa Docker-namngivningskonventionen
boolean. Standardvärde: true.

Om det är aktiverat ändrar du Docker-avbildningsnamnet enligt Docker-namngivningskonventioner. Konvertera till exempel versaler till gemener och ta bort blanksteg.


workingDirectory - Arbetskatalog
Indataalias: cwd. string. Standardvärde: $(System.DefaultWorkingDirectory).

Anger arbetskatalogen för Docker-kommandot.


memory - Minnesgräns
string.

Anger den maximala mängden minne som är tillgängligt för containern som ett heltal med valfria suffix, till exempel 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 byggkommandot.

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

DockerOutput
Lagrar utdata för docker-kommandot

Kommentarer

Docker@2 är en nyare version av den här uppgiften som förenklar uppgiften 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
Krav Ingen
Funktioner Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet.
Kommandobegränsningar Valfri
Inställningsbara variabler Valfri
Agentversion Alla agentversioner som stöds.
Uppgiftskategori Build

Se även