Модуль community.general.consul_session – Управление сессиями consul

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

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

Для использования в плейбуке укажите: community.general.consul_session.

Обзор
Параметры
Атрибуты
Примеры

Обзор

Позволяет добавлять, изменять и удалять сессии в кластере consul. Эти сессии можно использовать совместно с парами ключ-значение для реализации распределённых блокировок. Подробная документация по работе с сессиями доступна по адресу http://www.consul.io/docs/internals/sessions.html

Параметры

Параметр	Комментарии
behavior строка	Необязательное поведение, которое может быть прикреплено к сессии при её создании. Это контролирует поведение при аннулировании сессии. Варианты: `"delete"` `"release"` ← (по умолчанию)
ca_path строка	Файл CA сертификатов для использования в HTTPS соединениях
checks список / элементы=строка	Проверки, которые будут использованы для проверки работоспособности сессии. Если все проверки завершатся неудачно, сессия будет аннулирована, и все связанные блокировки будут освобождены и могут быть получены после истечения срока ожидания, связанного с блокировкой.
datacenter строка	Имя датацентра, в котором существует или должна быть создана сессия.
delay целое число	Необязательное время ожидания блокировки, которое можно прикрепить к сессии при её создании. Блокировки для аннулированных сессий заблокированы от получения до истечения этого времени ожидания. Длительность в секундах. По умолчанию: `15`
host строка	Хост агента consul, по умолчанию `localhost`. По умолчанию: `"localhost"`
id строка	Идентификатор сессии, обязателен, когда `state` равно `info` или `remove`.
name строка	Имя, которое должно быть ассоциировано с сессией. Требуется при использовании `state=node`.
node строка	Имя узла, с которым будет связана сессия. По умолчанию - имя агента.
port целое число	Порт, на котором работает агент consul. По умолчанию: `8500`
scheme строка	Схема протокола, на котором работает агент consul. По умолчанию `http`, может быть установлено на `https` для защищённых соединений. По умолчанию: `"http"`
state строка	Должна ли сессия существовать (создаётся, если не существует) или отсутствовать (удаляется, если существует). Если создаётся, `id` сессии возвращается в выводе. Если `absent`, необходимо `id`, чтобы удалить сессию. Информация для отдельной сессии, все сессии для узла или все доступные сессии можно получить, указав `info`, `node` или `list` для `state`; для `node` или `info`, требуется указать узел `name` или сессию `id` в качестве параметра. Варианты: `"absent"` `"info"` `"list"` `"node"` `"present"` ← (по умолчанию)
token строка добавлено в community.general 5.6.0	Токен для авторизации.
ttl целое число добавлено в community.general 5.4.0	Определяет продолжительность сессии в секундах (от 10 до 86400).
validate_certs логическое	Требовать проверку TLS сертификата агента consul. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.consul добавлено в community.general 8.3.0	Используйте `group/community.general.consul` в `module_defaults` для установки значений по умолчанию для этого модуля.
check_mode	Поддержка: нет	Может работать в `check_mode` и возвращать прогноз о статусе изменений без модификации целевого объекта.
diff_mode	Поддержка: нет	В режиме diff будет возвращена информация о том, что изменилось (или, возможно, требует изменения в `check_mode`).

Примеры

- name: Register basic session with consul
  community.general.consul_session:
    name: session1

- name: Register a session with an existing check
  community.general.consul_session:
    name: session_with_check
    checks:
      - existing_check_name

- name: Register a session with lock_delay
  community.general.consul_session:
    name: session_with_delay
    delay: 20s

- name: Retrieve info about session by id
  community.general.consul_session:
    id: session_id
    state: info

- name: Retrieve active sessions
  community.general.consul_session:
    state: list

- name: Register session with a ttl
  community.general.consul_session:
    name: session-with-ttl
    ttl: 600  # sec

Авторы

Steve Gargan (@sgargan)
Håkon Lerring (@Hakon)

Ссылки на коллекцию

© 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/general/consul_session_module.html