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

Примечание

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

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

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

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

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

Обзор

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

Требования

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

python-consul python библиотека https://python-consul.readthedocs.io/en/latest/#installation

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

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

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

Примеры

- 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) }}"

Значение возврата

Ключ	Описание
Значение возврата словарь	Значение(я), сохранённые в consul. Возвращено: успешно

Авторы

Неизвестно

Подсказка

Параметры конфигурации для каждого типа записи имеют порядок приоритета от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/consul_kv_lookup.html