google.cloud.gcp_secret_manager 模块 – 访问和更新 Google Cloud Secrets Manager 对象

注意

此模块是 google.cloud 集合（版本 1.4.1）的一部分。

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

要安装它，请使用： ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定： google.cloud.gcp_secret_manager。

注意

由于违反 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合有未解决的健全性测试失败。有关更多信息，请参阅讨论线程。

概要

  • 访问存储在 Google Secrets Manager 中的密钥。

  • 创建新密钥。

  • 创建新的密钥值。

  • 添加/删除密钥版本。

  • 请注意，其他功能（如 etag、复制、注释）预计在 Ansible 之外进行管理。

要求

执行此模块的主机需要满足以下要求。

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

auth_kind

字符串 / 必需

使用的凭据类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

labels

字典

一组键值对，用于将标签分配给密钥

仅在创建时使用

请注意，标签的“值”部分必须仅包含可读字符

name

别名：key、secret、secret_id

字符串 / 必需

要使用的密钥的名称

project

字符串

要使用的 Google Cloud Platform 项目。

return_value

布尔值

如果为 true，则密钥的值将以未加密的形式返回到 Ansible

如果为 false，则不会返回或解密任何值

选择

  • false

  • true ← （默认）

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串。

service_account_email

字符串

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可以使用可选的服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则服务帐户 JSON 文件的路径。

state

字符串

密钥是否存在

选择

  • "absent"

  • "present" ← （默认）

value

字符串

密钥应具有的密钥值

这将在创建时设置

如果密钥值不是此值，则将使用此值添加新版本

version

字符串

要应用于密钥的版本标签

默认值为“latest”，即密钥的最新版本

特殊的“all”在删除时也是可接受的（这将删除密钥的所有版本）

默认值： "latest"

注意

注意

  • API 参考：https://cloud.google.com/secret-manager/docs/reference/rests

  • 官方文档：https://cloud.google.com/secret-manager/docs/overview

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。

  • 对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。

  • 对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 scopes。

  • 只有在剧本值未设置的情况下，才会使用环境变量的值。

  • service_account_email 和 service_account_file 选项是互斥的。

示例

- name: Create a new secret
  google.cloud.gcp_secret_manager:
    name: secret_key
    value: super_secret
    state: present
    auth_kind: serviceaccount
    service_account_file: service_account_creds.json

- name: Ensure the secretexists, fail otherwise and return the value
  google.cloud.gcp_secret_manager:
    name: secret_key
    state: present

- name: Ensure secret exists but don't return the value
  google.cloud.gcp_secret_manager:
    name: secret_key
    state: present
    return_value: false

- name: Add a new version of a secret
  google.cloud.gcp_secret_manager:
    name: secret_key
    value: updated super secret
    state: present

- name: Delete version 1 of a secret (but not the secret itself)
  google.cloud.gcp_secret_manager:
    name: secret_key
    version: 1
    state: absent

- name: Delete all versions of a secret
  google.cloud.gcp_secret_manager:
    name: secret_key
    version: all
    state: absent

- name: Create a secret with labels
  google.cloud.gcp_secret_manager:
    name: secret_key
    value: super_secret
    labels:
      key_name: "ansible_rox"

作者

  • Dave Costakos @RedHat