community.general.dsv lookup – Получение секретов из хранилища секретов Thycotic DevOps

Примечание

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

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

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

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

Новое в community.general 1.0.0

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

Описание

Использует Python SDK хранилища секретов Thycotic DevOps для получения секретов из 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 для запроса Access Grant. Конфигурация: Запись 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`

Примечания

Примечание

При совместном использовании параметров ключевых слов и позиционных параметров, позиционные параметры должны быть перечислены перед параметрами ключевых слов: 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. Возвращено: успех

Авторы

Адам Мигус (@amigus)

Подсказка

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

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

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