Docker@0 - Docker v0-taak
Bouw, tag, push, voer Docker-installatiekopieën uit of voer een Docker-opdracht uit. 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 aan de opdracht kunnen worden doorgegeven.
Bouw, tag, push, voer Docker-installatiekopieën uit of voer een Docker-opdracht uit. 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 aan de opdracht kunnen worden doorgegeven.
Syntaxis
# 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.
Invoer
containerregistrytype
-
containerregistertype
string
. Verplicht. 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
-
docker-registerserviceverbinding
Invoeralias: dockerRegistryEndpoint
.
string
. Facultatief. Gebruiken 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
. Facultatief. Gebruiken wanneer containerregistrytype = Azure Container Registry
.
Hiermee geeft u een Azure-abonnement op.
azureContainerRegistry
-
Azure Container Registry-
string
. Facultatief. Gebruiken wanneer containerregistrytype = Azure Container Registry
.
Hiermee geeft u een Azure Container Registry in het geselecteerde Azure-abonnement op. De containerinstallatiekopie wordt gebouwd en vervolgens naar dit containerregister gepusht.
action
-
actie-
string
. Verplicht. 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 op.
dockerFile
-
Docker File-
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
boolean
. Standaardwaarde: true
.
Met de standaardwaarde worden basisinstallatiekopieën toegevoegd, zoals de naam en samenvatting van de basisinstallatiekopieën om te helpen bij tracering. U kunt zich afmelden door de waarde in te stellen op false
.
buildArguments
-
argumenten maken
string
. Facultatief. Gebruiken wanneer action = Build an image
.
Hiermee geeft u build-tijdvariabelen voor het Docker-bestand. Maak elke name=value
paar op een nieuwe regel op.
defaultContext
-
Standaardcontext voor build gebruiken
boolean
. Facultatief. Gebruiken wanneer action = Build an image
. Standaardwaarde: true
.
Hiermee geeft u de buildcontext op van de map die het Docker-bestand bevat.
context context
- bouwen
string
. Facultatief. Gebruiken wanneer action = Build an image && defaultContext = false
.
Hiermee geeft u het pad naar de buildcontext.
imageName
-
naam van installatiekopieën
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 van de Docker-installatiekopieën op 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 dat de namen van de Docker-installatiekopieën bevat die moeten worden gelabeld of gepusht. Geef elke naam van de installatiekopie op een afzonderlijke regel weer.
qualifyImageName
-
Naam van installatiekopieën kwalificeren
boolean
. Facultatief. Gebruiken wanneer action = Build an image || action = Tag images || action = Push an image || action = Push images || action = Run an image
. Standaardwaarde: true
.
Hiermee geeft u een in aanmerking komende installatiekopienaam op met de hostnaam van de Docker-registerserviceverbinding.
additionalImageTags
-
extra afbeeldingstags
string
. Facultatief. Gebruiken wanneer action = Build an image || action = Tag images || action = Push an image || action = Push images
.
Hiermee geeft u extra tags op voor de Docker-installatiekopie die wordt gemaakt of gepusht.
includeSourceTags
-
brontags opnemen
boolean
. Facultatief. Gebruiken 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 toevoegen
boolean
. Facultatief. Gebruiken 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
-
Image Digest File
string
. Facultatief. Gebruiken wanneer action = Push an image || action = Push images
.
Hiermee geeft u het pad 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
. Facultatief. Gebruiken wanneer action = Run an image
.
Hiermee geeft u de naam op van de Docker-container die moet worden uitgevoerd.
ports
-
poorten
string
. Facultatief. Gebruiken wanneer action = Run an image
.
Hiermee geeft u poorten in de Docker-container om te publiceren naar de host. Geef elke host-port:container-port
binding op een nieuwe regel weer.
volumes
-
volumes
string
. Facultatief. Gebruiken wanneer action = Run an image
.
Hiermee geeft u de volumes die van de host moeten worden gekoppeld. Geef elke host-dir:container-dir
op een nieuwe regel weer.
envVars
-
omgevingsvariabelen
string
. Facultatief. Gebruiken wanneer action = Run an image
.
Hiermee geeft u omgevingsvariabelen voor de Docker-container op. Geef elke name=value
paar weer op een nieuwe regel.
workDir
-
werkmap
string
. Facultatief. Gebruiken wanneer action = Run an image
.
Hiermee geeft u de werkmap voor de Docker-container.
entrypoint
-
invoerpunt overschrijven
string
. Facultatief. Gebruiken wanneer action = Run an image
.
Hiermee geeft u een onderdrukking van het standaardinvoerpunt voor de Docker-container.
containerCommand
-
opdracht
string
. Facultatief. Gebruiken wanneer action = Run an image
.
Hiermee geeft u een Docker-run-opdracht. Met de docker-run-opdracht maakt u eerst een schrijfbare containerlaag over de opgegeven installatiekopieën en start u deze vervolgens met behulp van de opgegeven run-opdracht. Als de afbeelding bijvoorbeeld een eenvoudige Python Flask-webtoepassing bevat, kunt u python app.py
opgeven om de webtoepassing te starten.
detached
-
Uitvoeren op achtergrond
boolean
. Facultatief. Gebruiken 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
-
nieuwe pogingen voor opnieuw opstarten
string
. Facultatief. Gebruiken wanneer action = Run an image && detached = true && restartPolicy = onFailure
.
Hiermee geeft u het maximum aantal nieuwe pogingen voor opnieuw opstarten op dat door de Docker-daemon wordt geprobeerd.
customCommand
-
opdracht
string
. Vereist wanneer action = Run a Docker command
.
Hiermee geeft u de Docker-opdracht en argumenten die moeten worden uitgevoerd.
rmi -f image-name
bijvoorbeeld een afbeelding verwijdert.
dockerHostEndpoint
-
docker-hostserviceverbinding
string
.
Hiermee geeft u een Docker-hostserviceverbinding op. De standaardinstelling is de host van de agent.
enforceDockerNamingConvention
-
Naam van installatiekopieën geforceerd volgen
boolean
. Standaardwaarde: true
.
Als deze optie is ingeschakeld, wijzigt u de naam van de Docker-installatiekopieën volgens de naamconventies van Docker. Converteer bijvoorbeeld hoofdletters 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 op die beschikbaar is voor de container als een geheel getal met optionele achtervoegsels, bijvoorbeeld 2GB
.
Opties voor taakbeheer
Alle taken hebben besturingsopties naast hun taakinvoer. Zie Opties en algemene taakeigenschappenvoor meer informatie.
Uitvoervariabelen
Deze taak definieert de volgende uitvoervariabelen, die u kunt gebruiken in downstreamstappen, taken en fasen.
DockerOutput
slaat de uitvoer van de docker-opdracht op.
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 aan de opdracht kunnen worden doorgegeven.
Vereisten
Voorwaarde | Beschrijving |
---|---|
Pijplijntypen | YAML, klassieke build, klassieke release |
Wordt uitgevoerd op | Agent, DeploymentGroup |
eisen | Geen |
mogelijkheden | Deze taak voldoet niet aan de vereisten voor volgende taken in de taak. |
opdrachtbeperkingen | Welk dan ook |
variabelen instellen | Welk dan ook |
Agentversie | Alle ondersteunde agentversies. |
Taakcategorie | Bouwen |