community.general.etcd3 – Получение значений ключей из сервера etcd3

Примечание

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

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

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

Введено в версии 0.2.0: от community.general

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Извлекает значения ключей и/или префиксы ключей с сервера etcd3 с использованием его собственного API gRPC.
Попытается повторно использовать параметры подключения из community.general.etcd3, но добавит поддержку некоторых ETCDCTL_* переменных окружения.
См. https://github.com/etcd-io/etcd/tree/master/Documentation/op-guide для обзора etcd.

Требования

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

etcd3 >= 0.10

Параметры

Параметр	Варианты/Значения по умолчанию	Настройка	Комментарии
_terms список / элементы=строка / обязательно			Список ключей (или префиксов ключей), которые нужно найти на сервере etcd3.
ca_cert строка		env:ETCDCTL_CACERT	Уполномоченная организация сервера etcd3.
cert_cert строка		env:ETCDCTL_CERT	Сертификат клиента etcd3.
cert_key строка		env:ETCDCTL_KEY	Приватный ключ клиента etcd3.
endpoints строка	По умолчанию: "127.0.0.1:2379"	env:ETCDCTL_ENDPOINTS	Аналог переменной окружения `ETCDCTL_ENDPOINTS`. Укажите подключение к etcd3 с использованием URL-формата, например `https://hostname:2379` или `<host>:<port>`. Часть `host` перезаписывается параметром host, если он определен. Часть `port` перезаписывается параметром port, если он определен.
host строка			Хост сервера etcd3, принимающий клиентские подключения. Имеет приоритет перед параметром endpoints.
password строка		env:ETCDCTL_PASSWORD	Пароль аутентифицированного пользователя.
port целое число			Порт сервера etcd3, принимающий клиентские подключения. Имеет приоритет перед параметром endpoints.
prefix логический тип	Варианты: нет ← да		Искать ключ или префикс ключа.
timeout целое число	По умолчанию: 60	env:ETCDCTL_DIAL_TIMEOUT	Таймаут клиента.
user строка		env:ETCDCTL_USER	Имя аутентифицированного пользователя.

Примечания

Примечание

Параметры host и port имеют приоритет над параметром (endpoints).
Рекомендуемый способ подключения к серверу etcd3 — использование переменной окружения ETCDCTL_ENDPOINT, и не использовать параметры endpoints, host и port.

См. также

community.general.etcd3: Официальная документация модуля community.general.etcd3.
etcd – получение информации с сервера etcd: Поиск etcd v2.

Примеры

- name: "a value from a locally running etcd"
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.etcd3', 'foo/bar') }}"

- name: "values from multiple folders on a locally running etcd"
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.etcd3', 'foo', 'bar', 'baz') }}"

- name: "look for a key prefix"
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.etcd3', '/foo/bar', prefix=True) }}"

- name: "connect to etcd3 with a client certificate"
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.etcd3', 'foo/bar', cert_cert='/etc/ssl/etcd/client.pem', cert_key='/etc/ssl/etcd/client.key') }}"

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

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

Ключ		Возвращаемое значение	Описание
_raw список / элементы=словарь		успех	Список ключей и соответствующих значений.
	key строка	успех	Ключ элемента.
	value строка	успех	Значение элемента.

Авторы

Eric Belhomme (@eric-belhomme) <ebelhomme@fr.scc.com>

© 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/etcd3_lookup.html