Spec-Zone.ru › Ansible

Модуль community.docker.docker_swarm_info – Получение сведений о кластере Docker Swarm.

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

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

Для использования в плейбуке укажите: community.docker.docker_swarm_info.

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

Описание

  • Получение сведений о Docker Swarm.
  • Возвращает списки имён объектов Swarm для служб — узлы, службы, задачи.
  • Вывод отличается в зависимости от версии API, доступной на хосте Docker.
  • Должен запускаться на управляющем узле Swarm; в противном случае модуль завершится с сообщением об ошибке. Он возвращает логические флаги как в случае ошибки, так и в случае успеха, которые указывают, можно ли связаться с демоном Docker, находится ли он в режиме Swarm и является ли он управляющим узлом Swarm.

Требования

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

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

Параметры

Параметр

Комментарии

api_version

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

строка

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

По умолчанию используется последняя версия API, поддерживаемая Docker SDK для 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 и был переименован в ca_path в community.docker 3.6.0. Старое название добавлено в качестве псевдонима и по-прежнему может использоваться.

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

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

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

nodes

логический тип

Отображать узлы swarm.

Варианты:

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

nodes_filters

словарь

Словарь значений фильтров для выбора узлов для отображения.

Например, name: mynode.

См. документацию Docker для получения дополнительной информации о возможных фильтрах.

services

логический тип

Отображать службы swarm.

Варианты:

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

services_filters

словарь

Словарь значений фильтров для выбора служб для отображения.

Например, name: myservice.

См. документацию Docker для получения дополнительной информации о возможных фильтрах.

ssl_version

строка

Укажите допустимое числовое значение версии SSL. Значение по умолчанию определяется модулем SSL Python.

Если значение не указано в задаче, будет использовано значение переменной среды DOCKER_SSL_VERSION.

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

tasks

логический тип

Отображать контейнеры.

Варианты:

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

tasks_filters

словарь

Словарь значений фильтров для выбора задач для отображения.

Например, node: mynode-1.

См. документацию Docker для получения дополнительной информации о возможных фильтрах.

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 для Python 7.0.0+. Использование его с Docker SDK для Python 7.0.0 или более поздней версии приведёт к ошибке.

unlock_key

логическое

Указывает, нужно ли получить ключ разблокировки кластера.

Варианты:

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

use_ssh_client

логическое

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

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

Требуется Docker SDK для Python 4.4.0 или более поздней версии.

Варианты:

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

validate_certs

алиасы: tls_verify

логическое

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

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

Варианты:

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

verbose_output

логическое

Если установлено в true и nodes, services, или tasks установлено в true, то вывод модуля будет содержать подробную информацию об объектах, соответствующих полному выводу метода API.

Для получения подробной информации см. документацию вашей версии API Docker по адресу https://docs.docker.com/engine/api/.

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

Варианты:

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

Атрибуты

Атрибут

Поддержка

Описание

action_group

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

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

check_mode

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

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

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

diff_mode

Поддержка: Нет

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

В режиме diff вернёт подробности о том, что изменилось (или, возможно, требует изменения в 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 Docker Swarm
  community.docker.docker_swarm_info:
  ignore_errors: true
  register: result

- name: Inform about basic flags
  ansible.builtin.debug:
    msg: |
      Was able to talk to docker daemon: {{ result.can_talk_to_docker }}
      Docker in Swarm mode: {{ result.docker_swarm_active }}
      This is a Manager node: {{ result.docker_swarm_manager }}

- name: Get info on Docker Swarm and list of registered nodes
  community.docker.docker_swarm_info:
    nodes: true
  register: result

- name: Get info on Docker Swarm and extended list of registered nodes
  community.docker.docker_swarm_info:
    nodes: true
    verbose_output: true
  register: result

- name: Get info on Docker Swarm and filtered list of registered nodes
  community.docker.docker_swarm_info:
    nodes: true
    nodes_filters:
      name: mynode
  register: result

- name: Show swarm facts
  ansible.builtin.debug:
    var: result.swarm_facts

- name: Get the swarm unlock key
  community.docker.docker_swarm_info:
    unlock_key: true
  register: result

- name: Print swarm unlock key
  ansible.builtin.debug:
    var: result.swarm_unlock_key

Значения возврата

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

Ключ

Описание

can_talk_to_docker

логический

Будет true если модуль может взаимодействовать с демоном Docker.

Возвращаемое значение: и при успехе, и при ошибке

docker_swarm_active

логический

Будет true если модуль может взаимодействовать с демоном Docker, и демон Docker находится в режиме Swarm.

Возвращаемое значение: и при успехе, и при ошибке

docker_swarm_manager

логический

Будет true если модуль может взаимодействовать с демоном Docker, демон Docker находится в режиме Swarm, и текущий узел является узлом-менеджером.

Только если это true, модуль не будет завершаться ошибкой.

Возвращаемое значение: и при успехе, и при ошибке

nodes

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

Список объектов dict, содержащих основную информацию о каждом томе. Ключи соответствуют docker node ls выводу, если verbose_output=true. См. описание для verbose_output.

Возвращаемое значение: Когда nodes=true

services

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

Список объектов dict, содержащих основную информацию о каждом томе. Ключи соответствуют docker service ls выводу, если verbose_output=true. См. описание для verbose_output.

Возвращаемое значение: Когда services=true

swarm_facts

словарь

Данные, представляющие основное состояние кластера Docker Swarm.

Содержит токены для подключения к Swarm.

Возвращаемое значение: всегда

swarm_unlock_key

строка

Содержит ключ, необходимый для разблокировки swarm.

Возвращаемое значение: Когда unlock_key=true.

tasks

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

Список объектов dict, содержащих основную информацию о каждом томе. Ключи соответствуют docker service ps выводу, если verbose_output=true. См. описание для verbose_output.

Возвращаемое значение: Когда tasks=true

Авторы

  • Piotr Wojciechowski (@WojciechowskiPiotr)

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

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

© 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_swarm_info_module.html

Spec-Zone.ru

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