community.docker.docker_swarm_service_info – Получает информацию о службах Docker из менеджера Swarm

Примечание

Этот плагин является частью коллекции community.docker (версия 1.2.2).

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

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

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

Обзор

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

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_version строка	Значение по умолчанию: "auto"	Версия API Docker, работающая на хосте 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
name строка / обязательно		Имя службы для проверки.
ssl_version строка		Укажите корректное числовое значение версии SSL. Значение по умолчанию определяется модулем ssl.py. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_SSL_VERSION`.
timeout целое число	Значение по умолчанию: 60	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_TIMEOUT`. Если переменная среды не задана, будет использовано значение по умолчанию.
tls логическое	Варианты: нет ← да	Обеспечьте безопасное подключение к API с использованием TLS без проверки подлинности хоста Docker. Обратите внимание, что если validate_certs также задано как `yes`, оно будет иметь приоритет. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_TLS`. Если переменная среды не задана, будет использовано значение по умолчанию.
tls_hostname строка	Значение по умолчанию: "localhost"	При проверке подлинности хоста Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_TLS_HOSTNAME`. Если переменная среды не задана, будет использовано значение по умолчанию.
validate_certs логическое	Варианты: нет ← да	Обеспечьте безопасное подключение к API с использованием TLS и проверкой подлинности хоста Docker. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_TLS_VERIFY`. Если переменная среды не задана, будет использовано значение по умолчанию. псевдонимы: tls_verify

Примечания

Примечание

Подключитесь к демону 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 from a service
  community.docker.docker_swarm_service_info:
    name: myservice
  register: result

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
exists логическое	всегда	Возвращает, существует ли служба. Пример: True
service словарь	всегда	Словарь, представляющий текущее состояние службы. Соответствует выводу `docker service inspect`. Будет `none`, если служба не существует.

Авторы

Hannes Ljungberg (@hannseman)

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