community.docker.docker_swarm inventory – плагин динамической инвентаризации Ansible для узлов Docker Swarm

Примечание

Этот плагин инвентаризации входит в коллекцию community.docker (версия 5.2.0).

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

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

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

Краткое описание
Требования
Параметры
Примечания
Примеры

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

Читает инвентаризацию из API Docker Swarm.
Использует файл конфигурации YAML, имя которого заканчивается на docker_swarm.(yml|yaml).
Плагин возвращает следующие группы узлов Swarm: all — все узлы; workers — все рабочие узлы; managers — все узлы-менеджеры; leader — узел-лидер Swarm; nonleaders — все узлы, кроме узла-лидера Swarm.

Требования

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

Docker SDK for Python >= 1.10.0

Параметры

Параметр	Комментарии
api_version псевдонимы: docker_api_version string	Версия API Docker, работающего на узле Docker. По умолчанию используется последняя версия API, поддерживаемая Docker SDK for Python.
ca_path псевдонимы: ca_cert, tls_ca_cert, cacert_path path	Используйте сертификат CA при проверке сервера, указав путь к файлу сертификата CA. Ранее этот параметр назывался `ca_cert`; в community.docker 3.6.0 его переименовали в `ca_path`. Старое имя добавлено в качестве псевдонима и по-прежнему может использоваться.
client_cert псевдонимы: tls_client_cert, cert_path path	Путь к файлу TLS-сертификата клиента.
client_key псевдонимы: tls_client_key, key_path path	Путь к файлу TLS-ключа клиента.
compose dictionary	Создавать переменные на основе выражений Jinja2. По умолчанию: `{}`
docker_host псевдонимы: docker_url string / обязательный	Сокет узла-менеджера Docker Swarm (`tcp`, `unix`). Используйте `unix:///var/run/docker.sock` для подключения через локальный сокет.
filters list / elements=dictionary добавлено в community.docker 3.5.0	Список фильтров включения и исключения, позволяющих выбирать или исключать узлы из этой инвентаризации. Фильтры обрабатываются последовательно до первого фильтра, которому соответствует `filters[].exclude` или `filters[].include`. Если соответствует `filters[].exclude`, узел исключается; если соответствует `filters[].include`, узел включается. Если ни один фильтр не совпал, узел включается.
exclude string	Условие Jinja2. Если оно выполняется для узла, этот узел исключается. Можно указать только один из параметров `filters[].exclude` и `filters[].include`.
include string	Условие Jinja2. Если оно выполняется для узла, этот узел включается. Можно указать только один из параметров `filters[].exclude` и `filters[].include`.
groups dictionary	Добавлять узлы в группы на основе условий Jinja2. По умолчанию: `{}`
include_host_uri boolean	Включить или отключить возврат дополнительного атрибута `ansible_host_uri`, содержащего URI узла-лидера Swarm в формате `tcp://172.16.0.1:2376`. Это значение можно использовать без изменений в качестве значения параметра `docker_host` в модулях Docker Swarm при подключении через API. По умолчанию порт всегда равен `2376`. Варианты: `false` ← (по умолчанию) `true`
include_host_uri_port integer	Переопределить обнаруженный номер порта, включаемый в `ansible_host_uri`.
keyed_groups list / elements=dictionary	Добавлять узлы в группы на основе значений переменной. По умолчанию: `[]`
default_value string добавлено в ansible-core 2.12	Значение по умолчанию, если значение переменной узла равно `None` или представляет собой пустую строку. Этот параметр нельзя использовать одновременно с `keyed_groups[].trailing_separator`.
key string	Ключ входного словаря, используемый для создания групп.
parent_group string	Родительская группа для группы, созданной по ключу.
prefix string	Имя группы, созданной по ключу, будет начинаться с этого префикса. По умолчанию: `""`
separator string	Разделитель, используемый для формирования имени группы по ключу. По умолчанию: `"_"`
trailing_separator boolean добавлено в ansible-core 2.12	Установите этот параметр в `false`, чтобы не добавлять `keyed_groups[].separator` после переменной узла, если ее значение равно `None` или представляет собой пустую строку. Этот параметр нельзя использовать одновременно с `keyed_groups[].default_value`. Варианты: `false` `true` ← (по умолчанию)
leading_separator boolean добавлено в ansible-core 2.11	Используется вместе с `keyed_groups`. По умолчанию имя группы, созданной по ключу, для которой не задан префикс или разделитель, начинается с символа подчеркивания. Это связано с тем, что префикс по умолчанию — `""`, а разделитель по умолчанию — `"_"`. Установите этот параметр в `false`, чтобы не добавлять начальный символ подчеркивания (или другой разделитель), если префикс не задан. Если имя группы формируется из отображения, разделитель по-прежнему используется для объединения элементов. Чтобы вообще не использовать разделитель в имени группы, задайте для группы по ключу пустую строку в качестве разделителя. Варианты: `false` `true` ← (по умолчанию)
plugin string / обязательный	Имя этого плагина. Чтобы плагин распознал конфигурацию как свою, здесь всегда должно быть указано `community.docker.docker_swarm`. Варианты: `"docker_swarm"` `"community.docker.docker_swarm"`
strict boolean	Если `yes`, некорректные записи приводят к фатальной ошибке; в противном случае они пропускаются, а выполнение продолжается. Поскольку в выражениях можно использовать факты, они могут быть доступны не всегда; по умолчанию такие ошибки игнорируются. Варианты: `false` ← (по умолчанию) `true`
timeout псевдонимы: time_out integer	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_TIMEOUT`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `60`
tls boolean	Подключаться с использованием TLS без проверки подлинности сервера узла Docker. Варианты: `false` ← (по умолчанию) `true`
tls_hostname string	При проверке подлинности сервера узла Docker укажите ожидаемое имя сервера.
use_extra_vars boolean добавлено в ansible-core 2.11	Объединять дополнительные переменные с доступными переменными для формирования значений (наивысший приоритет). Варианты: `false` ← (по умолчанию) `true` Конфигурация: Запись INI: [inventory_plugins] use_extra_vars = false Переменная окружения: `ANSIBLE_INVENTORY_USE_EXTRA_VARS`
use_ssh_client boolean добавлено в community.docker 1.5.0	Для SSH-транспорта использовать инструмент командной строки `ssh` вместо paramiko. Требуется Docker SDK for Python версии 4.4.0 или новее. Варианты: `false` ← (по умолчанию) `true`
validate_certs псевдонимы: tls_verify boolean	Включить или отключить проверку подлинности сервера узла Docker при подключении с использованием TLS. Варианты: `false` ← (по умолчанию) `true`
verbose_output boolean	Включить или отключить вывод всех доступных метаданных узлов (например, `Platform`, `Architecture`, `OS`, `EngineVersion`). Варианты: `false` `true` ← (по умолчанию)

Примечание

Для перечисленных выше параметров конфигурации (переменных Ansible, переменных окружения и т. д.) действует порядок приоритета от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше. Типы записей также упорядочены по приоритету от низкого к высокому. Например, запись ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примечания

Примечание

Файл конфигурации должен быть файлом YAML, имя которого заканчивается на docker_swarm.yml или docker_swarm.yaml. Файлы с другими именами не принимаются.
На этом этапе инвентаризация еще не окончательно сформирована, поэтому автоматически заполненные группы all и ungrouped будут отражать только то, что явно добавили в них предыдущие источники инвентаризации.
Во время построения инвентаризации недоступны «магические переменные» времени выполнения. Например, groups и hostvars еще не существуют.

Примеры

---
# Minimal example using local docker
plugin: community.docker.docker_swarm
docker_host: unix:///var/run/docker.sock

---
# Minimal example using remote docker
plugin: community.docker.docker_swarm
docker_host: tcp://my-docker-host:2375

---
# Example using remote docker with unverified TLS
plugin: community.docker.docker_swarm
docker_host: tcp://my-docker-host:2376
tls: true

---
# Example using remote docker with verified TLS and client certificate verification
plugin: community.docker.docker_swarm
docker_host: tcp://my-docker-host:2376
validate_certs: true
ca_path: /somewhere/ca.pem
client_key: /somewhere/key.pem
client_cert: /somewhere/cert.pem

---
# Example using constructed features to create groups and set ansible_host
plugin: community.docker.docker_swarm
docker_host: tcp://my-docker-host:2375
strict: false
keyed_groups:
  # add for example x86_64 hosts to an arch_x86_64 group
  - prefix: arch
    key: 'Description.Platform.Architecture'
  # add for example linux hosts to an os_linux group
  - prefix: os
    key: 'Description.Platform.OS'
  # create a group per node label
  # for exomple a node labeled w/ "production" ends up in group "label_production"
  # hint: labels containing special characters will be converted to safe names
  - key: 'Spec.Labels'
    prefix: label

Авторы

Stefan Heitmüller (@morph027)

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

© 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_swarm_inventory.html