Модуль community.docker.docker_compose_v2_pull — загрузка образов проекта Docker Compose

Примечание

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

Примечания

Примечание

У плагина 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 list / elements=dictionary	Список выполненных действий. Возвращается: при успехе
id string	Идентификатор изменённого ресурса. Возвращается: при успехе Пример: `"container"`
status string	Произошедшее изменение статуса. Возвращается: при успехе Возможные значения: `"Pulling"` Пример: `"Pulling"`
what string	Тип изменённого ресурса. Возвращается: при успехе Возможные значения: `"image"` `"unknown"` Пример: `"container"`

Авторы

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