sensu.sensu_go.secret 模块 – 管理 Sensu Go 密钥
注意
此模块是 sensu.sensu_go 集合（版本 1.14.0）的一部分。
如果您使用的是 ansible 包，则您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install sensu.sensu_go。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：sensu.sensu_go.secret。
注意
由于违反了 Ansible 包含要求，sensu.sensu_go 集合将从 Ansible 12 中移除。该集合存在 未解决的健全性测试失败。有关更多信息，请参阅 讨论主题。
sensu.sensu_go 1.6.0 中的新增功能
摘要
创建、更新或删除 Sensu 密钥。
有关更多信息，请参阅 Sensu 文档：https://docs.sensu.io/sensu-go/latest/operations/manage-secrets/secrets/。
要求
执行此模块的主机需要以下要求。
python >= 2.7
参数
参数 |
注释 |
|---|---|
身份验证参数。也可以使用 ENV 定义每个参数。 |
|
进行身份验证时应使用的 API 密钥。如果未设置此项，则将检查 SENSU_API_KEY 环境变量的值。 这将替换 *auth.user* 和 *auth.password* 参数。 有关 API 密钥的更多信息，请参阅 Sensu 官方文档：https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/。 |
|
应用于验证后端证书的 CA 捆绑包的路径。 如果未设置此参数，模块将使用 python 使用的 CA 捆绑包。 也可以通过 *SENSU_CA_PATH* 环境变量设置此参数。 |
|
Sensu 用户的密码。如果未设置此项，则将检查 SENSU_PASSWORD 环境变量的值。 如果设置了 *auth.api_key* 参数，则忽略此参数。 默认值： |
|
Sensu 后端 API 的位置。如果未设置此项，则将检查 SENSU_URL 环境变量的值。 默认值： |
|
用于连接到 Sensu API 的用户名。如果未设置此项，则将检查 SENSU_USER 环境变量的值。 如果设置了 *auth.api_key* 参数，则忽略此参数。 默认值： |
|
控制证书验证的标志。 如果您使用的是自签名证书，可以将此参数设置为 仅在开发场景中使用此参数！如果您在生产环境中使用自签名证书，请参阅 *auth.ca_path* 参数。 也可以通过 *SENSU_VERIFY* 环境变量设置此参数。 选项
|
|
提供程序存储区中密钥的 ID。 如果 *state* 为 |
|
Sensu 资源的名称。此名称（在适用情况下与命名空间结合使用）唯一标识 Ansible 操作的资源。 如果具有所选名称的资源已存在，Ansible 模块将更新它以匹配任务中的规范。 有关有效名称和其他限制的更多详细信息，请参阅上游文档中关于 https://docs.sensu.io/sensu-go/latest/reference/ 的 *name* 元数据属性规范。 |
|
要操作的 RBAC 命名空间。如果未设置此项，则将使用 SENSU_NAMESPACE 环境变量的值。 默认值： |
|
支持密钥值的密钥提供程序的名称。 如果 *state* 为 |
|
Sensu 对象的目标状态。 选项
|
另请参阅
另请参阅
- sensu.sensu_go.secret_info
列出可用的 Sensu Go 密钥。
- sensu.sensu_go.secrets_provider_env
管理 Sensu Env 密钥提供程序。
- sensu.sensu_go.secrets_provider_vault
管理 Sensu VaultProvider 密钥提供程序。
- sensu.sensu_go.secrets_provider_info
列出 Sensu 密钥提供程序。
示例
- name: Create an environment varibale-backed secret
sensu.sensu_go.secret:
name: env_secret
provider: env
id: MY_ENV_VARIABLE
- name: Create a HashiCorp Vault-backed secret
sensu.sensu_go.secret:
name: hashi_valut_secret
provider: vault
id: secret/store#name
- name: Delete a secret
sensu.sensu_go.secret:
name: my_secret
state: absent
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
表示 Sensu 密钥的对象。 返回：成功 示例： |