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 - |
| Указывает, должна ли сессия существовать (создаваться, если не существует), или отсутствовать (удаляться, если существует). При создании ID сессии возвращается в выводе. Если отсутствует, требуется имя или ID для удаления сессии. Информация о конкретной сессии, всех сессиях для узла или всех доступных сессиях может быть получена, указав info, node или list для state; для node или info, требуется имя узла или ID сессии как параметр. |
| validate_certs boolean добавлен в 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
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/consul_session_module.html
