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

Примечание

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

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

Для использования в книге задач укажите: community.docker.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.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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/docker/docker_stack_module.html