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

Примечание

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

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

Для использования в книге задач укажите: community.general.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) или идентификатор узла. Если 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 в противном случае.

Примеры

- name: Get info on all nodes
  community.general.docker_node_info:
  register: result

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

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

- name: Get info on host if it is Swarm Manager
  community.general.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/general/docker_node_info_module.html