Модуль community.docker.docker_node_info – Получение данных о узле Docker Swarm от управляющего узла Swarm

Примечание

Этот модуль входит в коллекцию community.docker (версия 3.13.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, иначе модуль завершится ошибкой.

Требования

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

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

Параметры

Параметр	Комментарии
api_version aliases: docker_api_version строка	Версия API Docker, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая Docker SDK для Python и демоном docker. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_API_VERSION`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `"auto"`
ca_path aliases: ca_cert, tls_ca_cert, cacert_path путь	Использование сертификата CA при проверке сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче, а переменная окружения `DOCKER_CERT_PATH` задана, будет использоваться файл `ca.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Этот параметр назывался `ca_cert` и был переименован в `ca_path` в community.docker 3.6.0. Старое имя добавлено в качестве псевдонима и может по-прежнему использоваться.
client_cert aliases: tls_client_cert, cert_path путь	Путь к файлу TLS-сертификата клиента. Если значение не указано в задаче, а переменная окружения `DOCKER_CERT_PATH` задана, будет использоваться файл `cert.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
client_key aliases: tls_client_key, key_path путь	Путь к файлу TLS-ключа клиента. Если значение не указано в задаче, а переменная окружения `DOCKER_CERT_PATH` задана, будет использоваться файл `key.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
debug логический	Режим отладки Варианты: `false` ← (по умолчанию) `true`
docker_host aliases: 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) или ID узла. Если `self=true`, то этот параметр игнорируется.
self логический	Если `true`, запрашивает узел (т.е., демон docker), с которым модуль взаимодействует. Если `true`, то `name` игнорируется. Если `false`, запрос зависит от наличия и значения `name`. Варианты: `false` ← (по умолчанию) `true`
ssl_version строка	Укажите допустимое значение номера версии SSL. Значение по умолчанию определяется модулем SSL Python module. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_SSL_VERSION`. Примечание: этот параметр больше не поддерживается для Docker SDK для Python 7.0.0+. Указание его с Docker SDK для Python 7.0.0 или более поздней версии приведет к ошибке.
timeout целое число	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_TIMEOUT`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `60`
tls логический	Защитить соединение с API, используя TLS без проверки подлинности хоста Docker. Обратите внимание, что если `validate_certs` установлено в `true`, оно будет иметь приоритет. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_TLS`. Если переменная окружения не задана, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`

tls_hostname string	При проверке подлинности сервера Docker Host укажите ожидаемое имя сервера. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_TLS_HOSTNAME`. Если переменная окружения не задана, будет использовано значение по умолчанию. Обратите внимание, что в более старых версиях этот параметр имел значение по умолчанию `localhost`. Он был удалён в версии community.docker 3.0.0. Примечание: этот параметр больше не поддерживается для Docker SDK для Python 7.0.0+. Указание его с Docker SDK для Python 7.0.0 или более поздней версии приведёт к ошибке.
use_ssh_client boolean добавлен в community.docker 1.5.0	Для SSH-транспортов используйте инструмент `ssh` CLI вместо paramiko. Требуется Docker SDK для Python 4.4.0 или более поздней версии. Варианты: `false` ← (по умолчанию) `true`
validate_certs псевдонимы: tls_verify boolean	Обеспечьте безопасность соединения с API, используя TLS и проверяя подлинность сервера Docker host. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `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`).

Примечания

Примечание

Подключайтесь к демону 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, и узлы, которые недоступны. Возвращается: всегда

Ключ

Описание

nodes

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

Данные, представляющие текущее состояние узлов. Соответствует выводу docker node inspect.

Может содержать несколько записей, если в name, или name не предоставлено, указано более одного узла.

Если name содержит список узлов, вывод будет содержать информацию обо всех зарегистрированных узлах в кластере Swarm, включая узлы, которые покинули Swarm, но не были удалены из кластера на менеджерах Swarm, и узлы, которые недоступны.

Возвращается: всегда

Авторы

Piotr Wojciechowski (@WojciechowskiPiotr)

Ссылки на сборку

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