Поделиться через

Docker@0 — задача Docker v0

  • Статья

Выполните сборку, добавление тегов, запуск образов Docker или команду Docker. Используйте эту задачу с Docker или реестром контейнеров Azure.

Примечание

Docker@2 — это более новая версия этой задачи, которая упрощает задачу, удаляя входные данные, которые можно передать в качестве аргументов в команду.

Синтаксис

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

Входные данные

containerregistrytype - Тип реестра контейнеров
string. Обязательный. Допустимые значения: Azure Container Registry, Container Registry. Значение по умолчанию: Azure Container Registry.

Выберите "Реестр контейнеров Azure", чтобы подключиться к нему с помощью подключения к службе Azure. Выберите "Реестр контейнеров", чтобы подключиться к Docker Hub или любому другому частному реестру контейнеров.


dockerRegistryConnection - Подключение к службе реестра Docker
Входной псевдоним: dockerRegistryEndpoint. string. Необязательный элемент. Используйте при containerregistrytype = Container Registry.

Указывает подключение к службе реестра Docker. Требуется для команд, которым требуется пройти проверку подлинности в реестре.


azureSubscription - Подписка Azure
Входной псевдоним: azureSubscriptionEndpoint. string. Необязательный элемент. Используйте при containerregistrytype = Azure Container Registry.

Указывает подписку Azure.


azureContainerRegistry - Реестр контейнеров Azure
string. Необязательный элемент. Используйте при containerregistrytype = Azure Container Registry.

Указывает Реестр контейнеров Azure в выбранной подписке Azure. Образ контейнера создается, а затем отправляется в этот реестр контейнеров.


action - Действий
string. Обязательный. Допустимые значения: Build an image, Tag images, Push an image, Push images, Run an image, . Run a Docker command Значение по умолчанию: Build an image.

Задает действие Docker.


dockerFile - Файл Docker
string. Требуется при .action = Build an image Значение по умолчанию: **/Dockerfile.

Указывает путь к файлу Docker. Задача использует первый файл Docker, который она находит для сборки образа.


addBaseImageData - Добавление метаданных базового образа в образы
boolean. Значение по умолчанию: true.

Значение по умолчанию добавляет данные базового образа, такие как имя базового образа и дайджест, чтобы упростить отслеживание. Вы можете отказаться, задав значение false.


buildArguments - Аргументы сборки
string. Необязательный элемент. Используйте при action = Build an image.

Указывает переменные времени сборки для файла Docker. Отформатируйте каждую name=value пару в новой строке.


defaultContext - Использование контекста сборки по умолчанию
boolean. Необязательный элемент. Используйте при action = Build an image. Значение по умолчанию: true.

Указывает контекст сборки каталога, содержащего файл Docker.


context - Контекст сборки
string. Необязательный элемент. Используйте при action = Build an image && defaultContext = false.

Указывает путь к контексту сборки.


imageName - Имя образа
string. Требуется при .action == Build an image || action == Push an image || action == Run an image Значение по умолчанию: $(Build.Repository.Name):$(Build.BuildId).

Указывает имя образа Docker для сборки, отправки или запуска.


imageNamesPath - Путь к именам изображений
string. Требуется при .action == Tag images || action == Push images

Указывает путь к текстовому файлу, который содержит имена образов Docker для добавления тегов или отправки. Укажите имена каждого изображения в отдельной строке.


qualifyImageName - Квалификация имени образа
boolean. Необязательный элемент. Используйте при action = Build an image || action = Tag images || action = Push an image || action = Push images || action = Run an image. Значение по умолчанию: true.

Указывает имя образа с именем узла подключения к службе реестра Docker.


additionalImageTags - Дополнительные теги изображений
string. Необязательный элемент. Используйте при action = Build an image || action = Tag images || action = Push an image || action = Push images.

Указывает дополнительные теги для создаваемого или отправляемого образа Docker.


includeSourceTags - Включить исходные теги
boolean. Необязательный элемент. Используйте при action = Build an image || action = Tag image || action = Push an image || action = Push images. Значение по умолчанию: false.

Указывает, следует ли включать теги Git при создании или отправке образа Docker.


includeLatestTag - Включить последний тег
boolean. Необязательный элемент. Используйте при action = Build an image || action = Push an image || action = Push images. Значение по умолчанию: false.

Указывает, следует ли включать последний тег при создании или отправке образа Docker.


imageDigestFile - Дайджест-файл изображения
string. Необязательный элемент. Используйте при action = Push an image || action = Push images.

Указывает путь к файлу, который создается и заполняется полным дайджестом репозитория образов отправленного образа Docker.


containerName - Имя контейнера
string. Необязательный элемент. Используйте при action = Run an image.

Указывает имя контейнера Docker для запуска.


ports - Порты
string. Необязательный элемент. Используйте при action = Run an image.

Указывает порты в контейнере Docker для публикации на узле. Вывод списка каждой host-port:container-port привязки в новой строке.


volumes - Объемы
string. Необязательный элемент. Используйте при action = Run an image.

Указывает тома для подключения с узла. Вывод списка в host-dir:container-dir новой строке.


envVars - Переменные среды
string. Необязательный элемент. Используйте при action = Run an image.

Задает переменные среды для контейнера Docker. Вывод списка каждой name=value пары в новой строке.


workDir - Рабочий каталог
string. Необязательный элемент. Используйте при action = Run an image.

Указывает рабочий каталог для контейнера Docker.


entrypoint - Переопределение точки входа
string. Необязательный элемент. Используйте при action = Run an image.

Задает переопределение точки входа по умолчанию для контейнера Docker.


containerCommand - Команды
string. Необязательный элемент. Используйте при action = Run an image.

Указывает команду docker run. Команда docker run сначала создает доступный для записи уровень контейнера для указанного образа, а затем запускает его с помощью указанной команды run. Например, если образ содержит простое веб-приложение Python Flask, можно указать python app.py для запуска веб-приложения.


detached - Запуск в фоновом режиме
boolean. Необязательный элемент. Используйте при action = Run an image. Значение по умолчанию: true.

Указывает, следует ли запускать контейнер Docker в фоновом режиме.


restartPolicy - Политика перезапуска
string. Требуется при .action = Run an image && detached = true Допустимые значения: no, onFailure (при сбое), always, unlessStopped (если не остановлено). Значение по умолчанию: no.

Задает политику перезапуска.


restartMaxRetries - Максимальное число повторных попыток перезапуска
string. Необязательный элемент. Используйте при action = Run an image && detached = true && restartPolicy = onFailure.

Указывает максимальное число повторных попыток перезапуска, которые пытается выполнить управляющая программа Docker.


customCommand - Команды
string. Требуется при .action = Run a Docker command

Указывает команду Docker и аргументы для выполнения. Например, rmi -f image-name удаляет изображение.


dockerHostEndpoint - Подключение службы узла Docker
string.

Указывает подключение службы узла Docker. По умолчанию используется узел агента.


enforceDockerNamingConvention - Принудительное применение имени образа к соглашению об именовании Docker
boolean. Значение по умолчанию: true.

Если этот параметр включен, изменяет имя образа Docker в соответствии с соглашениями об именовании Docker. Например, преобразуйте прописные буквы в нижний регистр и удалите пробелы.


workingDirectory - Рабочий каталог
Входной псевдоним: cwd. string. Значение по умолчанию: $(System.DefaultWorkingDirectory).

Указывает рабочий каталог для команды Docker.


memory - Ограничение памяти
string.

Задает максимальный объем памяти, доступный для контейнера в виде целого числа с необязательными суффиксами, например 2GB.


Параметры управления задачами

Помимо входных данных, все задачи имеют параметры управления. Дополнительные сведения см. в разделе Параметры управления и общие свойства задачи.

Выходные переменные

Эта задача определяет следующие выходные переменные, которые можно использовать в последующих шагах, заданиях и этапах.

DockerOutput
Хранит выходные данные команды docker.

DockerOutputPath
Путь к файлу, который содержит выходные данные команды сборки.

Эта задача определяет следующие выходные переменные, которые можно использовать в последующих шагах, заданиях и этапах.

DockerOutput
Хранит выходные данные команды Docker

Комментарии

Docker@2 — это более новая версия этой задачи, которая упрощает задачу, удаляя входные данные, которые можно передать в качестве аргументов в команду.

Требования

Требование Описание
Типы конвейеров YAML, классическая сборка, классический выпуск
Выполняется в Агент, DeploymentGroup
Требования None
Capabilities Эта задача не удовлетворяет требованиям для последующих задач в задании.
Ограничения команд Любой
Устанавливаемые переменные Любой
Версия агента Все поддерживаемые версии агента.
Категория задач Сборка

См. также раздел