Docker@0 — задача Docker v0
Создание, тег, отправка, запуск образов Docker или выполнение команды Docker. Используйте эту задачу с Docker или реестром контейнеров Azure.
Примечание.
Docker@2 — это более новая версия этой задачи, которая упрощает задачу путем удаления входных данных, которые можно передать в качестве аргументов в команду.
Создание, тег, отправка, запуск образов 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.
Входные данные
типа реестра контейнеров 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.
реестра контейнеров Azure azureContainerRegistry
-
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. Команда запуска Docker сначала создает слой контейнеров, доступный для записи, над указанным образом, а затем запускает его с помощью указанной команды запуска. Например, если изображение содержит простое веб-приложение 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 |
требования | Нет |
возможностей | Эта задача не удовлетворяет требованиям к последующим задачам в задании. |
ограничения команд | Любое |
переменные settable | Любое |
Версия агента | Все поддерживаемые версии агента. |
Категория задач | Строить |