Spec-Zone.ru › Ansible

Модуль community.docker.docker_node_info — получение сведений об узле Docker Swarm от менеджера Swarm

Примечание

Этот модуль входит в коллекцию community.docker (версия 5.2.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install community.docker. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.docker.docker_node_info.

  • Краткое описание
  • Требования
  • Параметры
  • Атрибуты
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Требования

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

  • Docker API >= 1.25
  • Docker SDK for Python. Обратите внимание, что модуль Python docker-py заменен модулем docker (подробности см. здесь). Этот модуль не работает с docker-py.
  • Docker SDK for Python >= 2.4.0

Параметры

Параметр

Комментарии

api_version

псевдонимы: docker_api_version

строка

Версия Docker API, работающая на хосте Docker.

По умолчанию используется последняя версия API, поддерживаемая Docker SDK for Python и демоном docker.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения DOCKER_API_VERSION. Если переменная окружения не задана, будет использоваться значение по умолчанию.

По умолчанию: "auto"

ca_path

псевдонимы: ca_cert, tls_ca_cert, cacert_path

путь

Для проверки сервера используйте сертификат CA, указав путь к файлу сертификата CA.

Если значение не указано в задаче, а переменная окружения DOCKER_CERT_PATH задана, будет использоваться файл ca.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

Ранее этот параметр назывался ca_cert; в community.docker 3.6.0 он был переименован в ca_path. Старое имя добавлено как псевдоним и по-прежнему поддерживается.

client_cert

псевдонимы: tls_client_cert, cert_path

путь

Путь к файлу TLS-сертификата клиента.

Если значение не указано в задаче, а переменная окружения DOCKER_CERT_PATH задана, будет использоваться файл cert.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

client_key

псевдонимы: tls_client_key, key_path

путь

Путь к файлу TLS-ключа клиента.

Если значение не указано в задаче, а переменная окружения DOCKER_CERT_PATH задана, будет использоваться файл key.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

debug

логическое значение

Режим отладки.

Варианты:

  • false ← (по умолчанию)
  • true

docker_host

псевдонимы: docker_url

строка

URL или путь к сокету Unix для подключения к Docker API. Для подключения к удаленному хосту укажите строку TCP-подключения. Например, tcp://192.0.2.23:2376. Если для шифрования соединения используется TLS, модуль автоматически заменит tcp в URL подключения на https.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения DOCKER_HOST. Если переменная окружения не задана, будет использоваться значение по умолчанию.

По умолчанию: "unix:///var/run/docker.sock"

name

список / элементы=строка

Имя узла, сведения о котором нужно получить.

Список имен узлов, сведения о которых нужно получить.

Если список пуст, возвращаются сведения обо всех узлах в кластере Swarm.

Для идентификации узла используйте его имя хоста (зарегистрированное в Swarm) или идентификатор узла.

Если self=true, этот параметр игнорируется.

self

логическое значение

Если true, запрашивает узел (то есть демон docker), с которым взаимодействует модуль.

Если true, то name игнорируется.

Если false, запрос зависит от наличия и значения name.

Варианты:

  • false ← (по умолчанию)
  • true

timeout

целое число

Максимальное время ожидания ответа API в секундах.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения DOCKER_TIMEOUT. Если переменная окружения не задана, будет использоваться значение по умолчанию.

По умолчанию: 60

tls

логическое значение

Защитить соединение с API с помощью TLS без проверки подлинности сервера хоста Docker. Обратите внимание: если параметру validate_certs также присвоено значение true, он имеет приоритет.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения DOCKER_TLS. Если переменная окружения не задана, будет использоваться значение по умолчанию.

Варианты:

  • false ← (по умолчанию)
  • true

tls_hostname

строка

При проверке подлинности сервера хоста Docker укажите ожидаемое имя сервера.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения DOCKER_TLS_HOSTNAME. Если переменная окружения не задана, будет использоваться значение по умолчанию.

Обратите внимание: в более ранних версиях значение этого параметра по умолчанию было localhost. Оно было удалено в community.docker 3.0.0.

Примечание: этот параметр больше не поддерживается в Docker SDK for Python 7.0.0+. Его указание в Docker SDK for Python версии 7.0.0 или новее приведет к ошибке.

use_ssh_client

логическое значение

добавлено в community.docker 1.5.0

Для SSH-подключений используйте инструмент командной строки ssh вместо paramiko.

Требуется Docker SDK for Python версии 4.4.0 или новее.

Варианты:

  • false ← (по умолчанию)
  • true

validate_certs

псевдонимы: tls_verify

логическое значение

Защитить соединение с API с помощью TLS и проверить подлинность сервера хоста Docker.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения DOCKER_TLS_VERIFY. Если переменная окружения не задана, будет использоваться значение по умолчанию.

Варианты:

  • false ← (по умолчанию)
  • true

Атрибуты

Атрибут

Поддержка

Описание

action_group

Группы действий: community.docker.docker, docker

Используйте group/docker или group/community.docker.docker в module_defaults, чтобы задать значения по умолчанию для этого модуля.

check_mode

Поддержка: полная

Это действие не изменяет состояние.

Может выполняться в режиме check_mode и возвращать прогноз статуса изменений, не изменяя целевой объект.

diff_mode

Поддержка: не применимо

Это действие не изменяет состояние.

В режиме различий будут возвращены сведения о внесенных изменениях (или о возможных изменениях в check_mode).

idempotent

Поддержка: полная

Это действие не изменяет состояние.

При повторном запуске с теми же аргументами вне режима проверки действие сообщает об отсутствии изменений.

Предполагается, что состояние системы, которой управляет модуль или которую он запрашивает, не изменилось существенным образом.

Примечания

Примечание

  • Подключайтесь к демону Docker, передавая параметры в каждой задаче или задавая переменные окружения. Можно задать DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_TLS, DOCKER_TLS_VERIFY и DOCKER_TIMEOUT. Если вы используете docker machine, запустите поставляемый с продуктом сценарий настройки окружения. Он задаст эти переменные за вас. Подробнее см. на странице https://docs.docker.com/machine/reference/env/.
  • При подключении к демону Docker по TLS может потребоваться установить дополнительные пакеты Python. Для Docker SDK for Python версии 2.4 или новее это можно сделать, установив docker[tls] с помощью ansible.builtin.pip.
  • Обратите внимание, что Docker SDK for Python позволяет указывать путь к конфигурации Docker лишь для небольшого числа функций. Обычно SDK использует $HOME/.docker/config.json, если переменная окружения DOCKER_CONFIG не задана, и $DOCKER_CONFIG/config.json в противном случае.
  • Этот модуль использует Docker SDK for 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)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Запросить помощь (Docker)
  • Запросить помощь (Docker Compose)
  • Запросить помощь (Docker Swarm)
  • Сообщить об ошибке
  • Предложить новую функцию
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/docker/docker_node_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API