Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции community.docker (версия 3.13.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

aliases: docker_api_version

string

added in community.docker 3.6.0

Версия Docker API, работающая на хосте Docker.

По умолчанию используется последняя версия 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.

name

string / required

Имя стека.

tls

boolean

added in community.docker 3.6.0

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

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

Варианты:

  • false ← (default)
  • true

tls_hostname

string

added in community.docker 3.6.0

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

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

validate_certs

aliases: tls_verify

boolean

added in community.docker 3.6.0

Обеспечьте безопасность соединения с API, используя TLS и проверяя подлинность сервера хоста Docker.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды 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

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

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

В режиме сравнения будет возвращены данные о том, что изменилось (или, возможно, нужно изменить в 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.

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/docker/docker_stack_task_info_module.html

Spec-Zone.ru

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