community.general.docker_swarm_info – Получает сведения о кластере Docker Swarm.
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.docker_swarm_info.
Обзор
- Получает сведения о Docker Swarm.
- Возвращает списки имён объектов Swarm для служб - узлы, службы, задачи.
- Вывод отличается в зависимости от версии API, доступной на хосте Docker.
- Должен выполняться на узле менеджера Swarm; в противном случае модуль завершается с сообщением об ошибке. Он возвращает логические флаги как в случае ошибки, так и в случае успеха, указывающие, можно ли связаться с демоном Docker, находится ли он в режиме Swarm и является ли он узлом менеджера Swarm.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- Docker API >= 1.24
- Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменён на docker (подробности см. в данном месте). Для Python 2.6 необходимо использовать
docker-py. В противном случае рекомендуется установить модуль Pythondocker. Обратите внимание, что оба модуля не должны устанавливаться одновременно. Также обратите внимание, что при установке и удалении одного из этих модулей, другой может перестать работать и потребует повторной установки. - Docker SDK для Python >= 1.10.0 (для Python 2.6 используйте docker-py)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_version строка | Значение по умолчанию: "auto" | Версия API Docker, работающая на хосте 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, используемые для подключения к API Docker. Для подключения к удалённому хосту укажите строку 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в противном случае.
Примеры
- name: Get info on Docker Swarm
community.general.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.general.docker_swarm_info:
nodes: yes
register: result
- name: Get info on Docker Swarm and extended list of registered nodes
community.general.docker_swarm_info:
nodes: yes
verbose_output: yes
register: result
- name: Get info on Docker Swarm and filtered list of registered nodes
community.general.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.general.docker_swarm_info:
unlock_key: yes
register: result
- ansible.builtin.debug:
var: result.swarm_unlock_key
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| can_talk_to_docker булево | как при успехе, так и при ошибке | Будет true если модуль может взаимодействовать с демоном Docker. |
| docker_swarm_active булево | как при успехе, так и при ошибке | Будет true если модуль может взаимодействовать с демоном Docker, и демон Docker находится в режиме Swarm. |
| docker_swarm_manager булево | как при успехе, так и при ошибке | Будет true если модуль может взаимодействовать с демоном Docker, демон Docker находится в режиме Swarm, и текущий узел является управляющим узлом.Только если этот параметр true, модуль не завершится ошибкой. |
| nodes список / элементы=словарь | Когда nodes yes
| Список объектов словарей, содержащих основную информацию о каждом томе. Ключи соответствуют выводу docker node ls за исключением случая, когда verbose_output=yes. См. описание для verbose_output. |
| services список / элементы=словарь | Когда services yes
| Список объектов словарей, содержащих основную информацию о каждом томе. Ключи соответствуют выводу docker service ls за исключением случая, когда verbose_output=yes. См. описание для verbose_output. |
| swarm_facts словарь | всегда | Факты, представляющие основное состояние кластера Docker Swarm. Содержит токены для подключения к Swarm |
| swarm_unlock_key строка | Когда unlock_key true | Содержит ключ, необходимый для разблокировки Swarm. |
| tasks список / элементы=словарь | Когда tasks yes
| Список объектов словарей, содержащих основную информацию о каждом томе. Ключи соответствуют выводу docker service ps за исключением случая, когда verbose_output=yes. См. описание для verbose_output. |
Авторы
- Piotr Wojciechowski (@WojciechowskiPiotr)
© 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_info_module.html