docker_node_info – Извлекает сведения о узле Docker Swarm из менеджера Swarm

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

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

Обзор

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

Требования

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

API Docker >= 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"	Версия 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
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://docker-py.readthedocs.io/en/stable/machine/.
При подключении к демону 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`. Может содержать несколько записей, если в name указано более одного узла или name не указан. Если name содержит список узлов, вывод предоставит информацию обо всех зарегистрированных в кластере узлах, включая узлы, покинувшие кластер, но не удаленные из него менеджерами кластера, и недоступные узлы.

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Данный модуль поддерживается сообществом 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.8/modules/docker_node_info_module.html