docker_node_info – Извлекает данные о узле docker swarm из Swarm Manager

Новое в версии 2.8.

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Описание

Извлекает данные о узле docker.
В сущности возвращает вывод docker node inspect <name>.
Должен выполняться на хосте, работающем в качестве Swarm Manager, иначе модуль завершится с ошибкой.

Требования

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

Docker API >= 1.24
Docker SDK для Python: Обратите внимание, что модуль Python docker-py был заменен на docker (см. здесь для получения подробностей). Для Python 2.6 необходимо использовать docker-py. В противном случае рекомендуется установить модуль Python docker. Обратите внимание, что оба модуля не должны устанавливаться одновременно. Также обратите внимание, что при установке и удалении одного из модулей, другой может перестать работать, и потребуется его переустановка.
Docker SDK для Python >= 2.4.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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
name список / элементы=строка		Имя узла для проверки. Список имён узлов для проверки. Если пусто, возвращает информацию обо всех узлах в кластере Swarm. При идентификации узла используйте имя хоста узла (как зарегистрировано в Swarm) или идентификатор узла. Если self равно `true`, этот параметр игнорируется.
self логическое	Варианты: нет ← да	Если `true`, запрашивает узел (т. е. демона docker), с которым модуль общается. Если `true`, параметр name игнорируется. Если `false`, запрос зависит от наличия и значения параметра name.
ssl_version строка		Укажите допустимое значение версии SSL. Значение по умолчанию определяется модулем ssl.py. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_SSL_VERSION`.
timeout целое число	Значение по умолчанию: 60	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TIMEOUT`. Если переменная среды не задана, будет использовано значение по умолчанию.
tls логическое	Варианты: нет ← да	Защитить соединение с API с помощью TLS без проверки подлинности Docker хост-сервера. Обратите внимание, что если validate_certs также установлено в `yes`, оно будет иметь приоритет. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TLS`. Если переменная среды не задана, будет использовано значение по умолчанию.
tls_hostname строка	Значение по умолчанию: "localhost"	При проверке подлинности Docker хост-сервера укажите ожидаемое имя сервера. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TLS_HOSTNAME`. Если переменная среды не задана, будет использовано значение по умолчанию.
validate_certs логическое	Варианты: нет ← да	Защитить соединение с API с помощью TLS и проверить подлинность Docker хост-сервера. Если значение не указано в задаче, будет использовано значение переменной среды `DOCKER_TLS_VERIFY`. Если переменная среды не задана, будет использовано значение по умолчанию. псевдонимы: tls_verify

Примечания

Примечание

Подключитесь к 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] с помощью pip.
Обратите внимание, что Docker SDK для Python позволяет указывать путь к конфигурации Docker только для очень немногих функций. В общем случае, он будет использовать $HOME/.docker/config.json, если переменная среды DOCKER_CONFIG не задана, и $DOCKER_CONFIG/config.json в противном случае.

Примеры

- name: Get info on all nodes
  docker_node_info:
  register: result

- name: Get info on node
  docker_node_info:
    name: mynode
  register: result

- name: Get info on list of nodes
  docker_node_info:
    name:
      - mynode1
      - mynode2
  register: result

- name: Get info on host if it is Swarm Manager
  docker_node_info:
    self: true
  register: result

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:

Ключ	Возвращаемое значение	Описание
nodes список / элементы=словарь	всегда	Факты, представляющие текущее состояние узлов. Соответствует выводу `docker node inspect`. Может содержать несколько записей, если в имени указано более одного узла или имя не указано. Если имя содержит список узлов, вывод предоставит информацию обо всех зарегистрированных в группе узлах, включая узлы, которые покинули группу, но не были удалены из кластера на управляющих узлах группы, и недоступные узлы.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/docker_node_info_module.html