Docker@1 – Docker v1-Aufgabe

Erstellen, Markieren, Pushen oder Ausführen eines Docker-Images oder Ausführen eines Docker-Befehls. Verwenden Sie diese Aufgabe mit Docker oder der Azure Container Registry.

Hinweis

Docker@2 ist eine neuere Version dieser Aufgabe, die die Aufgabe vereinfacht, indem Eingaben entfernt werden, die als Argumente an den Befehl übergeben werden können.

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.

Eingaben

containerregistrytype - Containerregistrierungstyp
string. Erforderlich, wenn command != logout. Zulässige Werte: Azure Container Registry, Container Registry. Standardwert. Azure Container Registry.

Gibt die Azure Container Registry an, die mithilfe einer Azure-Dienstverbindung hergestellt werden soll. Wählen Sie einen Azure Container Registry aus, um eine Verbindung mit einer Docker Hub oder einer anderen privaten Containerregistrierung herzustellen.

addBaseImageData - Hinzufügen von Basisbildmetadaten zu Bildern
boolean. Standardwert. true.

Der Standardwert fügt Basisimagedaten wie den Namen des Basisimages und den Digest hinzu, um die Rückverfolgbarkeit zu erleichtern. Sie können dieses Standardverhalten deaktivieren, indem Sie diesen Wert auf falsefestlegen.

dockerRegistryEndpoint - Docker-Registrierungsdienstverbindung
string. Optional. Verwenden Sie , wenn containerregistrytype = Container Registry && command != logout.

Gibt eine Docker-Registrierungsdienstverbindung an. Erforderlich für Befehle, die sich mithilfe einer Registrierung authentifizieren.

azureSubscriptionEndpoint - Azure-Abonnement
string. Optional. Verwenden Sie , wenn containerregistrytype = Azure Container Registry && command != logout.

Gibt ein Azure-Abonnement an.

azureContainerRegistry - Azure Container Registry
string. Optional. Verwenden Sie , wenn containerregistrytype = Azure Container Registry && command != logout.

Gibt eine Azure Container Registry im ausgewählten Azure-Abonnement an. Das Containerimage wird erstellt und an diese Containerregistrierung gepusht.

command - Befehl
string. Erforderlich. Zulässige Werte: Build an image (build), Tag image (tag), Push an image (push), Run an image (run), login, logout. Standardwert. Build an image.

Gibt den docker-Befehl an, der ausgeführt werden soll.

dockerFile - Dockerfile
string. Erforderlich, wenn command = Build an image || command = build. Standardwert. **/Dockerfile.

Gibt den Pfad zur Docker-Datei an. Der Task verwendet die erste gefundene Docker-Datei, um das Image zu erstellen.

arguments - Argumente
string. Optional. Verwenden Sie , wenn command != login && command != logout.

Gibt zusätzliche Argumente an, die an den Docker-Client übergeben werden sollen. Wenn Sie den Wert buildAndPush im Befehlsparameter verwenden, wird die arguments-Eigenschaft ignoriert.

pushMultipleImages - Pushen mehrerer Images
boolean. Optional. Verwenden Sie , wenn command = Push an image || command = push. Standardwert. false.

Gibt eine Liste in einer Textdatei mit zu pushenden Docker-Images an. Listen Sie jeden Bildnamen im Format Imagename1:tag1 in einer separaten Zeile auf. Das Auflisten eines Imagenamens ohne Tags, z. B. Imagename2, pusht alle Tags im Imagename2 Container.

tagMultipleImages - Markieren mehrerer Images
boolean. Optional. Verwenden Sie , wenn command = Tag image || command = tag. Standardwert. false.

Gibt eine Liste mit mehreren Imagetags und Docker-Images an, die in einer Textdatei markiert werden sollen. Listen Sie jeden Bildnamen im Format Imagename1:tag1 in einer separaten Zeile auf. Bilder, die ohne Tag Imagename2 als aufgeführt sind, sind standardmäßig als neueste gekennzeichnet.

imageName - Bildname
string. Erforderlich, wenn command = Build an image || command = build || command = Run an image || command = run || pushMultipleImages = false || tagMultipleImages = false. Standardwert. $(Build.Repository.Name):$(Build.BuildId).

Gibt den Namen des Docker-Images an, das erstellt, gepusht oder ausgeführt werden soll.

imageNamesPath - Pfad für Bildnamen
string. Erforderlich, wenn tagMultipleImages = true || pushMultipleImages = true.

Gibt den Pfad zu einer Textdatei an, die die Namen der Docker-Images enthält, die tag- oder pushen sollen. Listen Sie jeden Bildnamen in einer separaten Zeile auf.

qualifyImageName - Qualifizieren des Imagenamens
boolean. Optional. Verwenden Sie , wenn command = Build an image || command = build || command = Tag image || command = tag || command = Push an image || command = push || command = Run an image || command = run. Standardwert. true.

Gibt einen qualifizierten Imagenamen mit dem Hostnamen der Docker-Registrierungsdienstverbindung an.

qualifySourceImageName - Name des Quellimages qualifizieren
boolean. Optional. Verwenden Sie , wenn command = Tag image || command = tag. Standardwert. false.

Gibt einen qualifizierten Imagenamen mit dem Hostnamen der Docker-Registrierungsdienstverbindung an.

includeSourceTags - Einschließen von Quelltags
boolean. Optional. Verwenden Sie , wenn command = Build an image || command = build || command = Tag image || command = tag || command = Push an image || command = push. Standardwert. false.

Gibt Git-Tags an, die beim Erstellen oder Pushen des Docker-Images eingeschlossen werden sollen.

includeLatestTag - Neuestes Tag einschließen
boolean. Optional. Verwenden Sie , wenn command = Build an image || command = build. Standardwert. false.

Gibt an, ob beim Erstellen des Docker-Images das neueste Tag verwendet werden soll.

addDefaultLabels - Hinzufügen von Standardbezeichnungen
boolean. Optional. Verwenden Sie , wenn addDefaultLabels = false. Standardwert. true.

Gibt an, ob dem Containerimage CI/CD-Metadaten mithilfe von Docker-Bezeichnungen wie Repository-, Commit-, Build- und Releaseinformationen hinzugefügt werden sollen.

useDefaultContext - Verwenden des Standardbuildkontexts
boolean. Optional. Verwenden Sie , wenn command = Build an image || command = build. Standardwert. true.

Gibt das Hinzufügen oder Entfernen des Buildkontexts zum Verzeichnis an, das die Docker-Datei enthält.

buildContext - Buildkontext
string. Optional. Verwenden Sie , wenn useDefaultContext = false.

Gibt den Pfad zum Buildkontext an.

imageDigestFile - Image Digest-Datei
string. Optional. Verwenden Sie , wenn command = Push an image || command = push.

Gibt den Pfad zu einer Datei an, die erstellt und mit dem vollständigen Imagerepository-Digest des Docker-Images aufgefüllt wird, das per Push übertragen wurde.

containerName - Containername
string. Optional. Verwenden Sie , wenn command = Run an image || command = run.

Gibt den Namen des auszuführenden Docker-Containers an.

ports - Ports
string. Optional. Verwenden Sie , wenn command = Run an image || command = run.

Gibt die Ports im Docker-Container an, die auf dem Host veröffentlicht werden sollen. Listen Sie jede host-port:container-port Bindung in einer separaten Zeile auf.

volumes - Volumes
string. Optional. Verwenden Sie , wenn command = Run an image || command = run.

Gibt die Volumes an, die vom Host bereitgestellt werden sollen. Listen Sie jede host-dir:container-dir in einer separaten Zeile auf.

envVars - Umgebungsvariablen
string. Optional. Verwenden Sie , wenn command = Run an image || command = run.

Gibt Umgebungsvariablen für den Docker-Container an. Listen Sie jedes name=value Paar in einer separaten Zeile auf.

workingDirectory - Arbeitsverzeichnis
string. Optional. Verwenden Sie , wenn command = Run an image || command = run.

Gibt das Arbeitsverzeichnis für den Docker-Container an.

entrypointOverride - Außerkraftsetzung des Einstiegspunkts
string. Optional. Verwenden Sie , wenn command = Run an image || command = run.

Gibt an, ob der Standardeinstiegspunkt für den Docker-Container überschrieben werden soll.

containerCommand - Containerbefehl
string. Optional. Verwenden Sie , wenn command = Run an image || command = run.

Gibt einen Docker-Run-Befehl an. Der Befehl docker run erstellt zunächst eine beschreibbare Containerebene über dem angegebenen Image und startet sie dann mithilfe des angegebenen Run-Befehls. Wenn das Bild beispielsweise eine einfache Python Flask-Webanwendung enthält, können Sie angeben python app.py , um die Webanwendung zu starten.

runInBackground - Im Hintergrund ausführen
boolean. Optional. Verwenden Sie , wenn command = Run an image || command = run. Standardwert. true.

Gibt an, ob der Docker-Container im Hintergrund ausgeführt werden soll.

restartPolicy - Neustartrichtlinie
string. Erforderlich, wenn runInBackground = true. Zulässige Werte: no, onFailure (Bei Fehler), always, unlessStopped (sofern nicht beendet). Standardwert. no.

Gibt an, wann eine Neustartrichtlinie ausgeführt werden soll.

maxRestartRetries - Maximale Anzahl von Neustartversuchen
string. Optional. Verwenden Sie , wenn runInBackground = true && restartPolicy = onFailure.

Gibt die maximale Anzahl von Neustartversuchen an, die der Docker-Daemon versucht.

dockerHostEndpoint - Docker-Hostdienstverbindung
string. Optional. Verwenden Sie , wenn command != login && command != logout.

Gibt eine Docker-Hostdienstverbindung an. Standardmäßig wird der Host des Agents verwendet.

enforceDockerNamingConvention - Erzwingen des Imagenamens, dass die Docker-Benennungskonvention befolgt wird
boolean. Optional. Verwenden Sie , wenn command != login && command != logout. Standardwert. true.

Der Standardwert ändert den Docker-Imagenamen gemäß den Docker-Namenskonventionen. Konvertieren Sie z. B. Großbuchstaben in Kleinbuchstaben, und entfernen Sie Leerzeichen.

memoryLimit - Arbeitsspeicherlimit
string. Optional. Verwenden Sie , wenn command != login && command != logout.

Gibt die maximale Für den Container verfügbare Arbeitsspeichermenge als ganze Zahl mit optionalen Suffixen wie 2GBan.

Optionen für die Vorgangskontrolle

Alle Vorgänge verfügen zusätzlich zu ihren Eingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerungsoptionen und allgemeine Aufgabeneigenschaften.

Ausgabevariablen

Diese Aufgabe definiert die folgenden Ausgabevariablen, die Sie in Downstreamschritten, Aufträgen und Phasen verwenden können.

DockerOutput
Speichert die Ausgabe des Docker-Befehls.

DockerOutputPath
Der Pfad der Datei, die die Ausgabe des Buildbefehls enthält.

Hinweise

Docker@2 ist eine neuere Version dieser Aufgabe, die die Aufgabe vereinfacht, indem Eingaben entfernt werden, die als Argumente an den Befehl übergeben werden können.

Anforderungen

Anforderung	BESCHREIBUNG
Pipelinetypen	YAML, Klassischer Build, klassisches Release
Wird ausgeführt auf	Agent, DeploymentGroup
Forderungen	Keine
Capabilities	Diese Aufgabe erfüllt keine Anforderungen an nachfolgende Aufgaben im Auftrag.
Befehlseinschränkungen	Any
Setzbare Variablen	Any
Agent-Version	Alle unterstützten Agent-Versionen.
Aufgabenkategorie	Entwickeln

Weitere Informationen

• Docker@2