consul_session - Управление сессиями consul
Новая версия с 2.0.
Обзор
- Разрешает добавление, изменение и удаление сессий в кластере consul. Эти сессии затем могут быть использованы совместно с парами ключ-значение для реализации распределённых блокировок. Подробная документация по работе с сессиями находится по адресу http://www.consul.io/docs/internals/sessions.html
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- python-consul
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| behavior (добавлен в 2.2) |
| Необязательное поведение, которое можно добавить к сессии при её создании. Это управляет поведением при аннулировании сессии. |
| checks | Список проверок, которые будут использоваться для проверки состояния сессии. Если все проверки завершатся неудачно, сессия будет аннулирована, а любые связанные с ней блокировки будут освобождены и могут быть получены повторно после истечения срока ожидания блокировки. | |
| datacenter | Имя зоны данных, в которой существует или должна быть создана сессия. | |
| delay | По умолчанию: 15 | Необязательное время ожидания блокировки, которое можно добавить к сессии при её создании. Блокировки для аннулированных сессий заблокированы от получения до истечения этого времени ожидания. Длительности указаны в секундах. |
| host | По умолчанию: localhost | Хост агента consul, по умолчанию localhost. |
| name | Имя, которое должно быть связано с сессией. Для Consul это значение прозрачно и не требуется. | |
| node | Имя узла, с которым будет связана сессия. По умолчанию это имя агента. | |
| port | По умолчанию: 8500 | Порт, на котором работает агент consul. |
| scheme (добавлен в 2.1) | По умолчанию: http | Схема протокола, на котором работает агент consul. |
| state |
| Сессия должна быть present (создана, если не существует), или absent (удалена, если существует). Если создана, ID сессии возвращается в выводе. Если absent, имя или ID необходимы для удаления сессии. Информация для отдельной сессии, все сессии для узла или все доступные сессии могут быть получены, указав info, node или list для state; для node или info, имя узла или ID сессии требуется в качестве параметра. |
| validate_certs (добавлен в 2.1) |
| Выполнять проверку 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
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Автор
- 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.5/modules/consul_session_module.html
