Модуль community.docker.docker_image_pull — загрузка образов 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 для проверки сервера, указав путь к файлу сертификата CA.

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

Ранее этот параметр назывался ca_cert; в community.docker 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"

name

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

Имя образа. Формат имени должен соответствовать одному из вариантов: name, repository/name или registry_server:port/name.

При необходимости к имени можно добавить тег, добавив :tag_name, или указать дайджест, добавив @hash:digest.

platform

строка

Запросить эту конкретную платформу при загрузке.

pull

строка

Определяет, когда загружать образ.

Если указано always, образ будет загружаться всегда.

Если указано not_present, образ будет загружен только в том случае, если образ с таким именем отсутствует в текущем демоне Docker или если platform не совпадает.

Варианты:

• "always" ← (по умолчанию)
• "not_present"

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

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

добавлено в 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

Поддержка: частичная

При попытке загрузить образ с помощью pull=always модуль в режиме проверки считает, что состояние всегда изменяется.

Если режим проверки используется вместе с режимом сравнения, ID загруженного образа всегда отображается в сравнении как unknown.

Может выполняться в check_mode и возвращать прогноз изменения состояния, не изменяя целевой узел.

diff_mode

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

В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в check_mode).

idempotent

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

При повторном запуске подряд с теми же аргументами вне режима проверки второе выполнение не сообщает об изменениях.

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

image

словарь

Результаты проверки сведений об измененном образе.

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

Пример: {}