consul_kv – Получение метаданных из хранилища ключей Consul
Обзор
- Получение метаданных для плана выполнения из хранилища ключей в кластере Consul. Значения легко задаются в хранилище kv с помощью простых команд 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 boolean | По умолчанию: "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 значение(я). |
Статус
- Этот поиск не гарантирует обратную совместимость. [превью]
- Этот поиск поддерживается сообществом Ansible. [community]
Авторы
- НЕИЗВЕСТНО
Подсказка
Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
Подсказка
Записи конфигурации для каждого типа записи имеют порядок приоритета от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/plugins/lookup/consul_kv.html
