community.general.docker_swarm – Подключаемый модуль динамической инвентаризации Ansible для узлов Docker swarm.
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.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 список / элементы=строка | По умолчанию: [] | Добавление узлов в группу на основе значений переменной. | |
| plugin строка / обязательно |
| Имя этого плагина, оно должно всегда быть установлено в community.general.docker_swarm для распознавания плагина. | |
| ssl_version строка | Укажите версию SSL. Значение по умолчанию определяется модулем ssl.py. | ||
| strict логическое |
| Если yes сделать недопустимые записи ошибкой, иначе пропустить и продолжить.Поскольку в выражениях можно использовать факты, они могут не всегда быть доступны, поэтому такие ошибки по умолчанию игнорируются. | |
| timeout целое число | По умолчанию: 60 | Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, используется значение переменной окружения DOCKER_TIMEOUT. Если переменная окружения не установлена, используется значение по умолчанию.псевдонимы: time_out | |
| tls логическое |
| Подключение с использованием TLS без проверки подлинности хоста Docker. | |
| tls_hostname строка | При проверке подлинности хоста Docker укажите ожидаемое имя сервера. | ||
| validate_certs логическое |
| Включить или выключить проверку подлинности хоста Docker при подключении через TLS. псевдонимы: tls_verify | |
| verbose_output логическое |
| Включить/выключить вывод всех доступных данных о узлах (например, Platform, Architecture, OS, EngineVersion) |
Примеры
# Minimal example using local docker
plugin: community.general.docker_swarm
docker_host: unix://var/run/docker.sock
# Minimal example using remote docker
plugin: community.general.docker_swarm
docker_host: tcp://my-docker-host:2375
# Example using remote docker with unverified TLS
plugin: community.general.docker_swarm
docker_host: tcp://my-docker-host:2376
tls: yes
# Example using remote docker with verified TLS and client certificate verification
plugin: community.general.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.general.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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/docker_swarm_inventory.html
