community.docker.docker_stack – модуль docker stack

Примечание

Этот плагин входит в коллекцию community.docker (версия 1.2.2).

Для его установки используйте: ansible-galaxy collection install community.docker.

Для использования в playbook, укажите: community.docker.docker_stack.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управление docker стеками с помощью команды «docker stack» на целевом узле (см. примеры).

Требования

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

jsondiff
pyyaml

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
absent_retries целое число	Значение по умолчанию: 0	Если `>0` и состояние равно `absent`, модуль будет повторно пытаться удалить стек до absent_retries раз, пока все ресурсы не будут удалены. Если последняя попытка по-прежнему сообщает о том, что стек не удален полностью, модуль завершится ошибкой.
absent_retries_interval целое число	Значение по умолчанию: 1	Интервал в секундах между последовательными попытками absent_retries.
compose список / элементы=сырье	Значение по умолчанию: []	Список определений compose. Любой элемент может быть строкой, указывающей на путь к файлу compose на целевом хосте, или YAML-содержанием файла compose, вложенным в виде словаря.
name строка / обязательно		Имя стека
prune логическое значение	Варианты: нет ← да	Если True, добавит опцию `--prune` к команде `docker stack deploy`. Это заставит docker удалить сервисы, отсутствующие в текущем определении стека.
resolve_image строка	Варианты: всегда изменённые никогда	Если установлено, добавит опцию `--resolve-image` к команде `docker stack deploy`. Это заставит docker запросить реестр для разрешения дайджеста изображений и поддерживаемых платформ. Если не установлено, docker использует "всегда" по умолчанию.
state строка	Варианты: наличие ← отсутствие	Состояние сервиса.
with_registry_auth логическое значение	Варианты: нет ← да	Если true, добавит опцию `--with-registry-auth` к команде `docker stack deploy`. Это заставит docker передать данные аутентификации реестра агентам Swarm.

Примечания

Примечание

Возвращаемые значения out и err устарели и будут удалены в community.docker 2.0.0. Используйте stdout и stderr вместо них.

Примеры

- name: Deploy stack from a compose file
  community.docker.docker_stack:
    state: present
    name: mystack
    compose:
      - /opt/docker-compose.yml

- name: Deploy stack from base compose file and override the web service
  community.docker.docker_stack:
    state: present
    name: mystack
    compose:
      - /opt/docker-compose.yml
      - version: '3'
        services:
          web:
            image: nginx:latest
            environment:
              ENVVAR: envvar

- name: Remove stack
  community.docker.docker_stack:
    name: mystack
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
stack_spec_diff словарь	при изменении	Словарь, содержащий различия между полем «Spec» сервисов стека до и после применения нового определения стека. Пример: "stack_spec_diff": {'test_stack_test_service': {u'TaskTemplate': {u'ContainerSpec': {delete: [u'Env']}}}}

Авторы

Dario Zanzico (@dariko)

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