community.general.docker_swarm_service_info – Извлекает информацию о службах docker из менеджера Swarm

Примечание

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

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

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

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

Обзор

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

Требования

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

Docker API >= 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"	Версия 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
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 в противном случае.

Примеры

- name: Get info from a service
  community.general.docker_swarm_service_info:
    name: myservice
  register: result

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

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

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

Авторы

Hannes Ljungberg (@hannseman)

© 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/general/docker_swarm_service_info_module.html