Spec-Zone.ru › Ansible

модуль community.docker.docker_stack_task_info – возвращает сведения о задачах в стеке Docker

Примечание

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

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

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

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

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

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

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

Требования

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

  • Инструмент Docker CLI 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

Для проверки сервера используйте сертификат CA, указав путь к файлу сертификата CA.

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

cli_context

строка

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

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

Несовместим с 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

Путь к Docker CLI. Если он не указан, поиск Docker CLI будет выполняться в 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.

name

строка / обязательный

Имя стека.

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

Поддержка: не применимо

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

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

Примеры

---
- name: Shows stack info
  community.docker.docker_stack_task_info:
    name: test_stack
  register: result

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

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

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

Ключ

Описание

results

список / элементы=словарь

Список словарей со списками задач, связанными с именем стека.

Возвращается: всегда

Пример: [{"CurrentState": "Running", "DesiredState": "Running", "Error": "", "ID": "7wqv6m02ugkw", "Image": "busybox", "Name": "test_stack.1", "Node": "swarm", "Ports": ""}]

Авторы

  • 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_task_info_module.html

Spec-Zone.ru

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