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

Примечание

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

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

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

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

Добавлено в community.general 0.2.0

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

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

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

Требования

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

etcd3 >= 0.10

Параметры

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

Именованные параметры

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

Параметр	Комментарии
ca_cert string	Центр сертификации CA для etcd3. Необходим для включения TLS при подключении к конечной точке etcd3 по HTTPS. Конфигурация: Переменная окружения: `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`, если он задан. Обратите внимание: указание `https://` в URL конечной точки само по себе не включает TLS. Для подключения к конечной точке etcd3 по HTTPS необходимо указать `ca_cert` (а также при необходимости `cert_cert` и `cert_key`). По умолчанию: `"127.0.0.1:2379"` Конфигурация: Переменная окружения: `ETCDCTL_ENDPOINTS`
host string	Хост, на котором etcd3 принимает клиентские подключения. Имеет приоритет над `endpoints`. Должно быть указано имя хоста или IP-адрес без схемы URL. Если присутствует префикс `https://` или `http://`, он будет автоматически удалён.
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 неиспользуемыми.
Для подключения к конечной точке etcd3 по HTTPS необходимо указать параметр ca_cert. Одного лишь указания https:// в endpoints недостаточно для включения TLS.

См. также

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

- name: "connect to etcd3 over HTTPS"
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.etcd3', 'foo/bar', endpoints='https://etcd.example.com:2379', ca_cert='/etc/ssl/etcd/ca.pem') }}"

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

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

Авторы

Eric Belhomme (@eric-belhomme)

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

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