Docker@0 - Docker v0-taak
Docker-installatiekopieën bouwen, taggen, pushen, uitvoeren of een Docker-opdracht uitvoeren. Gebruik deze taak met Docker of het Azure Container Registry.
Notitie
Docker@2 is een nieuwere versie van deze taak die de taak vereenvoudigt door invoer te verwijderen die als argumenten kunnen worden doorgegeven aan de opdracht.
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.
Invoerwaarden
containerregistrytype
- Type containerregister
string
. Vereist. Toegestane waarden: Azure Container Registry
, Container Registry
. Standaardwaarde: Azure Container Registry
.
Selecteer 'Azure Container Registry' om er verbinding mee te maken met behulp van een Azure-serviceverbinding. Selecteer Containerregister om verbinding te maken met Docker Hub of een ander privécontainerregister.
dockerRegistryConnection
- Verbinding met docker-registerservice
Invoeralias: dockerRegistryEndpoint
. string
. Optioneel. Gebruik wanneer containerregistrytype = Container Registry
.
Hiermee geeft u een Docker-registerserviceverbinding op. Vereist voor opdrachten die moeten worden geverifieerd met een register.
azureSubscription
- Azure-abonnement
Invoeralias: azureSubscriptionEndpoint
. string
. Optioneel. Gebruik wanneer containerregistrytype = Azure Container Registry
.
Hiermee geeft u een Azure-abonnement op.
azureContainerRegistry
- Azure Container Registry
string
. Optioneel. Gebruik wanneer containerregistrytype = Azure Container Registry
.
Hiermee geeft u een Azure Container Registry in het geselecteerde Azure-abonnement. De containerinstallatiekopieën worden gebouwd en vervolgens naar dit containerregister gepusht.
action
- Actie
string
. Vereist. Toegestane waarden: Build an image
, Tag images
, Push an image
, Push images
, Run an image
, , . Run a Docker command
Standaardwaarde: Build an image
.
Hiermee geeft u een Docker-actie.
dockerFile
- Docker-bestand
string
. Vereist wanneer action = Build an image
. Standaardwaarde: **/Dockerfile
.
Hiermee geeft u het pad naar het Docker-bestand. De taak maakt gebruik van het eerste Docker-bestand dat wordt gevonden om de installatiekopieën te bouwen.
addBaseImageData
- Metagegevens van basisinstallatiekopieën toevoegen aan installatiekopieën
boolean
. Standaardwaarde: true
.
De standaardwaarde voegt basisafbeeldingsgegevens toe, zoals de naam van de basisinstallatiekopieën en de digest, om te helpen bij de traceerbaarheid. U kunt zich afmelden door de waarde in te stellen op false
.
buildArguments
- Argumenten samenstellen
string
. Optioneel. Gebruik wanneer action = Build an image
.
Hiermee geeft u build-time variabelen voor het Docker-bestand. Maak elk name=value
paar op een nieuwe regel op.
defaultContext
- Standaardcontext voor bouwen gebruiken
boolean
. Optioneel. Gebruik wanneer action = Build an image
. Standaardwaarde: true
.
Hiermee geeft u de buildcontext van de map die het Docker-bestand bevat.
context
- Buildcontext
string
. Optioneel. Gebruik wanneer action = Build an image && defaultContext = false
.
Hiermee geeft u het pad naar de buildcontext op.
imageName
- Naam van afbeelding
string
. Vereist wanneer action == Build an image || action == Push an image || action == Run an image
. Standaardwaarde: $(Build.Repository.Name):$(Build.BuildId)
.
Hiermee geeft u de naam op van de Docker-installatiekopieën die moeten worden gebouwd, gepusht of uitgevoerd.
imageNamesPath
- Pad naar afbeeldingsnamen
string
. Vereist wanneer action == Tag images || action == Push images
.
Hiermee geeft u het pad naar een tekstbestand met de namen van de Docker-installatiekopieën te taggen of te pushen. Vermeld elke afbeeldingsnaam op een afzonderlijke regel.
qualifyImageName
- Naam van installatiekopieën kwalificeren
boolean
. Optioneel. Gebruik wanneer action = Build an image || action = Tag images || action = Push an image || action = Push images || action = Run an image
. Standaardwaarde: true
.
Hiermee geeft u de naam van een gekwalificeerde installatiekopie op met de hostnaam van de Docker-registerserviceverbinding.
additionalImageTags
- Aanvullende afbeeldingstags
string
. Optioneel. Gebruik wanneer action = Build an image || action = Tag images || action = Push an image || action = Push images
.
Hiermee geeft u aanvullende tags op voor de Docker-installatiekopieën die worden gemaakt of gepusht.
includeSourceTags
- Brontags opnemen
boolean
. Optioneel. Gebruik wanneer action = Build an image || action = Tag image || action = Push an image || action = Push images
. Standaardwaarde: false
.
Hiermee geeft u op of Git-tags moeten worden opgenomen bij het bouwen of pushen van de Docker-installatiekopieën.
includeLatestTag
- Meest recente tag opnemen
boolean
. Optioneel. Gebruik wanneer action = Build an image || action = Push an image || action = Push images
. Standaardwaarde: false
.
Hiermee geeft u op of de meest recente tag moet worden opgenomen bij het bouwen of pushen van de Docker-installatiekopieën.
imageDigestFile
- Samenvattingsbestand van afbeelding
string
. Optioneel. Gebruik wanneer action = Push an image || action = Push images
.
Hiermee geeft u het pad op naar een bestand dat is gemaakt en gevuld met de volledige samenvatting van de opslagplaats voor installatiekopieën van de Docker-installatiekopieën die is gepusht.
containerName
- Containernaam
string
. Optioneel. Gebruik wanneer action = Run an image
.
Hiermee geeft u de naam van de Docker-container die moet worden uitgevoerd.
ports
- Poorten
string
. Optioneel. Gebruik wanneer action = Run an image
.
Hiermee geeft u poorten in de Docker-container te publiceren naar de host. Vermeld elke host-port:container-port
binding op een nieuwe regel.
volumes
- Volumes
string
. Optioneel. Gebruik wanneer action = Run an image
.
Hiermee geeft u de volumes te koppelen vanaf de host. Geef elk item host-dir:container-dir
weer op een nieuwe regel.
envVars
- Omgevingsvariabelen
string
. Optioneel. Gebruik wanneer action = Run an image
.
Hiermee geeft u omgevingsvariabelen voor de Docker-container op. Vermeld elk name=value
paar op een nieuwe regel.
workDir
- Werkmap
string
. Optioneel. Gebruik wanneer action = Run an image
.
Hiermee geeft u de werkmap voor de Docker-container.
entrypoint
- Ingangspunt vervangen
string
. Optioneel. Gebruik wanneer action = Run an image
.
Hiermee geeft u een onderdrukking van het standaardinvoerpunt voor de Docker-container.
containerCommand
- Opdracht
string
. Optioneel. Gebruik wanneer action = Run an image
.
Hiermee geeft u een Docker-opdracht uitvoeren. De opdracht docker run maakt eerst een beschrijfbare containerlaag over de opgegeven installatiekopieën en start deze vervolgens met behulp van de opgegeven uitvoeringsopdracht. Als de afbeelding bijvoorbeeld een eenvoudige Python Flask-webtoepassing bevat, kunt u opgeven python app.py
om de webtoepassing te starten.
detached
- Uitvoeren op achtergrond
boolean
. Optioneel. Gebruik wanneer action = Run an image
. Standaardwaarde: true
.
Hiermee geeft u op of de Docker-container op de achtergrond moet worden uitgevoerd.
restartPolicy
- Beleid opnieuw opstarten
string
. Vereist wanneer action = Run an image && detached = true
. Toegestane waarden: no
, onFailure
(Bij fout), always
, unlessStopped
(tenzij gestopt). Standaardwaarde: no
.
Hiermee geeft u een beleid voor opnieuw opstarten op.
restartMaxRetries
- Maximum aantal nieuwe pogingen om opnieuw te starten
string
. Optioneel. Gebruik wanneer action = Run an image && detached = true && restartPolicy = onFailure
.
Hiermee geeft u het maximum aantal nieuwe pogingen op dat de Docker-daemon probeert opnieuw te starten.
customCommand
- Opdracht
string
. Vereist wanneer action = Run a Docker command
.
Hiermee geeft u de Docker-opdracht en argumenten die moeten worden uitgevoerd. Hiermee verwijdert u bijvoorbeeld rmi -f image-name
een afbeelding.
dockerHostEndpoint
- Verbinding met docker-hostservice
string
.
Hiermee geeft u een Docker-hostserviceverbinding op. Standaard ingesteld op de host van de agent.
enforceDockerNamingConvention
- Naam van installatiekopieën afdwingen om de Docker-naamconventie te volgen
boolean
. Standaardwaarde: true
.
Als deze optie is ingeschakeld, wijzigt u de naam van de Docker-installatiekopieën volgens de Naamconventies van Docker. Converteer hoofdletters bijvoorbeeld naar kleine letters en verwijder spaties.
workingDirectory
- Werkmap
Invoeralias: cwd
. string
. Standaardwaarde: $(System.DefaultWorkingDirectory)
.
Hiermee geeft u de werkmap voor de Docker-opdracht.
memory
- Geheugenlimiet
string
.
Hiermee geeft u de maximale hoeveelheid geheugen beschikbaar voor de container op als een geheel getal met optionele achtervoegsels, bijvoorbeeld 2GB
.
Opties voor taakbeheer
Alle taken hebben besturingsopties naast hun taakinvoer. Zie Opties voor besturingselementen en algemene taakeigenschappen voor meer informatie.
Uitvoervariabelen
Deze taak definieert de volgende uitvoervariabelen, die u kunt gebruiken in downstreamstappen, taken en fasen.
DockerOutput
Hiermee wordt de uitvoer van de docker-opdracht opgeslagen.
DockerOutputPath
Het pad van het bestand dat de uitvoer van de build-opdracht bevat.
Deze taak definieert de volgende uitvoervariabelen, die u kunt gebruiken in downstreamstappen, taken en fasen.
DockerOutput
Slaat de uitvoer van de docker-opdracht op
Opmerkingen
Docker@2 is een nieuwere versie van deze taak die de taak vereenvoudigt door invoer te verwijderen die als argumenten kunnen worden doorgegeven aan de opdracht.
Vereisten
Vereiste | Beschrijving |
---|---|
Pijplijntypen | YAML, klassieke build, klassieke release |
Wordt uitgevoerd op | Agent, DeploymentGroup |
Eisen | Geen |
Functies | Deze taak voldoet niet aan eventuele vereisten voor volgende taken in de taak. |
Opdrachtbeperkingen | Alle |
Instelbare variabelen | Alle |
Agentversie | Alle ondersteunde agentversies. |
Taakcategorie | Build |