Spec-Zone.ru › Ansible 2.8

docker_swarm_info – Извлечение сведений о кластере Docker Swarm

Новая версия с 2.8.

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

Описание

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

Требования

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

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

Параметры

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

Псевдонимы: docker_url
nodes
логический тип
    Варианты:
  • нет ←
  • да
Отображать узлы swarm.
nodes_filters
словарь
Словарь значений фильтров, используемых для выбора узлов для отображения.
Например, name: mynode.
Для получения дополнительной информации о возможных фильтрах см. документацию Docker по команде node_ls.
services
логический тип
    Варианты:
  • нет ←
  • да
Отображать службы swarm.
services_filters
словарь
Словарь значений фильтров, используемых для выбора служб для отображения.
Например, name: myservice.
Для получения дополнительной информации о возможных фильтрах см. документацию Docker по команде service_ls.
ssl_version
строка
Укажите допустимое значение версии SSL. Значение по умолчанию определяется модулем ssl.py.
Если значение не указано в задаче, будет использовано значение переменной окружения DOCKER_SSL_VERSION.
tasks
логический тип
    Варианты:
  • нет ←
  • да
Отображать контейнеры.
tasks_filters
словарь
Словарь значений фильтров, используемых для выбора задач для отображения.
Например, node: mynode-1.
Для получения дополнительной информации о возможных фильтрах см. документацию Docker по команде service_ps.
timeout
целое число
Значение по умолчанию:
60
Максимальное время ожидания ответа от API в секундах.
Если значение не указано в задаче, будет использовано значение переменной окружения DOCKER_TIMEOUT. Если переменная окружения не задана, будет использовано значение по умолчанию.
tls
логический тип
    Варианты:
  • нет ←
  • да
Защитить соединение с API с помощью TLS без проверки подлинности Docker хоста. Обратите внимание, что если validate_certs также установлено в yes, то будет использоваться это значение.
Если значение не указано в задаче, будет использовано значение переменной окружения DOCKER_TLS. Если переменная окружения не задана, будет использовано значение по умолчанию.
tls_hostname
строка
Значение по умолчанию:
"localhost"
При проверке подлинности Docker хоста укажите ожидаемое имя сервера.
Если значение не указано в задаче, будет использовано значение переменной окружения DOCKER_TLS_HOSTNAME. Если переменная окружения не задана, будет использовано значение по умолчанию.
unlock_key
логический тип
    Варианты:
  • нет ←
  • да
Получить ключ разблокировки swarm.
validate_certs
логический тип
    Варианты:
  • нет ←
  • да
Защитить соединение с API с помощью TLS и проверить подлинность Docker хоста.
Если значение не указано в задаче, будет использовано значение переменной окружения DOCKER_TLS_VERIFY. Если переменная окружения не задана, будет использовано значение по умолчанию.

Псевдонимы: tls_verify
verbose_output
логический тип
    Варианты:
  • нет ←
  • да
Если установлено значение yes и nodes, services или tasks установлено в yes, то вывод модуля будет содержать подробную информацию об объектах, соответствующих полному выводу метода API.
Для получения подробной информации см. документацию вашей версии Docker API по адресу https://docs.docker.com/engine/api/.
Подробный вывод в этом модуле содержит только подмножество информации, возвращаемой модулем _info для каждого типа объектов.

Примечания

Примечание

  • Подключайтесь к демону 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://docker-py.readthedocs.io/en/stable/machine/ для получения дополнительной информации.
  • При подключении к Docker демону с TLS, возможно, потребуется установить дополнительные пакеты Python. Для Docker SDK для Python версии 2.4 или выше это можно сделать, установив docker[tls] с помощью pip.
  • Обратите внимание, что Docker SDK для Python позволяет указать путь к конфигурации Docker только для очень небольшого количества функций. В общем случае, он будет использовать $HOME/.docker/config.json если переменная окружения DOCKER_CONFIG не указана, и использовать $DOCKER_CONFIG/config.json в противном случае.

Примеры

- name: Get info on Docker Swarm
  docker_swarm_info:
  ignore_errors: yes
  register: result

- name: Inform about basic flags
  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 }}

- block:

- name: Get info on Docker Swarm and list of registered nodes
  docker_swarm_info:
    nodes: yes
  register: result

- name: Get info on Docker Swarm and extended list of registered nodes
  docker_swarm_info:
    nodes: yes
    verbose_output: yes
  register: result

- name: Get info on Docker Swarm and filtered list of registered nodes
  docker_swarm_info:
    nodes: yes
    nodes_filter:
      name: mynode
  register: result

- debug:
    var: result.swarm_facts

- name: Get the swarm unlock key
  docker_swarm_info:
    unlock_key: yes
  register: result

- debug:
    var: result.swarm_unlock_key

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

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

END_OF_DOCUMENT_MARKER
Ключ Возвращаемое значение Описание
can_talk_to_docker
boolean
как при успехе, так и при ошибке
Будет true, если модуль может взаимодействовать с демоном Docker.

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

docker_swarm_manager
boolean
как при успехе, так и при ошибке
Будет true, если модуль может взаимодействовать с демоном Docker, демон Docker находится в режиме Swarm, и текущий узел является управляющим узлом.
Только если это значение true, модуль не завершится с ошибкой.

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

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

swarm_facts
словарь
всегда
Факты, представляющие основное состояние кластера Docker Swarm.
Содержит токены для подключения к Swarm

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

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



Статус

  • Данный модуль не гарантирует обратной совместимости. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.8/modules/docker_swarm_info_module.html

Spec-Zone.ru

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