docker_stack – модуль стека docker

Новый в версии 2.8.

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

Описание

Управление стеками 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.

Примеры

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

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

- name: Remove stack
  docker_stack:
    name: mystack
    state: absent

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

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

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

Статус

Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/docker_stack_module.html