Udostępnij za pośrednictwem

Docker@0 — zadanie platformy Docker v0

  • Artykuł

Kompilowanie, tagowanie, wypychanie, uruchamianie obrazów platformy Docker lub uruchamianie polecenia platformy Docker. Użyj tego zadania z platformą Docker lub rejestrem kontenerów platformy Azure.

Uwaga

Docker@2 jest nowszą wersją tego zadania, która upraszcza zadanie przez usunięcie danych wejściowych, które można przekazać jako argumenty do polecenia.

Składnia

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

Dane wejściowe

containerregistrytype - Typ rejestru kontenerów
string. Wymagane. Dozwolone wartości: Azure Container Registry, Container Registry. Wartość domyślna: Azure Container Registry.

Wybierz pozycję "Azure Container Registry", aby nawiązać z nią połączenie przy użyciu połączenia z usługą platformy Azure. Wybierz pozycję "Rejestr kontenerów", aby nawiązać połączenie z Docker Hub lub innym prywatnym rejestrem kontenerów.


dockerRegistryConnection - Połączenie usługi rejestru platformy Docker
Alias wejściowy: dockerRegistryEndpoint. string. Opcjonalny. Użyj polecenia , gdy containerregistrytype = Container Registry.

Określa połączenie usługi rejestru platformy Docker. Wymagane w przypadku poleceń, które muszą być uwierzytelniane w rejestrze.


azureSubscription - Subskrypcja platformy Azure
Alias wejściowy: azureSubscriptionEndpoint. string. Opcjonalny. Użyj polecenia , gdy containerregistrytype = Azure Container Registry.

Określa subskrypcję platformy Azure.


azureContainerRegistry - Azure Container Registry
string. Opcjonalny. Użyj polecenia , gdy containerregistrytype = Azure Container Registry.

Określa Azure Container Registry w wybranej subskrypcji platformy Azure. Obraz kontenera jest kompilowany, a następnie wypychany do tego rejestru kontenerów.


action - Działania
string. Wymagane. Dozwolone wartości: Build an image, , Push an imageTag images, Push images, Run an image, Run a Docker command. Wartość domyślna: Build an image.

Określa akcję platformy Docker.


dockerFile - Plik platformy Docker
string. Wymagane, gdy action = Build an image. Wartość domyślna: **/Dockerfile.

Określa ścieżkę do pliku platformy Docker. Zadanie używa pierwszego znalezionego pliku platformy Docker do skompilowania obrazu.


addBaseImageData - Dodawanie metadanych obrazu podstawowego do obrazów
boolean. Wartość domyślna: true.

Wartość domyślna dodaje dane obrazu podstawowego, takie jak nazwa obrazu podstawowego i skrót, aby ułatwić śledzenie. Możesz zrezygnować, ustawiając wartość na false.


buildArguments - Argumenty kompilacji
string. Opcjonalny. Użyj polecenia , gdy action = Build an image.

Określa zmienne czasu kompilacji dla pliku platformy Docker. Formatuj każdą name=value parę w nowym wierszu.


defaultContext - Użyj domyślnego kontekstu kompilacji
boolean. Opcjonalny. Użyj polecenia , gdy action = Build an image. Wartość domyślna: true.

Określa kontekst kompilacji katalogu, który zawiera plik platformy Docker.


context - Kontekst kompilacji
string. Opcjonalny. Użyj polecenia , gdy action = Build an image && defaultContext = false.

Określa ścieżkę do kontekstu kompilacji.


imageName - Nazwa obrazu
string. Wymagane, gdy action == Build an image || action == Push an image || action == Run an image. Wartość domyślna: $(Build.Repository.Name):$(Build.BuildId).

Określa nazwę obrazu platformy Docker do kompilowania, wypychania lub uruchamiania.


imageNamesPath - Ścieżka nazw obrazów
string. Wymagane, gdy action == Tag images || action == Push images.

Określa ścieżkę do pliku tekstowego zawierającego nazwy obrazów platformy Docker do tagowania lub wypychania. Wyświetl każdą nazwę obrazu w osobnym wierszu.


qualifyImageName - Kwalifikowana nazwa obrazu
boolean. Opcjonalny. Użyj polecenia , gdy action = Build an image || action = Tag images || action = Push an image || action = Push images || action = Run an image. Wartość domyślna: true.

Określa kwalifikowaną nazwę obrazu z nazwą hosta połączenia usługi rejestru platformy Docker.


additionalImageTags - Dodatkowe tagi obrazów
string. Opcjonalny. Użyj polecenia , gdy action = Build an image || action = Tag images || action = Push an image || action = Push images.

Określa dodatkowe tagi dla tworzonego lub wypychanego obrazu platformy Docker.


includeSourceTags - Dołączanie tagów źródłowych
boolean. Opcjonalny. Użyj polecenia , gdy action = Build an image || action = Tag image || action = Push an image || action = Push images. Wartość domyślna: false.

Określa, czy należy uwzględnić tagi Git podczas kompilowania lub wypychania obrazu platformy Docker.


includeLatestTag - Uwzględnij najnowszy tag
boolean. Opcjonalny. Użyj polecenia , gdy action = Build an image || action = Push an image || action = Push images. Wartość domyślna: false.

Określa, czy podczas kompilowania lub wypychania obrazu platformy Docker należy uwzględnić najnowszy tag.


imageDigestFile - Plik skrótu obrazu
string. Opcjonalny. Użyj polecenia , gdy action = Push an image || action = Push images.

Określa ścieżkę do pliku utworzonego i wypełnionego pełnym skrótem repozytorium obrazów obrazu platformy Docker, który został wypchnięty.


containerName - Nazwa kontenera
string. Opcjonalny. Użyj polecenia , gdy action = Run an image.

Określa nazwę kontenera platformy Docker do uruchomienia.


ports - Porty
string. Opcjonalny. Użyj polecenia , gdy action = Run an image.

Określa porty w kontenerze platformy Docker do publikowania na hoście. Wyświetl listę każdego host-port:container-port powiązania w nowym wierszu.


volumes - Woluminów
string. Opcjonalny. Użyj polecenia , gdy action = Run an image.

Określa woluminy do zainstalowania z hosta. Wyświetl listę każdej host-dir:container-dir z nich w nowym wierszu.


envVars - Zmienne środowiskowe
string. Opcjonalny. Użyj polecenia , gdy action = Run an image.

Określa zmienne środowiskowe dla kontenera platformy Docker. Wyświetl listę każdej name=value pary w nowym wierszu.


workDir - Katalog roboczy
string. Opcjonalny. Użyj polecenia , gdy action = Run an image.

Określa katalog roboczy kontenera platformy Docker.


entrypoint - Zastępowanie punktu wejścia
string. Opcjonalny. Użyj polecenia , gdy action = Run an image.

Określa zastąpienie domyślnego punktu wejścia dla kontenera platformy Docker.


containerCommand - Polecenia
string. Opcjonalny. Użyj polecenia , gdy action = Run an image.

Określa polecenie docker run. Polecenie docker run najpierw tworzy zapisywalną warstwę kontenera na określonym obrazie, a następnie uruchamia ją przy użyciu określonego polecenia uruchamiania. Jeśli na przykład obraz zawiera prostą aplikację internetową platformy Python Flask, możesz określić python app.py , aby uruchomić aplikację internetową.


detached - Uruchamianie w tle
boolean. Opcjonalny. Użyj polecenia , gdy action = Run an image. Wartość domyślna: true.

Określa, czy należy uruchomić kontener platformy Docker w tle.


restartPolicy - Zasady ponownego uruchamiania
string. Wymagane, gdy action = Run an image && detached = true. Dozwolone wartości: no, onFailure (po awarii), always, unlessStopped (chyba że zatrzymano). Wartość domyślna: no.

Określa zasady ponownego uruchamiania.


restartMaxRetries - Maksymalna liczba ponownych prób ponownego uruchomienia
string. Opcjonalny. Użyj polecenia , gdy action = Run an image && detached = true && restartPolicy = onFailure.

Określa maksymalną liczbę ponownych prób ponownego uruchomienia, które próbuje demon platformy Docker.


customCommand - Polecenia
string. Wymagane, gdy action = Run a Docker command.

Określa polecenie platformy Docker i argumenty do wykonania. Na przykład rmi -f image-name usuwa obraz.


dockerHostEndpoint - Połączenie z usługą hosta platformy Docker
string.

Określa połączenie usługi hosta platformy Docker. Domyślnie jest to host agenta.


enforceDockerNamingConvention - Wymuszanie przestrzegania konwencji nazewnictwa platformy Docker wymuś nazwę obrazu
boolean. Wartość domyślna: true.

Jeśli to ustawienie jest włączone, modyfikuje nazwę obrazu platformy Docker zgodnie z konwencjami nazewnictwa platformy Docker. Na przykład przekonwertuj wielkie litery na małe litery i usuń spacje.


workingDirectory - Katalog roboczy
Alias wejściowy: cwd. string. Wartość domyślna: $(System.DefaultWorkingDirectory).

Określa katalog roboczy dla polecenia platformy Docker.


memory - Limit pamięci
string.

Określa maksymalną ilość pamięci dostępnej dla kontenera jako liczbę całkowitą z opcjonalnymi sufiksami, na przykład 2GB.


Opcje sterowania zadania

Wszystkie zadania mają opcje sterowania oprócz danych wejściowych zadań. Aby uzyskać więcej informacji, zobacz Opcje sterowania i typowe właściwości zadań.

Zmienne wyjściowe

To zadanie definiuje następujące zmienne wyjściowe, które można używać w krokach podrzędnych, zadaniach i etapach.

DockerOutput
Przechowuje dane wyjściowe polecenia platformy Docker.

DockerOutputPath
Ścieżka pliku zawierającego dane wyjściowe polecenia kompilacji.

To zadanie definiuje następujące zmienne wyjściowe, które można używać w krokach podrzędnych, zadaniach i etapach.

DockerOutput
Przechowuje dane wyjściowe polecenia platformy Docker

Uwagi

Docker@2 jest nowszą wersją tego zadania, która upraszcza zadanie przez usunięcie danych wejściowych, które można przekazać jako argumenty do polecenia.

Wymagania

Wymaganie Opis
Typy potoków YAML, klasyczna kompilacja, wersja klasyczna
Działa w Agent, DeploymentGroup
Wymagania Brak
Możliwości To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
Ograniczenia poleceń Dowolne
Zmienne ustawialne Dowolne
Wersja agenta Wszystkie obsługiwane wersje agenta.
Kategoria zadania Kompilacja

Zobacz też