Модуль community.general.consul_session — управление сеансами Consul

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.consul_session.

Краткое описание
Параметры
Атрибуты
Примеры

Краткое описание

Позволяет добавлять, изменять и удалять сеансы в кластере Consul. Эти сеансы можно использовать совместно с парами «ключ — значение» для реализации распределённых блокировок. Подробную документацию по работе с сеансами можно найти по адресу http://www.consul.io/docs/internals/sessions.html.

Параметры

Параметр	Комментарии
behavior string	Необязательное поведение, которое можно назначить сеансу при его создании. Оно определяет поведение при аннулировании сеанса. Варианты: `"delete"` `"release"` ← (по умолчанию)
ca_path string	Пакет сертификатов CA для HTTPS-соединений.
checks list / elements=string	Проверки, используемые для контроля состояния сеанса. Если все проверки завершаются с ошибкой, сеанс аннулируется, а все связанные с ним блокировки освобождаются и становятся доступны для получения после истечения связанной с ними задержки блокировки.
datacenter string	Имя центра обработки данных, в котором существует сеанс или должен быть создан.
delay integer	Необязательная задержка блокировки, которую можно назначить сеансу при его создании. Блокировки аннулированных сеансов нельзя получить, пока не истечёт эта задержка. Длительность указывается в секундах. По умолчанию: `15`
host string	Узел агента Consul. По умолчанию: `"localhost"`
id string	ID сеанса; требуется, если значение `state` равно `info` или `remove`.
name string	Имя, связанное с сеансом. Обязательно, если используется `state=node`.
node string	Имя узла, с которым связан сеанс. По умолчанию это имя агента.
port integer	Порт, на котором работает агент Consul. По умолчанию: `8500`
scheme string	Схема протокола, используемая агентом Consul. По умолчанию используется `http`; для защищённых соединений можно указать `https`. По умолчанию: `"http"`
state string	Должен ли сеанс присутствовать (то есть создаваться, если он не существует) или отсутствовать (то есть удаляться, если он существует). Если сеанс создан, в выходных данных возвращается его `id`. Если указано `absent`, для удаления сеанса требуется `id`. Сведения об одном сеансе, обо всех сеансах узла или обо всех доступных сеансах можно получить, указав `info`, `node` или `list` для параметра `state`; для `node` или `info` требуется передать параметром узел `name` или сеанс `id`. Варианты: `"absent"` `"info"` `"list"` `"node"` `"present"` ← (по умолчанию)
token string добавлено в community.general 5.6.0	Токен для авторизации.
ttl integer добавлено в community.general 5.4.0	Задаёт длительность сеанса в секундах (от 10 до 86400).
validate_certs boolean	Проверять ли сертификат TLS агента Consul. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.consul добавлено в community.general 8.3.0	Используйте `group/community.general.consul` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: нет	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примеры

- 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

- name: Register session with a ttl
  community.general.consul_session:
    name: session-with-ttl
    ttl: 600 # sec

Авторы

Steve Gargan (@sgargan)
Håkon Lerring (@Hakon)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/consul_session_module.html