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

Примечание

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

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

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

Для использования в playbook укажите: community.general.etcd3.

Новое в community.general 0.2.0

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

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

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

Требования

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

etcd3 >= 0.10

Термины

Параметр	Комментарии
Terms list / elements=string / required	Список ключей (или префиксов ключей) для поиска на сервере etcd3.

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

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

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

Примечания

Примечание

При использовании параметров ключевых слов и позиционных параметров позиционные параметры должны быть указаны перед параметрами ключевых слов: lookup('community.general.etcd3', term1, term2, key1=value1, key2=value2) и query('community.general.etcd3', term1, term2, key1=value1, key2=value2)
Параметры host и port имеют приоритет над параметром (endpoints).
Рекомендуемый способ подключения к серверу etcd3 — использование переменной окружения ETCDCTL_ENDPOINT и оставлять параметры endpoints, host и port неиспользованными.

См. также

community.general.etcd3: Установка или удаление пар «ключ-значение» из кластера etcd3.
community.general.etcd плагин поиска: получение информации с сервера etcd.

Примеры

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

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

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

Авторы

Eric Belhomme (@eric-belhomme)

Подсказка

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

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

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