consul_kv — Управление записями в хранилище ключей/значений кластера consul.
Новое в версии 2.0.
Описание
- Позволяет добавлять, изменять и удалять записи ключей/значений в кластере consul через агент. Полное содержимое записи, включая индексы, флаги и сеанс, возвращаются в качестве значения.
- Если ключ представляет собой префикс, то при удалении значения возвращается любое существующее значение, как часть результатов.
- Для получения более подробной информации см. http://www.consul.io/docs/agent/http.html#kv.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- python-consul
- requests
Параметры
| параметр | обязательно | по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| cas | нет | None | Используется при получении блокировки с помощью сеанса. Если cas равен 0, то Consul добавит ключ только в том случае, если он еще не существует. Если значение cas отлично от нуля, то ключ устанавливается только в том случае, если индекс совпадает с ModifyIndex этого ключа. | |
| flags | нет | None | Неявное целое значение, которое можно передать при установке значения. | |
| host | нет | localhost | Хост агента consul, по умолчанию localhost | |
| key | да | Ключ, по которому должно храниться значение. | ||
| port | нет | 8500 | Порт, на котором работает агент consul | |
| recurse | нет | Если ключ представляет собой префикс, каждая запись с префиксом может быть получена, если установить это значение в true. | ||
| scheme (добавлено в 2.1)
| нет | http | Схема протокола, на которой работает агент consul | |
| session | нет | None | Сеанс, который должен быть использован для получения или освобождения блокировки, связанной с парой ключ/значение | |
| state | нет | present |
| Действие, которое нужно выполнить с предоставленным ключом и значением. Если state равен 'present', содержимое ключа будет установлено в предоставленное значение, 'changed' будет установлено в true только в том случае, если значение отличалось от текущего содержимого. Значение 'absent' удалит пару ключ/значение, снова 'changed' будет установлено в true только в том случае, если ключ существовал до удаления. Можно попытаться получить или освободить блокировку, связанную с парой ключ/значение, с помощью состояний 'acquire' или 'release' соответственно. Для этого необходимо предоставить действительный сеанс. changed будет истинно, если попытка успешна, ложно в противном случае. |
| token | нет | None | Ключ токена, идентифицирующий набор правил ACL, который контролирует доступ к паре ключ/значение | |
| validate_certs (добавлено в 2.1)
| нет | True | Требуется ли проверка TLS-сертификата агента consul | |
| value | да | Значение, которое должно быть связано с данным ключом, требуется, если состояние равно 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
Статус
Этот модуль помечен как экспериментальный, что означает, что он не гарантирует обратную совместимость.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/consul_kv_module.html
