consul_session – Управление сессиями consul
Описание
- Позволяет добавлять, изменять и удалять сессии в кластере consul. Эти сессии могут быть использованы совместно с парами ключ-значение для реализации распределённых блокировок. Более подробная документация по работе с сессиями доступна по адресу http://www.consul.io/docs/internals/sessions.html
Требования
Ниже перечислены требования к хосту, на котором будет выполняться данный модуль.
- python-consul
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| behavior строка |
| Необязательное поведение, которое может быть прикреплено к сессии при её создании. Это управляет поведением при аннулировании сессии. |
| checks список | Проверки, которые будут использоваться для проверки работоспособности сессии. Если все проверки завершатся неудачно, сессия будет аннулирована, а все связанные с ней блокировки будут освобождены и могут быть получены повторно после истечения времени ожидания, связанного с блокировкой. | |
| datacenter строка | Имя дата-центра, в котором существует или должна быть создана сессия. | |
| delay целое число | По умолчанию: 15 | Необязательное время ожидания блокировки, которое может быть прикреплено к сессии при её создании. Блокировки для аннулированных сессий блокируются до истечения этого времени ожидания. Длительности указаны в секундах. |
| host строка | По умолчанию: "localhost" | Хост агента consul по умолчанию localhost. |
| id строка | Идентификатор сессии, обязательный, когда state равен либо info либо remove. | |
| name строка | Имя, которое должно быть ассоциировано с сессией. Обязательно, когда используется state=node. | |
| node строка | Имя узла, с которым будет ассоциирована сессия. По умолчанию — имя агента. | |
| port целое число | По умолчанию: 8500 | Порт, на котором работает агент consul. |
| scheme строка | По умолчанию: "http" | Схема протокола, на котором работает агент consul. |
| state строка |
| Указывает, должна ли сессия присутствовать (т.е. создаваться, если она не существует), или отсутствовать (удаляться, если она существует). Если создаётся, ID сессии возвращается в выводе. Если absent, ID необходим для удаления сессии. Информация об одной сессии, всех сессиях для узла или всех доступных сессиях может быть получена, указав info, node или list для state; для node или info, требуется имя узла name или ID сессии id в качестве параметра. |
| validate_certs булево |
| Требовать проверку TLS-сертификата агента consul. |
Примеры
- name: register basic session with consul
consul_session:
name: session1
- name: register a session with an existing check
consul_session:
name: session_with_check
checks:
- existing_check_name
- name: register a session with lock_delay
consul_session:
name: session_with_delay
delay: 20s
- name: retrieve info about session by id
consul_session:
id: session_id
state: info
- name: retrieve active sessions
consul_session:
state: list
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Steve Gargan (@sgargan)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/consul_session_module.html
