Модуль community.docker.docker_image_tag — Разметка изображений Docker с новыми именами и/или тегами

Примечание

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

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

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

Для использования в книге задач укажите: community.docker.docker_image_tag.

Новая функция в 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 Host. По умолчанию используется последняя версия 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-сокету для подключения к API Docker. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если TLS используется для шифрования подключения, модуль автоматически заменит `tcp` в URL подключения на `https`. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_HOST`. Если переменная окружения не задана, используется значение по умолчанию. По умолчанию: `"unix:///var/run/docker.sock"`
existing_images строка	Определяет поведение, если изображение, которое нужно пометить, уже существует и является другим изображением, отличным от того, которое идентифицировано по `name` и `tag`. Если установлено `keep`, помеченное изображение сохраняется. Если установлено `overwrite`, помеченное изображение перезаписывается указанным. Варианты: `"keep"` `"overwrite"` ← (по умолчанию)
name строка / обязательно	Имя изображения. Формат имени будет одним из: `name`, `repository/name`, `registry_server:port/name`. При отправке или извлечении изображения имя может необязательно включать метку, добавив `:tag_name`. Обратите внимание, что можно также использовать идентификаторы изображений (хеши).
repository список / элементы=строка / обязательно	Список новых имён изображений для метки изображения. Ожидается формат `repository:tag`. Если метка не указана, используется значение параметра `tag`, если он присутствует, или `latest`.
ssl_version строка	Укажите допустимое значение номера версии SSL. Значение по умолчанию определяется модулем SSL Python. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_SSL_VERSION`.
tag строка	Метка для имени изображения `name`, которое нужно пометить. Если формат `name` — `name:tag`, значение метки из `name` имеет приоритет. По умолчанию: `"latest"`
timeout целое число	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, используется значение переменной окружения `DOCKER_TIMEOUT`. Если переменная окружения не задана, используется значение по умолчанию. По умолчанию: `60`

tls boolean	Защитите подключение к API, используя TLS без проверки подлинности сервера Docker. Обратите внимание, что если `validate_certs` установлено в `true`, оно будет иметь приоритет. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TLS`. Если переменная среды не задана, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`
tls_hostname string	При проверке подлинности сервера Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TLS_HOSTNAME`. Если переменная среды не задана, будет использовано значение по умолчанию. Обратите внимание, что в более старых версиях этот параметр имел значение `localhost` по умолчанию. Он был удален в community.docker 3.0.0.
use_ssh_client boolean Добавлен в community.docker 1.5.0	Для SSH-транспортов используйте инструмент командной строки `ssh` вместо 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	Поддержка: полная	Возвращает подробную информацию о внесённых изменениях (или, возможно, необходимых изменениях в `check_mode` ), когда используется режим diff.

Примечания

Примечание

Подключение к демону 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_push: Опубликовать Docker образы в реестры.
community.docker.docker_image_remove: Удалить Docker образы.

Примеры

- name: Tag Python 3.12 image with two new names
  community.docker.docker_image_tag:
    name: python:3.12
    repository:
      - python-3:3.12
      - local-registry:5000/python-3/3.12:latest

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

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

Ключ	Описание
image словарь	Результаты проверки изображения для затронутого изображения. Возвращено: успех Пример: `{}`
tagged_images список / элементы=строка	Список изображений, которые получили теги. Возвращено: успех Пример: `["python-3:3.12"]`

Авторы

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_tag_module.html