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

Примечание

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

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

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

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

Обзор

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

Требования

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

jsondiff
pyyaml

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
absent_retries целое число	Значение по умолчанию: 0	Если `>0`, и state равен `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.general 3.0.0. Используйте stdout и stderr вместо них.

Примеры

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

- name: Deploy stack from base compose file and override the web service
  community.general.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.general.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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/docker_stack_module.html