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

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

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

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

Описание

Получение метаданных для плейбука из хранилища key-value в кластере 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 строка			Получение ключа из зоны 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 булево	Варианты: нет ← да		Если 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 строка	По умолчанию: "да"	записи ini: [lookup_consul] validate_certs = да переменные окружения: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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/consul_kv_lookup.html