consul_kv — Управление записями в хранилище ключ/значение кластера consul
Новое в версии 2.0.
Обзор
- Позволяет добавлять, изменять и удалять записи ключ/значение в кластере consul через агента. Полное содержимое записи, включая индексы, флаги и сеанс, возвращается как «значение».
- Если ключ представляет собой префикс, обратите внимание, что при удалении значения возвращается существующее значение, если таковое имеется, в качестве части результатов.
- Дополнительные сведения см. в http://www.consul.io/docs/agent/http.html#kv.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- python-consul
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| cas | Используется при получении блокировки с сеансом. Если cas равно 0, то Consul установит ключ только в том случае, если он еще не существует. Если значение cas отлично от нуля, то ключ устанавливается только в том случае, если индекс соответствует ModifyIndex этого ключа. | |
| flags | Непрозрачное целое значение, которое можно передать при установке значения. | |
| host | По умолчанию: localhost | Хост агента consul. |
| key обязательно | Ключ, в котором должно храниться значение. | |
| port | По умолчанию: 8500 | Порт, на котором работает агент consul. |
| recurse |
| Если ключ представляет собой префикс, каждую запись с префиксом можно получить, установив это значение в yes. |
| scheme (добавлен в 2.1) | По умолчанию: http | Схема протокола, на которой работает агент consul. |
| session | Сеанс, который должен использоваться для получения или освобождения блокировки, связанной с парой ключ/значение. | |
| state |
| Действие, которое нужно выполнить с заданным ключом и значением. Если состояние равно 'present', содержимое ключа будет установлено в предоставленное значение, 'changed' будет установлено в true только в том случае, если значение отличалось от текущего содержимого. Состояние 'absent' удалит пару ключ/значение, при этом 'changed' будет установлено в true только в том случае, если ключ фактически существовал до удаления. Можно попытаться получить или освободить блокировку, связанную с парой ключ/значение, с помощью состояний 'acquire' или 'release' соответственно. Для этого необходимо предоставить действительный сеанс. Значение changed будет равно true, если попытка успешна, и false в противном случае. |
| token | Ключ токена, определяющий набор правил ACL, которые контролируют доступ к паре ключ/значение. | |
| validate_certs (добавлен в 2.1) |
| Требуется ли проверка сертификата TLS агента consul. |
| value обязательно | Значение должно быть связано с данным ключом, обязательно, если state равно present. |
Примеры
- name: Add or update the value associated with a key in the key/value store
consul_kv:
key: somekey
value: somevalue
- name: Remove a key from the store
consul_kv:
key: somekey
state: absent
- name: Add a node to an arbitrary group via consul inventory (see consul.ini)
consul_kv:
key: ansible/groups/dc1/somenode
value: top_secret
- name: Register a key/value pair with an associated session
consul_kv:
key: stg/node/server_birthday
value: 20160509
session: "{{ sessionid }}"
state: acquire
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Steve Gargan (@sgargan)
- Colin Nolan (@colin-nolan)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_kv_module.html
