поиск community.general.consul_kv – получение метаданных из хранилища ключей-значений Consul

Примечание

Этот плагин поиска входит в коллекцию community.general (версия 12.6.1).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого плагина поиска требуются дополнительные компоненты. Подробности см. в разделе Требования.

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

Краткое описание
Требования
Параметры ключевых слов
Примеры
Возвращаемое значение

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

Поиск метаданных для плейбука в хранилище ключей-значений кластера Consul. Значения можно легко задать в хранилище ключей-значений с помощью простых REST-команд.
curl -X PUT -d 'some-value' http://localhost:8500/v1/kv/ansible/somedata.

Требования

Следующие требования необходимы на локальном узле контроллера, который выполняет этот поиск.

Библиотека Python py-consul https://github.com/criteo/py-consul?tab=readme-ov-file#installation

Параметры ключевых слов

Здесь описаны параметры ключевых слов этого поиска. Это значения key1=value1, key2=value2 и т. д. в следующих примерах: lookup('community.general.consul_kv', key1=value1, key2=value2, ...) и query('community.general.consul_kv', key1=value1, key2=value2, ...)

Параметр	Комментарии
_raw list / elements=string	Список ключей для получения.
ca_path string добавлено в community.general 12.6.0	Пакет сертификатов CA для HTTPS-подключений. Конфигурация: Запись INI: [lookup_consul] ca_path = VALUE Переменная окружения: `ANSIBLE_CONSUL_CA_PATH`
client_cert string	Сертификат клиента для проверки TLS-подключения. Конфигурация: Запись INI: [lookup_consul] client_cert = VALUE Переменная окружения: `ANSIBLE_CONSUL_CLIENT_CERT`
datacenter string	Получить ключ из центра обработки данных Consul, отличного от используемого по умолчанию для узла Consul.
host string	Целевой узел для подключения; адрес должен разрешаться. Определяется из `ANSIBLE_CONSUL_URL`, если она задана. По умолчанию: `"localhost"` Конфигурация: Запись INI: [lookup_consul] host = localhost
index integer	Если у ключа есть значение с указанным индексом, возвращается оно, что позволяет получать исторические значения.
port integer	Порт целевого узла, к которому нужно подключиться. Если используется `ANSIBLE_CONSUL_URL`, значение берётся из неё. По умолчанию: `8500`
recurse boolean	Если `true`, получает все значения, ключи которых начинаются с указанного префикса. Варианты: `false` ← (по умолчанию) `true`
scheme string	Использовать http или https. Если используется `ANSIBLE_CONSUL_URL`, значение берётся из неё. По умолчанию: `"http"`
token string	Токен ACL для доступа к значениям с ограниченным доступом.
url string добавлено в community.general 1.0.0	Целевой узел для подключения. Должен иметь следующий вид: `https://my.consul.server:8500`. Конфигурация: Запись INI: [lookup_consul] url = VALUE Переменная окружения: `ANSIBLE_CONSUL_URL`
validate_certs boolean	Проверять ли TLS-подключение. Вместо установки значения `false` рекомендуется использовать `ca_path`. Варианты: `false` `true` ← (по умолчанию) Конфигурация: Запись INI: [lookup_consul] validate_certs = true Переменная окружения: `ANSIBLE_CONSUL_VALIDATE_CERTS`

Примечание

Перечисленные выше записи конфигурации для каждого типа источника (переменная Ansible, переменная окружения и т. д.) расположены в порядке приоритета от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределяет переменную, расположенную выше. Типы записей также упорядочены по приоритету от низкого к высокому. Например, запись в ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примеры

- ansible.builtin.debug:
    msg: 'key contains {{item}}'
  with_community.general.consul_kv:
    - 'key/to/retrieve'

- name: Parameters can be provided after the key be more specific about what to retrieve
  ansible.builtin.debug:
    msg: 'key contains {{item}}'
  with_community.general.consul_kv:
    - 'key/to recurse=true token=E6C060A9-26FB-407A-B83E-12DDAFCB4D98'

- name: retrieving a KV from a remote cluster on non default port
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.consul_kv', 'my/key', host='10.10.10.10', port=2000) }}"

Возвращаемое значение

Ключ	Описание
Возвращаемое значение dictionary	Значения, сохранённые в Consul. Возвращается: success

Авторы

Неизвестно

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

© 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_kv_lookup.html