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

Примечание

Этот плагин входит в коллекцию community.docker (версия 1.1.0).

Для его установки используйте: ansible-galaxy collection install community.docker.

Для использования в книге задач укажите: community.docker.docker_node_info.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Извлекает сведения об узле 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), либо ID узла. Если 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] с помощью 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 all nodes
  community.docker.docker_node_info:
  register: result

- name: Get info on node
  community.docker.docker_node_info:
    name: mynode
  register: result

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

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

Возвращаемые значения

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

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

Авторы

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