community.general.dsv lookup — получение секретов из Thycotic DevOps Secrets Vault

Примечание

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

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

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

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

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

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

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

Использует Python SDK для Thycotic DevOps Secrets Vault, чтобы получить секреты из DSV tenant с помощью client_id и client_secret.

Требования

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

python-dsv-sdk — https://pypi.org/project/python-dsv-sdk/

Параметры

Параметр	Комментарии
Параметры строка / обязательный	Путь к секрету, например `/staging/servers/web1`.

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

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

Параметр	Комментарии
client_id строка / обязательный	client_id, с которым запрашивается разрешение на доступ. Конфигурация: Запись INI: [dsv_lookup] client_id = VALUE Переменная окружения: `DSV_CLIENT_ID`
client_secret строка / обязательный	Секрет клиента, связанный с указанным `client_id`. Конфигурация: Запись INI: [dsv_lookup] client_secret = VALUE Переменная окружения: `DSV_CLIENT_SECRET`
tenant строка / обязательный	Первый форматный параметр в шаблоне `url_template` по умолчанию. Конфигурация: Запись INI: [dsv_lookup] tenant = VALUE Переменная окружения: `DSV_TENANT`
tld строка	Домен верхнего уровня арендатора; второй форматный параметр в шаблоне `url_template` по умолчанию. По умолчанию: `"com"` Конфигурация: Запись INI: [dsv_lookup] tld = com Переменная окружения: `DSV_TLD`
url_template строка	Путь, добавляемый перед базовым URL для формирования корректного запроса к REST API. По умолчанию: `"https://{}.secretsvaultcloud.{}/v1"` Конфигурация: Запись INI: [dsv_lookup] url_template = https://{}.secretsvaultcloud.{}/v1 Переменная окружения: `DSV_URL_TEMPLATE`

Примечание

Перечисленные выше записи конфигурации для каждого типа записей (переменная Ansible, переменная окружения и так далее) расположены в порядке приоритета от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределяет переменную, расположенную выше. Типы записей также упорядочены по возрастанию приоритета. Например, запись ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примечания

Примечание

При совместном использовании именованных и позиционных параметров позиционные параметры необходимо указывать перед именованными: lookup('community.general.dsv', term1, term2, key1=value1, key2=value2) и query('community.general.dsv', term1, term2, key1=value1, key2=value2)

Примеры

- hosts: localhost
  vars:
    secret: "{{ lookup('community.general.dsv', '/test/secret') }}"
  tasks:
    - ansible.builtin.debug:
        msg: 'the password is {{ secret["data"]["password"] }}'

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

Ключ	Описание
Возвращаемое значение список / элементы=словарь	Один или несколько ответов JSON на `GET /secrets/{path}`. См. https://dsv.thycotic.com/api/index.html#operation/getSecret. Возвращается: при успехе

Авторы

Adam Migus (@amigus)

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

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