Модуль community.docker.docker_stack_info — Возвращает информацию обо всех docker стеках

Примечание

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

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

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

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

Обзор
Требования
Параметры
Атрибуты
Примечания
См. также
Примеры
Значения возврата

Обзор

Получение информации о docker стеках с помощью команды docker stack на целевом узле (см. примеры).

Требования

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

Инструмент Docker CLI docker

Параметры

Параметр	Комментарии
api_version aliases: docker_api_version string added in community.docker 3.6.0	Версия Docker API, работающего на Docker Host. По умолчанию используется последняя версия API, поддерживаемая этим сборником и демоном docker. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_API_VERSION`. Если переменная среды не установлена, будет использовано значение по умолчанию. Default: `"auto"`
ca_path aliases: ca_cert, tls_ca_cert, cacert_path path added in community.docker 3.6.0	Используйте сертификат CA при проверке сервера, указав путь к файлу сертификата CA. Если значение не указано в задаче и установлена переменная среды `DOCKER_CERT_PATH`, будет использован файл `ca.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`.
cli_context string added in community.docker 3.6.0	Контекст Docker CLI для использования. Взаимоисключающе с `docker_host`.
client_cert aliases: tls_client_cert, cert_path path added in community.docker 3.6.0	Путь к файлу сертификата TLS клиента. Если значение не указано в задаче и установлена переменная среды `DOCKER_CERT_PATH`, будет использован файл `cert.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`.
client_key aliases: tls_client_key, key_path path added in community.docker 3.6.0	Путь к файлу ключа TLS клиента. Если значение не указано в задаче и установлена переменная среды `DOCKER_CERT_PATH`, будет использован файл `key.pem` из каталога, указанного в переменной среды `DOCKER_CERT_PATH`.
docker_cli path added in community.docker 3.6.0	Путь к Docker CLI. Если не указан, будет выполнен поиск Docker CLI на `PATH`.
docker_host aliases: docker_url string added in community.docker 3.6.0	URL или путь к сокету Unix, используемый для подключения к Docker API. Для подключения к удаленному хосту укажите строку подключения TCP. Например, `tcp://192.0.2.23:2376`. Если для шифрования соединения используется TLS, модуль автоматически заменит `tcp` в URL подключения на `https`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_HOST`. Если переменная среды не установлена, будет использовано значение по умолчанию. Взаимоисключающе с `cli_context`. Если ни `docker_host`, ни `cli_context` не указаны, используется значение `unix:///var/run/docker.sock`.
tls boolean added in community.docker 3.6.0	Обеспечьте безопасность соединения с API, используя TLS без проверки подлинности сервера Docker host. Обратите внимание, что если `validate_certs` также установлен в `true`, он будет иметь приоритет. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_TLS`. Если переменная среды не установлена, будет использовано значение по умолчанию. Варианты: `false` ← (default) `true`
tls_hostname string added in community.docker 3.6.0	При проверке подлинности сервера Docker Host укажите ожидаемое имя сервера. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_TLS_HOSTNAME`. Если переменная среды не установлена, будет использовано значение по умолчанию.
validate_certs aliases: tls_verify boolean added in community.docker 3.6.0	Обеспечьте безопасность соединения с API, используя TLS и проверяя подлинность сервера Docker host. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `DOCKER_TLS_VERIFY`. Если переменная среды не установлена, будет использовано значение по умолчанию. Варианты: `false` ← (default) `true`

Атрибуты

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

Примечания

Примечание

Подключение к демону 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 SDK для Python для взаимодействия с демоном Docker. Он напрямую вызывает программу Docker CLI.

См. также

community.docker.docker_stack_task_info: Для получения подробной информации о сервисах в определенном стеке используйте модуль community.docker.docker_stack_task_info.

Примеры

- name: Shows stack info
  community.docker.docker_stack_info:
  register: result

- name: Show results
  ansible.builtin.debug:
    var: result.results

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

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

Ключ	Описание
results список / элементы=словарь	Список словарей, содержащих список стеков на целевом узле Возвращается: всегда Пример: `[{"name": "grafana", "namespace": "default", "orchestrator": "Kubernetes", "services": "2"}]`

Авторы

Jose Angel Munoz (@imjoseangel)

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

© 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_stack_info_module.html