community.general.consul_kv – Извлечение метаданных из хранилища Consul key-value.

Примечание

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

Для его установки используйте: 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 https://python-consul.readthedocs.io/en/latest/#installation

Параметры

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

Примеры

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

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

Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого поиска:

Ключ	Возвращено	Описание
_raw словарь	успех	Сохраненное(ые) значение(я) в Consul.

Авторы

Неизвестно (!UNKNOWN)

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