consul_kv – Получение метаданных из хранилища ключей Consul.
Новая версия с 1.9.
Описание
- Поиск метаданных для плана действий в хранилище ключей в кластере Consul. Значения можно легко установить в хранилище ключей с помощью простых команд REST.
curl -X PUT -d 'some-value' http://localhost:8500/v1/kv/ansible/somedata
Требования
Ниже перечислены требования к локальному мастер-узлу, на котором выполняется этот поиск.
- Библиотека python-consul https://python-consul.readthedocs.io/en/latest/#installation
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| _raw список / обязательно | Список ключей для извлечения. | ||
| client_cert - добавлен в 2.8 | Значение по умолчанию: "None" | записи ini: [lookup_consul] переменная среды:ANSIBLE_CONSUL_CLIENT_CERT | Сертификат клиента для проверки ssl-соединения. |
| host - добавлен в 2.8 | Значение по умолчанию: "localhost" | записи ini: [lookup_consul] переменная среды:ANSIBLE_CONSUL_URL | Целевой адрес для подключения, должен быть разрешаемым адресом. Будет определен из ANSIBLE_CONSUL_URL , если это установлено.ANSIBLE_CONSUL_URL должен выглядеть так: https://my.consul.server:8500
|
| index - | Если ключ имеет значение с указанным индексом, то оно возвращается, позволяя получить доступ к историческим значениям. | ||
| port - | Значение по умолчанию: 8500 | Порт целевого хоста для подключения. Если используется ANSIBLE_CONSUL_URL, это значение будет использовано оттуда. | |
| recurse булево | Значение по умолчанию: "no" | Если true, будут извлечены все значения, имеющие заданный ключ в качестве префикса. | |
| scheme - добавлен в 2.8 | Значение по умолчанию: "http" | Использование http или https. Если используется ANSIBLE_CONSUL_URL, это значение будет использовано оттуда. | |
| token - | Токен acl для доступа к ограниченным значениям. | ||
| validate_certs - добавлен в 2.8 | Значение по умолчанию: "yes" | записи ini: [lookup_consul] переменная среды:ANSIBLE_CONSUL_VALIDATE_CERTS | Проверять ssl-соединение или нет. |
Примеры
- debug:
msg: 'key contains {{item}}'
with_consul_kv:
- 'key/to/retrieve'
- name: Parameters can be provided after the key be more specific about what to retrieve
debug:
msg: 'key contains {{item}}'
with_consul_kv:
- 'key/to recurse=true token=E6C060A9-26FB-407A-B83E-12DDAFCB4D98'
- name: retrieving a KV from a remote cluster on non default port
debug:
msg: "{{ lookup('consul_kv', 'my/key', host='10.10.10.10', port='2000') }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого поиска:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| _raw - | Сохранённое(ые) значение(я) в Consul. |
Статус
Авторы
- НЕИЗВЕСТНЫЙ
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 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/plugins/lookup/consul_kv.html