Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

Требования

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

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

Параметры

Параметр

Комментарии

api_version

псевдонимы: docker_api_version

строка

добавлено в community.docker 3.6.0

Версия API Docker, работающего на узле Docker.

По умолчанию используется последняя версия API, поддерживаемая этой коллекцией и демоном Docker.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения DOCKER_API_VERSION. Если переменная окружения не задана, будет использовано значение по умолчанию.

По умолчанию: "auto"

ca_path

псевдонимы: ca_cert, tls_ca_cert, cacert_path

путь

добавлено в community.docker 3.6.0

Используйте сертификат ЦС при проверке сервера, указав путь к файлу сертификата ЦС.

Если значение не указано в задаче, а переменная окружения DOCKER_CERT_PATH задана, будет использован файл ca.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

cli_context

строка

добавлено в community.docker 3.6.0

Контекст CLI Docker, который следует использовать.

Взаимоисключающий параметр с docker_host.

client_cert

псевдонимы: tls_client_cert, cert_path

путь

добавлено в community.docker 3.6.0

Путь к файлу TLS-сертификата клиента.

Если значение не указано в задаче, а переменная окружения DOCKER_CERT_PATH задана, будет использован файл cert.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

client_key

псевдонимы: tls_client_key, key_path

путь

добавлено в community.docker 3.6.0

Путь к файлу TLS-ключа клиента.

Если значение не указано в задаче, а переменная окружения DOCKER_CERT_PATH задана, будет использован файл key.pem из каталога, указанного в переменной окружения DOCKER_CERT_PATH.

docker_cli

путь

добавлено в community.docker 3.6.0

Путь к CLI Docker. Если он не указан, будет выполнен поиск CLI Docker в PATH.

docker_host

псевдонимы: docker_url

строка

добавлено в community.docker 3.6.0

URL или путь к сокету Unix для подключения к API Docker. Для подключения к удалённому хосту укажите строку 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

логическое значение

добавлено в community.docker 3.6.0

Защитите соединение с API с помощью TLS без проверки подлинности сервера хоста Docker. Обратите внимание: если для validate_certs также задано значение true, этот параметр имеет приоритет.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения DOCKER_TLS. Если переменная окружения не задана, будет использовано значение по умолчанию.

Варианты:

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

tls_hostname

строка

добавлено в community.docker 3.6.0

При проверке подлинности сервера хоста Docker укажите ожидаемое имя сервера.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения DOCKER_TLS_HOSTNAME. Если переменная окружения не задана, будет использовано значение по умолчанию.

validate_certs

псевдонимы: tls_verify

логическое значение

добавлено в community.docker 3.6.0

Защитите соединение с API с помощью TLS и проверяйте подлинность сервера хоста Docker.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения DOCKER_TLS_VERIFY. Если переменная окружения не задана, будет использовано значение по умолчанию.

Варианты:

  • false ← (по умолчанию)
  • 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

Поддержка: Н/Д

Это действие не изменяет состояние.

В режиме сравнения будет возвращена информация об изменениях (или о возможных изменениях в 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 SDK для Python для взаимодействия с демоном Docker. Он напрямую вызывает программу CLI Docker.

См. также

См. также

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)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Запросить помощь (Docker)
  • Запросить помощь (Docker Compose)
  • Запросить помощь (Docker Swarm)
  • Сообщить об ошибке
  • Запросить новую функцию
  • Общение

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API