community.docker.docker_image_load модуль — Загрузка изображений Docker из архивов

Примечание

Этот модуль является частью коллекции community.docker (версия 3.13.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, и вернуть информацию о загруженном(ых) изображении(ях).

Требования

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

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-сокету для подключения к API Docker. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL соединения на `https`. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_HOST`. Если переменная среды не установлена, будет использовано значение по умолчанию. По умолчанию: `"unix:///var/run/docker.sock"`
path путь / обязательно	Путь к архиву `.tar` для загрузки изображений Docker.
ssl_version строка	Укажите версию SSL. Значение по умолчанию определяется модулем SSL Python. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_SSL_VERSION`.
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` 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	Поддержка: none	Может работать в `check_mode` и возвращать прогноз состояния изменений без модификации целевого объекта.
diff_mode	Поддержка: none	Возвратит детали о том, что изменилось (или, возможно, нужно изменить в `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_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 список / элементы=строка	Список имён и идентификаторов изображений, загруженных из архива. Возвращается: успех Пример: `["hello-world:latest", "sha256:e004c2cc521c95383aebb1fb5893719aa7a8eae2e7a71f316a4410784edb00a9"]`
images список / элементы=словарь	Результаты проверки изображений для загруженных изображений. Возвращается: успех Пример: `[]`

Авторы

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