Модуль community.docker.docker_image_export — экспорт (архивирование) образов Docker

Примечание

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

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

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

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

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

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

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

Создаёт архив (tarball) из одного или нескольких образов Docker.
Архив можно скопировать на другую машину и загрузить с помощью community.docker.docker_image_load.

Требования

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

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	Для проверки сервера используйте сертификат 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 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"`
force boolean	Экспортировать образ, даже если файл `.tar` уже существует и, по-видимому, содержит нужный образ. Варианты: `false` ← (по умолчанию) `true`
names псевдонимы: name list / элементы=string / обязательный	Одно или несколько имён образов. Формат имени может быть одним из следующих: `name`, `repository/name`, `registry_server:port/name`. При отправке или загрузке образа к имени можно добавить тег, дописав `:tag_name`. Также можно использовать идентификаторы образов (хеши).
path path	Файл `.tar`, в который нужно экспортировать образ.
platform string добавлено в community.docker 5.2.0	При экспорте запросить указанную платформу. Например, `linux/amd64`, `linux/arm64`. Требуется Docker API версии 1.48 или новее.
tag string	Тег для имени образа `name`, которому нужно назначить тег. Если формат `name` — `name:tag`, значение тега из `name` будет иметь приоритет. По умолчанию: `"latest"`
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	Поддержка: full	Может работать в режиме `check_mode` и возвращать предполагаемый статус изменений, не изменяя целевую систему.
diff_mode	Поддержка: none	В режиме diff возвращаются сведения об изменениях (или о том, что, возможно, нужно изменить в `check_mode`).
idempotent	Поддержка: partial Идемпотентность модуля зависит от API хранилища образов, которое определяет способ вычисления идентификатора образа. Для проверки идемпотентности требуется, чтобы идентификатор образа совпадал с идентификатором, сохранённым в `manifest.json` архива. Судя по всему, со стандартной серверной частью хранилища это работало вплоть до Docker 28, но в Docker 29 поведение, по-видимому, изменилось. Этот модуль не является идемпотентным при работе с образами для нескольких архитектур, независимо от версии Docker. Полная идемпотентность обеспечивается только в Docker 28 или более ранней версии и при использовании образа для одной архитектуры.	При повторном запуске с теми же аргументами вне режима check второй запуск сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или которую он опрашивает, не изменилась существенным образом.

Примечания

Примечание

Подключайтесь к демону 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: Управление образами Docker.
community.docker.docker_image_info: Проверка образов Docker.
community.docker.docker_image_load: Загрузка образов Docker из архивов.

Примеры

---
- name: Export an image
  community.docker.docker_image_export:
    name: pacur/centos-7
    path: /tmp/centos-7.tar

- name: Export multiple images
  community.docker.docker_image_export:
    names:
      - hello-world:latest
      - pacur/centos-7:latest
    path: /tmp/various.tar

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

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

Ключ	Описание
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_export_module.html