Модуль community.docker.docker_image_tag – присвоение образам Docker новых имён и/или тегов

api_version

псевдонимы: docker_api_version

строка

Версия Docker API, работающая на хосте Docker.

По умолчанию используется последняя версия API, поддерживаемая этой коллекцией и демоном Docker.

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

По умолчанию: "auto"

ca_path

псевдонимы: ca_cert, tls_ca_cert, cacert_path

путь

Для проверки подлинности сервера укажите путь к файлу сертификата центра сертификации (CA).

Если значение не указано в задаче, а переменная окружения DOCKER_CERT_PATH задана, будет использован файл ca.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

До community.docker 3.6.0 этот параметр назывался ca_cert, а в версии 3.6.0 был переименован в ca_path. Старое имя добавлено в качестве псевдонима и по-прежнему может использоваться.

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"

existing_images

строка

Определяет поведение, если образ, которому присваивается тег, уже существует и отличается от образа, определённого с помощью name и tag.

Если задано значение keep, образ с таким тегом сохраняется.

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

Варианты:

• "keep"
• "overwrite" ← (по умолчанию)

name

строка / обязательный

Имя образа. Имя должно иметь один из следующих форматов: name, repository/name, registry_server:port/name. При отправке или загрузке образа к имени можно добавить тег, дописав :tag_name.

Также можно использовать идентификаторы образов (хеши).

repository

список / элементы=строка / обязательный

Список новых имён, которые будут присвоены образу в качестве тегов.

Ожидается формат repository:tag. Если тег не указан, используется значение параметра tag, если он задан, или latest.

tag

строка

Тег для имени образа name, которому присваивается новый тег.

Если формат name — name:tag, приоритет имеет значение тега из name.

По умолчанию: "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

логическое значение

добавлено в community.docker 1.5.0

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

Варианты:

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

validate_certs

псевдонимы: tls_verify

логическое значение

Защитить соединение с 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).

idempotent

Поддержка: полная

При повторном запуске с теми же аргументами вне режима проверки второй запуск сообщает об отсутствии изменений.

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

image

словарь

Результаты проверки затронутого образа.

Возвращается: при успешном выполнении

Пример: {}

tagged_images

список / элементы=строка

Список образов, которым были присвоены теги.

Возвращается: при успешном выполнении

Пример: ["python-3:3.12"]