Модуль community.docker.docker_compose_v2_pull — Скачать проект Docker Compose

Примечание

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

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

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

Для использования в плейбуке укажите: community.docker.docker_compose_v2_pull.

Новое в community.docker 3.6.0

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

Описание

Использует Docker Compose для скачивания изображений для проекта.

Требования

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

Docker CLI с плагином Docker compose 2.18.0 или более поздней версии
PyYAML, если используется definition

Параметры

Параметр	Комментарии
api_version псевдонимы: docker_api_version строка	Версия API Docker, работающая на Docker Host. По умолчанию используется последняя версия 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`.
check_files_existing булево добавлен в community.docker 3.9.0	Если установлено значение `false`, модуль не будет проверять наличие одного из файлов `compose.yaml`, `compose.yml`, `docker-compose.yaml`, или `docker-compose.yml` в `project_src`, если `files` не указано. Это может быть полезно, если файлы окружения с `COMPOSE_FILE` используются для конфигурации другого имени файла. Модуль в настоящее время не проверяет `COMPOSE_FILE` в файлах окружения или текущей среде. Варианты: `false` `true` ← (по умолчанию)
cli_context строка	Контекст Docker CLI для использования. Взаимоисключающее с `docker_host`.
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`.
definition словарь добавлен в community.docker 3.9.0	Файл Compose, описывающий один или несколько сервисов, сетей и томов. Взаимоисключающее с `project_src` и `files`. Один из `project_src` и `definition` должен быть предоставлен. При использовании этого параметра PyYAML должен быть доступен в модуле, и `project_name` должен быть указан. Обратите внимание, что при использовании этого параметра будет создан и удален временный каталог.
docker_cli путь	Путь к Docker CLI. Если не указано, будет поиск Docker CLI в `PATH`.
docker_host псевдонимы: docker_url строка	URL или путь к Unix-сокету для подключения к API Docker. Для подключения к удаленному хосту укажите строку TCP-соединения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL подключения на `https`. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_HOST`. Если переменная окружения не установлена, будет использовано значение по умолчанию. Взаимоисключающее с `cli_context`. Если ни `docker_host` ни `cli_context` не указаны, используется значение `unix:///var/run/docker.sock`.
env_files список / элементы=путь	По умолчанию файлы окружения загружаются из файла `.env`, расположенного непосредственно в каталоге `project_src`. `env_files` может быть использовано для указания пути к одному или нескольким пользовательским файлам окружения. Путь относительный к каталогу `project_src`.
files список / элементы=путь добавлен в community.docker 3.7.0	Список имён файлов Compose, относительных к `project_src` для использования вместо основного файла Compose (`compose.yml`, `compose.yaml`, `docker-compose.yml`, или `docker-compose.yaml`). Файлы загружаются и объединяются в указанном порядке. Взаимоисключающее с `definition`.
ignore_buildable булево добавлен в community.docker 3.12.0	Если установлено значение `true`, не будут извлекаться образы, которые могут быть скомпилированы. Варианты: `false` ← (по умолчанию) `true`

END_OF_DOCUMENT_MARKER

include_deps boolean added in community.docker 3.12.0	Если установлено в `true`, также подтянет сервисы, объявленные как зависимости. Это имеет смысл только если используется `services`. Варианты: `false` ← (по умолчанию) `true`
policy string	Определяет, нужно ли подтягивать образы перед запуском. Используется при выполнении `docker compose up`. `always` гарантирует, что образы всегда подтягиваются, даже если они уже присутствуют на Docker-демон. `missing` подтягивает их только если они отсутствуют на Docker-демон. Поддерживается начиная с Docker Compose 2.22.0. Варианты: `"always"` ← (по умолчанию) `"missing"`
profiles list / elements=string	Список профилей, которые нужно включить при запуске сервисов. Эквивалентно `docker compose --profile`.
project_name string	Укажите имя проекта. Если не указано, имя проекта берется из базового имени `project_src`. Требуется при указании `definition`.
project_src path	Путь к каталогу, содержащему файл Compose (`compose.yml`, `compose.yaml`, `docker-compose.yml`, или `docker-compose.yaml`). Если указано `files`, файлы будут искать в этом каталоге. Взаимоисключающие с `definition`. Один из `project_src` и `definition` должен быть указан.
services list / elements=string added in community.docker 3.12.0	Указывает подмножество сервисов, на которые будет нацелено действие.
tls boolean	Защитите соединение с API, используя TLS без проверки подлинности сервера Docker-хоста. Обратите внимание, что если `validate_certs` также установлено в `true`, оно будет иметь приоритет. Если значение не указано в задаче, будет использоваться значение переменной среды `DOCKER_TLS`. Если переменная среды не задана, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`
tls_hostname string	При проверке подлинности Docker-хоста укажите ожидаемое имя сервера. Если значение не указано в задаче, будет использоваться значение переменной среды `DOCKER_TLS_HOSTNAME`. Если переменная среды не задана, будет использовано значение по умолчанию.
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	Поддержка: полная Если `policy=always`, модуль всегда укажет изменение. Docker Compose не предоставляет никакой информации о том, обновит ли подтягивание образ или нет.	Может работать в режиме `check_mode` и возвращать прогноз изменения статуса без модификации целевого объекта.
diff_mode	Поддержка: нет	При использовании режима diff вернет детали о том, что изменилось (или возможно должно измениться в `check_mode`).

Примечания

Примечание

Плагин Docker Compose CLI не имеет стабильного формата вывода (см., например, https://github.com/docker/compose/issues/10872), и для основных операций также нет удобного для машины формата вывода. Модуль пытается учесть это с помощью различных корректировок поведения, зависящих от версии, и с тестированием более старых и новых версий плагина Docker Compose CLI. В настоящее время модуль протестирован с несколькими версиями плагина между 2.18.1 и 2.23.3. Точный список версий плагина со временем изменится. Новые релизы плагина Docker Compose CLI могут сломать этот модуль в любое время.
Подключитесь к демону 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 для Python для связи с демоном Docker. Он напрямую вызывает программу Docker CLI.

См. также

community.docker.docker_compose_v2: Управление многоконтейнерными приложениями Docker с помощью плагина Docker Compose CLI.

Примеры

- name: Pull images for flask project
  community.docker.docker_compose_v2_pull:
    project_src: /path/to/flask

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

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

Ключ	Описание
actions список / элементы=словарь	Список действий, которые были применены. Возвращено: успех
id строка	Идентификатор ресурса, который был изменен. Возвращено: успех Пример: `"container"`
status строка	Изменение статуса, которое произошло. Возвращено: успех Может возвращать только: `"Pulling"` Пример: `"Pulling"`
what строка	Тип ресурса, который был изменен. Возвращено: успех Может возвращать только: `"image"` `"unknown"` Пример: `"container"`

Авторы

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