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 bool (добавлено в 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, что означает, что его интерфейс не гарантируется как обратная совместимость.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом 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.6/modules/consul_session_module.html
