community.docker.docker_swarm – Плагин динамической инвентаризации Ansible для узлов Docker swarm.
Примечание
Этот плагин входит в состав коллекции community.docker (версия 1.2.2).
Для его установки используйте: 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.
Требования
Ниже перечислены требования к локальному узлу-контроллеру, на котором выполняется эта инвентаризация.
- python >= 2.7
- Docker SDK для Python >= 1.10.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| api_version строка | Версия API Docker, работающего на узле Docker. По умолчанию используется последняя версия API, поддерживаемая docker-py. псевдонимы: docker_api_version | ||
| ca_cert путь | Использование сертификата CA при проверке сервера, указав путь к файлу сертификата CA. псевдонимы: tls_ca_cert, cacert_path | ||
| client_cert путь | Путь к файлу TLS-сертификата клиента. псевдонимы: tls_client_cert, cert_path | ||
| client_key путь | Путь к файлу TLS-ключа клиента. псевдонимы: tls_client_key, key_path | ||
| compose словарь | По умолчанию: {} | Создать переменные из выражений Jinja2. | |
| docker_host строка / обязательно | Сокет узла-менеджера Docker swarm ( tcp, unix).Используйте unix://var/run/docker.sock для подключения через локальный сокет.псевдонимы: docker_url | ||
| groups словарь | По умолчанию: {} | Добавление узлов в группу на основе условных выражений Jinja2. | |
| include_host_uri логическое значение |
| Включить дополнительный атрибут ansible_host_uri, который содержит URI ведущего узла swarm в формате tcp://172.16.0.1:2376. Это значение можно использовать без дополнительных изменений в качестве значения параметра docker_host в модулях Docker Swarm при подключении через API. Порт всегда по умолчанию равен 2376. | |
| include_host_uri_port целое число | Переопределение номера порта, включённого в ansible_host_uri
| ||
| keyed_groups список / элементы=строка | По умолчанию: [] | Добавление узлов в группу на основе значений переменной. | |
| leading_separator логическое значение добавлен в 2.11 ansible.builtin |
| Использование совместно с keyed_groups. По умолчанию имя ключированной группы, у которой нет префикса или разделителя, начинается с подчёркивания. Это связано с тем, что по умолчанию префикс равен "", а разделитель равен "_". Установите этот параметр в значение False, чтобы опустить ведущий подчёркивание (или другой разделитель), если префикс не задан. Если имя группы получено из отображения, разделитель по-прежнему используется для конкатенации элементов. Чтобы вообще не использовать разделитель в имени группы, установите разделитель для ключированной группы в пустую строку вместо этого. | |
| plugin строка / обязательно |
| Имя этого плагина, оно всегда должно быть установлено в community.docker.docker_swarm для того, чтобы плагин распознавал его как свой. | |
| ssl_version строка | Укажите корректный номер версии SSL. Значение по умолчанию определяется модулем ssl.py. | ||
| strict логическое значение |
| Если yes сделать неверные записи ошибкой, иначе пропустить и продолжить.Поскольку в выражениях можно использовать факты, они могут быть недоступны, и мы по умолчанию игнорируем такие ошибки. | |
| timeout целое число | По умолчанию: 60 | Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, вместо него используется значение переменной среды DOCKER_TIMEOUT. Если переменная среды не установлена, используется значение по умолчанию.псевдонимы: time_out | |
| tls логическое значение |
| Подключение с использованием TLS без проверки подлинности сервера Docker. | |
| tls_hostname строка | При проверке подлинности сервера Docker укажите ожидаемое имя сервера. | ||
| use_extra_vars логическое значение добавлен в 2.11 of ansible.builtin |
| записи ini: [inventory_plugins] переменная окружения:ANSIBLE_INVENTORY_USE_EXTRA_VARS | Объединение дополнительных переменных с доступными переменными для компоновки (наивысший приоритет). |
| validate_certs логическое значение |
| Включение/выключение подключения с использованием TLS с или без проверки подлинности сервера Docker. псевдонимы: tls_verify | |
| verbose_output логическое значение |
| Включение/отключение отображения всей доступной метаинформации узлов (например, Platform, Architecture, OS, EngineVersion). |
Примеры
# 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: yes
# 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: yes
ca_cert: /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 e.g. x86_64 hosts to an arch_x86_64 group
- prefix: arch
key: 'Description.Platform.Architecture'
# add e.g. linux hosts to an os_linux group
- prefix: os
key: 'Description.Platform.OS'
# create a group per node label
# e.g. 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) <stefan.heitmueller@gmx.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/docker/docker_swarm_inventory.html
