Модуль community.docker.docker_image_push – Публикация образов Docker в реестры

Примечание

Этот модуль является частью коллекции community.docker (версия 3.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install community.docker. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в playbook, укажите: community.docker.docker_image_push.

Новая в community.docker 3.6.0

Описание
Требования
Параметры
Атрибуты
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Опубликует образ Docker в реестр.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

API Docker >= 1.25
backports.ssl_match_hostname (при использовании TLS в Python 2)
paramiko (при использовании SSH с use_ssh_client=false)
pyOpenSSL (при использовании TLS)
pywin32 (при использовании именованных каналов на Windows 32)
requests

Параметры

Параметр	Комментарии
api_version псевдонимы: docker_api_version строка	Версия API Docker, работающая на Docker хосте. По умолчанию используется последняя версия API, поддерживаемая этим сбором и демоном docker. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_API_VERSION`. Если переменная среды не задана, будет использовано значение по умолчанию. По умолчанию: `"auto"`
ca_path псевдонимы: ca_cert, tls_ca_cert, cacert_path путь	Использование сертификата CA при проверке подлинности сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче, и переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `ca.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`. Этот параметр назывался `ca_cert` и был переименован в `ca_path` в community.docker 3.6.0. Старое имя добавлено как псевдоним и по-прежнему может быть использовано.
client_cert псевдонимы: tls_client_cert, cert_path путь	Путь к файлу клиентского TLS сертификата. Если значение не указано в задаче, и переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `cert.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`.
client_key псевдонимы: tls_client_key, key_path путь	Путь к файлу клиентского TLS ключа. Если значение не указано в задаче, и переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `key.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`.
debug булево	Режим отладки Варианты: `false` ← (по умолчанию) `true`
docker_host псевдонимы: docker_url строка	URL или путь к сокету Unix для подключения к Docker API. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL соединения на `https`. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_HOST`. Если переменная среды не задана, будет использовано значение по умолчанию. По умолчанию: `"unix:///var/run/docker.sock"`
name строка / обязательный	Имя изображения. Формат имени должен быть одним из `name`, `repository/name`, или `registry_server:port/name`. - Имя может необязательно включать тэг, добавив `:tag_name`, или может содержать дайджест, добавив `@hash:digest`.
ssl_version строка	Укажите корректный номер версии SSL. Значение по умолчанию определяется модулем SSL Python module. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_SSL_VERSION`.
tag строка	Выбор изображения для отправки. По умолчанию `latest`. Если формат параметра `name` - `name:tag` или `image@hash:digest`, то `tag` будет проигнорировано. По умолчанию: `"latest"`
timeout целое число	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TIMEOUT`. Если переменная среды не задана, будет использовано значение по умолчанию. По умолчанию: `60`
tls булево	Защитить соединение с API с помощью TLS без проверки подлинности Docker хост-сервера. Обратите внимание, что если `validate_certs` также установлено в `true`, оно будет иметь приоритет. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TLS`. Если переменная среды не задана, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`
tls_hostname строка	При проверке подлинности Docker хост-сервера укажите ожидаемое имя сервера. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TLS_HOSTNAME`. Если переменная среды не задана, будет использовано значение по умолчанию. Обратите внимание, что в более ранних версиях этот параметр имел значение по умолчанию `localhost`. Он был удалён в community.docker 3.0.0.

use_ssh_client

boolean

added in community.docker 1.5.0

Для SSH-транспортов используется инструмент ssh CLI вместо paramiko.

Выбор:

false ← (по умолчанию)
true

validate_certs

aliases: tls_verify

boolean

Обеспечение безопасности соединения с API с помощью TLS и проверка подлинности сервера Docker.

Если значение не указано в задаче, будет использовано значение переменной среды DOCKER_TLS_VERIFY. Если переменная среды не задана, будет использовано значение по умолчанию.

Выбор:

false ← (по умолчанию)
true

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группы действий: community.docker.docker, docker	Используйте `group/docker` или `group/community.docker.docker` в `module_defaults` для установки значений по умолчанию для данного модуля.
check_mode	Поддержка: нет	Может работать в режиме `check_mode` и возвращать прогнозируемый статус изменений без изменения целевого объекта.
diff_mode	Поддержка: нет	В режиме diff вернёт подробности о внесённых изменениях (или, возможно, требующихся в `check_mode`),

Примечания

Примечание

Подключиться к демону Docker, предоставив параметры с каждой задачей или определив переменные среды. Вы можете определить DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_SSL_VERSION, DOCKER_TLS, DOCKER_TLS_VERIFY и DOCKER_TIMEOUT. Если вы используете docker machine, запустите предоставленный с продуктом скрипт для настройки среды. Он установит эти переменные за вас. Для получения дополнительной информации см. https://docs.docker.com/machine/reference/env/.
Данный модуль не использует Docker SDK для Python для взаимодействия с демоном Docker. Он использует код, полученный из Docker SDK или Python, который включён в этот сборник.

См. также

community.docker.docker_image_pull: Загрузка изображений Docker из реестров.
community.docker.docker_image_remove: Удаление изображений Docker.
community.docker.docker_image_tag: Установка тегов для изображений Docker с новыми именами и/или тегами.

Примеры

- name: Push an image
  community.docker.docker_image_push:
    name: registry.example.com:5000/repo/image
    tag: latest

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
image словарь	Результаты проверки изображения для затронутого изображения. Возвращаемое значение: success Пример: `{}`

Авторы

Felix Fontein (@felixfontein)

Ссылки на сборник

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/docker/docker_image_push_module.html