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

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

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

Описание

Получает информацию о службе 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 для подключения к API Docker. Для подключения к удалённому хосту укажите строку 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://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 from a service
  docker_swarm_service_info:
    name: myservice
  register: result

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

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

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

Статус

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

Авторы

Ханнес Люннберг (@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.8/modules/docker_swarm_service_info_module.html