community.docker.docker_swarm_info – Извлекает сведения о кластере Docker Swarm.
Примечание
Этот плагин входит в коллекцию community.docker (версия 1.2.2).
Для его установки используйте: ansible-galaxy collection install community.docker.
Для использования в книге задач укажите: community.docker.docker_swarm_info.
Обзор
- Извлекает сведения о кластере Docker Swarm.
- Возвращает списки имён объектов Swarm для служб — узлов, служб, задач.
- Вывод отличается в зависимости от версии API, доступной на хосте Docker.
- Должен выполняться на узле Swarm Manager; в противном случае модуль завершается с сообщением об ошибке. Он возвращает логические флаги как при ошибках, так и при успешном выполнении, указывающие, можно ли взаимодействовать с демоном Docker, находится ли он в режиме Swarm и является ли он узлом Swarm Manager.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- Docker API >= 1.24
- Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменён на docker (см. здесь для получения подробностей). Для Python 2.6 необходимо использовать
docker-py. В противном случае рекомендуется установить модуль Pythondocker. Обратите внимание, что оба модуля не должны устанавливаться одновременно. Также обратите внимание, что при установке и последующем удалении одного из этих модулей другой может перестать работать, и потребуется его повторная установка. - Docker SDK для Python >= 1.10.0 (используйте docker-py для Python 2.6)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_version строка | По умолчанию: "auto" | Версия Docker API, работающая на хосте Docker. По умолчанию устанавливается последняя версия API, поддерживаемая Docker SDK для Python и демоном Docker. Если значение не указано в задаче, используется значение переменной среды DOCKER_API_VERSION. Если переменная среды не задана, используется значение по умолчанию.Псевдонимы: docker_api_version |
| ca_cert путь | Используйте сертификат CA при проверке подлинности сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче и задана переменная среды DOCKER_CERT_PATH, используется файл ca.pem из каталога, указанного в переменной среды DOCKER_CERT_PATH. Псевдонимы: tls_ca_cert, cacert_path | |
| client_cert путь | Путь к файлу сертификата TLS клиента. Если значение не указано в задаче и задана переменная среды DOCKER_CERT_PATH, используется файл cert.pem из каталога, указанного в переменной среды DOCKER_CERT_PATH. Псевдонимы: tls_client_cert, cert_path | |
| client_key путь | Путь к файлу ключа TLS клиента. Если значение не указано в задаче и задана переменная среды DOCKER_CERT_PATH, используется файл key.pem из каталога, указанного в переменной среды DOCKER_CERT_PATH. Псевдонимы: tls_client_key, key_path | |
| debug булево |
| Режим отладки |
| docker_host строка | По умолчанию: "unix://var/run/docker.sock" | URL или путь к сокету Unix для подключения к Docker API. Для подключения к удалённому хосту укажите строку TCP-соединения. Например, tcp://192.0.2.23:2376. Если для шифрования соединения используется TLS, модуль автоматически заменит tcp в URL подключения на https. Если значение не указано в задаче, используется значение переменной среды DOCKER_HOST. Если переменная среды не задана, используется значение по умолчанию.Псевдонимы: docker_url |
| nodes булево |
| Список узлов Swarm. |
| nodes_filters словарь | Словарь значений фильтров, используемых для выбора узлов для отображения. Например, name: mynode. См. документацию Docker для получения дополнительной информации о возможных фильтрах. | |
| services булево |
| Список служб Swarm. |
| services_filters словарь | Словарь значений фильтров, используемых для выбора служб для отображения. Например, name: myservice. См. документацию Docker для получения дополнительной информации о возможных фильтрах. | |
| ssl_version строка | Укажите допустимое числовое значение версии SSL. Значение по умолчанию определяется модулем ssl.py. Если значение не указано в задаче, используется значение переменной среды DOCKER_SSL_VERSION. | |
| tasks булево |
| Список контейнеров. |
| tasks_filters словарь | Словарь значений фильтров, используемых для выбора задач для отображения. Например, node: mynode-1. См. документацию Docker для получения дополнительной информации о возможных фильтрах. | |
| timeout целое число | По умолчанию: 60 | Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, используется значение переменной среды DOCKER_TIMEOUT. Если переменная среды не задана, используется значение по умолчанию. |
| tls булево |
| Защитите соединение с API с помощью TLS без проверки подлинности сервера Docker. Обратите внимание, что если validate_certs также установлено в yes, он будет иметь приоритет.Если значение не указано в задаче, используется значение переменной среды DOCKER_TLS. Если переменная среды не задана, используется значение по умолчанию. |
| tls_hostname строка | По умолчанию: "localhost" | При проверке подлинности сервера Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, используется значение переменной среды DOCKER_TLS_HOSTNAME. Если переменная среды не задана, используется значение по умолчанию. |
| unlock_key булево |
| Список ключей разблокировки Swarm. |
| validate_certs булево |
| Защитите соединение с API с помощью TLS и проверьте подлинность сервера Docker. Если значение не указано в задаче, используется значение переменной среды DOCKER_TLS_VERIFY. Если переменная среды не задана, используется значение по умолчанию.Псевдонимы: tls_verify |
| verbose_output булево |
| При установке в yes и nodes, services или tasks установлено в yes, вывод модуля будет содержать подробную информацию об объектах, соответствующих полному выводу метода API.Дополнительные сведения см. в документации вашей версии Docker API по адресу https://docs.docker.com/engine/api/. Подробный вывод в этом модуле содержит только подмножество информации, возвращаемой модулем _info для каждого типа объектов. |
Примечания
Примечание
- Подключитесь к демону Docker, предоставив параметры с каждой задачей или определив переменные окружения. Вы можете определить
DOCKER_HOST,DOCKER_TLS_HOSTNAME,DOCKER_API_VERSION,DOCKER_CERT_PATH,DOCKER_SSL_VERSION,DOCKER_TLS,DOCKER_TLS_VERIFYиDOCKER_TIMEOUT. Если вы используете docker machine, запустите скрипт, поставляемый с продуктом, который настраивает среду. Он установит эти переменные за вас. См. https://docs.docker.com/machine/reference/env/ для получения более подробной информации. - При подключении к демону Docker с TLS, возможно, потребуется установить дополнительные пакеты Python. Для Docker SDK для Python, версии 2.4 или более поздней, это можно сделать, установив
docker[tls]с помощью ansible.builtin.pip. - Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень немногих функций. В общем случае он будет использовать
$HOME/.docker/config.json, если переменная окруженияDOCKER_CONFIGне указана, и использовать$DOCKER_CONFIG/config.json, в противном случае. - Этот модуль использует Docker SDK для Python для связи с демоном Docker.
Примеры
- name: Get info on Docker Swarm
community.docker.docker_swarm_info:
ignore_errors: yes
register: result
- name: Inform about basic flags
ansible.builtin.debug:
msg: |
Was able to talk to docker daemon: {{ result.can_talk_to_docker }}
Docker in Swarm mode: {{ result.docker_swarm_active }}
This is a Manager node: {{ result.docker_swarm_manager }}
- block:
- name: Get info on Docker Swarm and list of registered nodes
community.docker.docker_swarm_info:
nodes: yes
register: result
- name: Get info on Docker Swarm and extended list of registered nodes
community.docker.docker_swarm_info:
nodes: yes
verbose_output: yes
register: result
- name: Get info on Docker Swarm and filtered list of registered nodes
community.docker.docker_swarm_info:
nodes: yes
nodes_filters:
name: mynode
register: result
- ansible.builtin.debug:
var: result.swarm_facts
- name: Get the swarm unlock key
community.docker.docker_swarm_info:
unlock_key: yes
register: result
- ansible.builtin.debug:
var: result.swarm_unlock_key
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| can_talk_to_docker boolean | при успехе и при ошибке | Будет true если модуль может общаться с демоном docker. |
| docker_swarm_active boolean | при успехе и при ошибке | Будет true если модуль может общаться с демоном docker, и демон docker находится в режиме Swarm. |
| docker_swarm_manager boolean | при успехе и при ошибке | Будет true если модуль может общаться с демоном docker, демон docker находится в режиме Swarm, и текущий узел является узлом-менеджером.Только если этот параметр true, модуль не завершится с ошибкой. |
| nodes список / элементы=словарь | Когда nodes yes
| Список объектов dict, содержащих основную информацию о каждом томе. Ключи соответствуют выводу docker node ls за исключением случая, когда verbose_output=yes. Смотрите описание для verbose_output. |
| services список / элементы=словарь | Когда services yes
| Список объектов dict, содержащих основную информацию о каждом томе. Ключи соответствуют выводу docker service ls за исключением случая, когда verbose_output=yes. Смотрите описание для verbose_output. |
| swarm_facts словарь | всегда | Факты, представляющие основное состояние кластера Docker Swarm. Содержит токены для подключения к Swarm |
| swarm_unlock_key строка | Когда unlock_key true. | Содержит ключ, необходимый для разблокировки swarm. |
| tasks список / элементы=словарь | Когда tasks yes
| Список объектов dict, содержащих основную информацию о каждом томе. Ключи соответствуют выводу docker service ps за исключением случая, когда verbose_output=yes. Смотрите описание для verbose_output. |
Авторы
- Piotr Wojciechowski (@WojciechowskiPiotr)
© 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_info_module.html