community.general.dsv 查找 – 从 Thycotic DevOps Secrets Vault 获取密钥

注意

此查找插件是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要进一步的要求才能使用此查找插件，请参阅要求以了解详细信息。

要在 playbook 中使用它，请指定：community.general.dsv。

community.general 1.0.0 中的新增功能

概要 

使用 Thycotic DevOps Secrets Vault Python SDK 从 DSV 获取密钥，使用 tenant、client_id 和 client_secret。

要求 

本地控制器节点执行此查找时需要以下要求。

python-dsv-sdk - https://pypi.ac.cn/project/python-dsv-sdk/

术语 

参数	注释
术语字符串 / 必需	密钥的路径，例如 `/staging/servers/web1`。

关键字参数 

这描述了查找的关键字参数。这些是以下示例中的值 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`

备注 

注意

当关键字和位置参数一起使用时，位置参数必须在关键字参数之前列出：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"] }}'

返回值 

键	描述
返回值列表 / 元素=字典	对 `GET /secrets/{path}` 的一个或多个 JSON 响应。请参阅 https://dsv.thycotic.com/api/index.html#operation/getSecret。已返回: 成功

作者

Adam Migus (@amigus)

提示

每个条目类型的配置条目都有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。