Модуль community.docker.docker_image_load — загрузка образов Docker из архивов

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.docker.docker_image_load.

Добавлено в community.docker 1.3.0

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

Краткое описание

Загружает один или несколько образов Docker из архива .tar и возвращает сведения о загруженных образах.

Требования

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

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

Параметры

Параметр	Комментарии
api_version псевдонимы: docker_api_version string	Версия Docker API, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая этой коллекцией и демоном Docker. Если значение не указано в задаче, вместо него используется значение переменной окружения `DOCKER_API_VERSION`. Если переменная окружения не задана, используется значение по умолчанию. По умолчанию: `"auto"`
ca_path псевдонимы: ca_cert, tls_ca_cert, cacert_path path	Для проверки сервера используйте сертификат центра сертификации, указав путь к файлу сертификата. Если значение не указано в задаче, а переменная окружения `DOCKER_CERT_PATH` задана, будет использоваться файл `ca.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Ранее этот параметр назывался `ca_cert`; в community.docker 3.6.0 его переименовали в `ca_path`. Старое имя добавлено как псевдоним и по-прежнему может использоваться.
client_cert псевдонимы: tls_client_cert, cert_path path	Путь к файлу TLS-сертификата клиента. Если значение не указано в задаче, а переменная окружения `DOCKER_CERT_PATH` задана, будет использоваться файл `cert.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
client_key псевдонимы: tls_client_key, key_path path	Путь к файлу TLS-ключа клиента. Если значение не указано в задаче, а переменная окружения `DOCKER_CERT_PATH` задана, будет использоваться файл `key.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
debug boolean	Режим отладки Варианты: `false` ← (по умолчанию) `true`
docker_host псевдонимы: docker_url string	URL или путь к сокету Unix для подключения к Docker API. Для подключения к удалённому хосту укажите строку TCP-подключения. Например, `tcp://192.0.2.23:2376`. Если для шифрования подключения используется TLS, модуль автоматически заменит `tcp` в URL подключения на `https`. Если значение не указано в задаче, вместо него используется значение переменной окружения `DOCKER_HOST`. Если переменная окружения не задана, используется значение по умолчанию. По умолчанию: `"unix:///var/run/docker.sock"`
path path / обязательный	Путь к архиву `.tar`, из которого нужно загрузить образы Docker.
timeout integer	Максимальное время ожидания ответа от 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 псевдонимы: 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`).
idempotent	Поддержка: отсутствует	При повторном запуске с теми же аргументами вне режима проверки модуль сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или к которой он обращается, не изменилась существенным образом.

Примечания

Примечание

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

См. также

community.docker.docker_image_export: Экспорт образов Docker в архив.
community.docker.docker_image_push: Отправка образов Docker в реестры.
community.docker.docker_image_remove: Удаление образов Docker.
community.docker.docker_image_tag: Назначение образам Docker новых имён и/или тегов.

Примеры

---
- name: Load all image(s) from the given tar file
  community.docker.docker_image_load:
    path: /path/to/images.tar
  register: result

- name: Print the loaded image names
  ansible.builtin.debug:
    msg: "Loaded the following images: {{ result.image_names | join(', ') }}"

Возвращаемые значения

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

Ключ	Описание
image_names list / элементы=string	Список имён и идентификаторов образов, загруженных из архива. Возвращается: success Пример: `["hello-world:latest", "sha256:e004c2cc521c95383aebb1fb5893719aa7a8eae2e7a71f316a4410784edb00a9"]`
images list / элементы=dictionary	Результаты проверки загруженных образов. Возвращается: success Пример: `[]`

Авторы

Felix Fontein (@felixfontein)

Ссылки на коллекцию

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