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

Примечание

Этот модуль входит в коллекцию community.docker (версия 3.13.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 Manager, в противном случае модуль завершится ошибкой.

Требования

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

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

Параметры

Параметр	Комментарии
api_version aliases: docker_api_version строка	Версия Docker API, работающая на хосте Docker. По умолчанию используется последняя версия API, поддерживаемая Docker SDK для Python и демоном docker. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_API_VERSION`. Если переменная окружения не задана, будет использовано значение по умолчанию. По умолчанию: `"auto"`
ca_path aliases: ca_cert, tls_ca_cert, cacert_path путь	Используйте сертификат CA при проверке сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче, а переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `ca.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`. Этот параметр назывался `ca_cert` и был переименован в `ca_path` в community.docker 3.6.0. Старое имя добавлено как псевдоним и по-прежнему может использоваться.
client_cert aliases: tls_client_cert, cert_path путь	Путь к файлу TLS-сертификата клиента. Если значение не указано в задаче, а переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `cert.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
client_key aliases: tls_client_key, key_path путь	Путь к файлу TLS-ключа клиента. Если значение не указано в задаче, а переменная окружения `DOCKER_CERT_PATH` задана, будет использован файл `key.pem` из каталога, указанного в переменной окружения `DOCKER_CERT_PATH`.
debug логический	Режим отладки Варианты: `false` ← (по умолчанию) `true`
docker_host aliases: 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 строка / обязательно	Имя службы для проверки.
ssl_version строка	Укажите версию SSL. Значение по умолчанию определяется модулем SSL Python. Если значение не указано в задаче, будет использовано значение переменной окружения `DOCKER_SSL_VERSION`. Примечание: этот параметр больше не поддерживается для Docker SDK для Python 7.0.0+. Указание его с Docker SDK для Python 7.0.0 или более новыми версиями приведёт к ошибке.
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 для Python 7.0.0+. Указание его с Docker SDK для Python 7.0.0 или более новыми версиями приведёт к ошибке.

use_ssh_client

boolean

added in community.docker 1.5.0

Для SSH-транспортов используется инструмент ssh CLI вместо paramiko.

Требуется Docker SDK for Python 4.4.0 или новее.

Варианты:

false ← (по умолчанию)
true

validate_certs

aliases: tls_verify

boolean

Обеспечьте безопасность соединения с 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` ), когда режим diff включен.

Примечания

Примечание

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

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

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

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

Авторы

Hannes Ljungberg (@hannseman)

Ссылки на коллекции

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