Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин входит в сборку community.docker (версия 1.1.0).

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

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

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

Описание

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

Требования

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

  • Docker API >= 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 для получения дополнительной информации о возможных фильтрах.
services
логический тип
    Варианты:
  • нет ←
  • да
Указывает, нужно ли отобразить службы Swarm.
services_filters
словарь
Словарь значений фильтров, используемых для выбора служб для отображения.
Например, name: myservice.
См. документацию Docker для получения дополнительной информации о возможных фильтрах.
ssl_version
строка
Укажите допустимый номер версии SSL. Значение по умолчанию определяется модулем ssl.py.
Если значение не указано в задаче, будет использовано значение переменной окружения DOCKER_SSL_VERSION.
tasks
логический тип
    Варианты:
  • нет ←
  • да
Указывает, нужно ли отобразить контейнеры.
tasks_filters
словарь
Словарь значений фильтров, используемых для выбора задач для отображения.
Например, node: mynode-1.
См. документацию Docker для получения дополнительной информации о возможных фильтрах.
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://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 только для очень немногих функций. В общем случае он будет использовать $HOME/.docker/config.json если переменная среды DOCKER_CONFIG не указана, и использовать $DOCKER_CONFIG/config.json в противном случае.
  • Этот модуль использует Docker SDK for Python для связи с демоном Docker.

Примеры

- name: Get info on Docker Swarm
  community.docker.docker_swarm_info:
  ignore_errors: yes
  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 }}

- block:

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

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

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

- ansible.builtin.debug:
    var: result.swarm_facts

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

- ansible.builtin.debug:
    var: result.swarm_unlock_key

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

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

Ключ Возвращаемое значение Описание
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.



Авторы

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

Spec-Zone.ru

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