community.general.consul_session – Управление сессиями consul
Примечание
Этот плагин входит в состав коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.consul_session.
Обзор
- Позволяет добавлять, изменять и удалять сессии в кластере 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 требуется как параметр. |
| validate_certs булево |
| Указывает, нужно ли проверять сертификат TLS агента consul. |
Примеры
- 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
Авторы
- 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.10/collections/community/general/consul_session_module.html
