Модуль community.docker.docker_swarm_service_info — получение информации о службах Docker от менеджера Swarm

Примечание

Этот модуль входит в коллекцию community.docker (версия 5.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.docker. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.docker.docker_swarm_service_info.

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

Краткое описание

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

Требования

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

Docker API >= 1.25
Docker SDK for Python: обратите внимание, что модуль Python docker-py заменен модулем docker (подробности см. здесь). Этот модуль не работает с docker-py.
Docker SDK for Python >= 2.0.0

Параметры

Параметр	Комментарии
api_version псевдонимы: docker_api_version строка	Версия Docker API, работающая на узле Docker. По умолчанию используется последняя версия API, поддерживаемая Docker SDK for Python и демоном Docker. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_API_VERSION`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `"auto"`
ca_path псевдонимы: ca_cert, tls_ca_cert, cacert_path путь	Используйте сертификат CA для проверки сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче и задана переменная окружения `DOCKER_CERT_PATH`, будет использоваться файл `ca.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Ранее этот параметр назывался `ca_cert`, а в community.docker 3.6.0 был переименован в `ca_path`. Старое имя добавлено как псевдоним и по-прежнему может использоваться.
client_cert псевдонимы: tls_client_cert, cert_path путь	Путь к файлу сертификата TLS клиента. Если значение не указано в задаче и задана переменная окружения `DOCKER_CERT_PATH`, будет использоваться файл `cert.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
client_key псевдонимы: tls_client_key, key_path путь	Путь к файлу ключа TLS клиента. Если значение не указано в задаче и задана переменная окружения `DOCKER_CERT_PATH`, будет использоваться файл `key.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
debug логическое значение	Режим отладки. Варианты: `false` ← (по умолчанию) `true`
docker_host псевдонимы: docker_url строка	URL или путь к сокету Unix, используемый для подключения к Docker API. Для подключения к удаленному узлу укажите строку TCP-подключения. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL подключения на `https`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_HOST`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `"unix:///var/run/docker.sock"`
name строка / обязательный	Имя проверяемой службы.
timeout целое число	Максимальное время ожидания ответа от API в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_TIMEOUT`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `60`
tls логическое значение	Защитите соединение с API с помощью TLS без проверки подлинности сервера узла Docker. Обратите внимание: если `validate_certs` также задано в значение `true`, этот параметр имеет приоритет. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_TLS`. Если переменная окружения не задана, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`
tls_hostname строка	При проверке подлинности сервера узла Docker укажите ожидаемое имя сервера. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_TLS_HOSTNAME`. Если переменная окружения не задана, будет использовано значение по умолчанию. Обратите внимание, что в более ранних версиях у этого параметра было значение по умолчанию `localhost`. Оно было удалено в community.docker 3.0.0. Примечание: этот параметр больше не поддерживается в Docker SDK for Python 7.0.0+. Его указание с Docker SDK for Python версии 7.0.0 или новее приведет к ошибке.
use_ssh_client логическое значение добавлено в community.docker 1.5.0	Для SSH-транспорта используйте инструмент командной строки `ssh` вместо paramiko. Требуется Docker SDK for Python версии 4.4.0 или новее. Варианты: `false` ← (по умолчанию) `true`
validate_certs псевдонимы: tls_verify логическое значение	Защитите соединение с API с помощью TLS и проверьте подлинность сервера узла Docker. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `DOCKER_TLS_VERIFY`. Если переменная окружения не задана, будет использовано значение по умолчанию. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группы действий: community.docker.docker, docker	Используйте `group/docker` или `group/community.docker.docker` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого узла.
diff_mode	Поддержка: не применимо Это действие не изменяет состояние.	В режиме сравнения будут возвращены сведения об изменениях (или о том, что, возможно, требуется изменить в `check_mode`).
idempotent	Поддержка: полная Это действие не изменяет состояние.	При повторном запуске подряд вне режима проверки с теми же аргументами второй вызов не сообщает об изменениях. Предполагается, что система, состояние которой контролирует или запрашивает модуль, не изменилась существенным образом.

Примечания

Примечание

Подключайтесь к демону Docker, передавая параметры в каждой задаче или задавая переменные окружения. Можно задать переменные DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, 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 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/docker/docker_swarm_service_info_module.html