google.cloud.gcp_spanner_database_info 模块 – 收集 GCP 数据库信息

注意

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

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

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

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

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在 未解决的完整性测试失败。有关更多信息，请参见 讨论主题。

概要

  • 收集 GCP 数据库信息

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

字符串

指定您在此模块中运行的 Ansible 环境。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

instance

字典 / 必需

要在其上创建数据库的实例。

此字段表示 GCP 中指向实例资源的链接。它可以通过两种方式指定。首先，您可以放置一个键为“name”且值为资源名称的字典。或者，您可以将 `register: name-of-resource` 添加到 gcp_spanner_instance 任务，然后将此实例字段设置为“{{ name-of-resource }}”

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

路径

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

注释

注意

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

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

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

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

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

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

  • 仅当未设置 playbook 值时，才会使用环境变量值。

  • service_account_email 和 service_account_file 选项是互斥的。

示例

- name: get info on a database
  gcp_spanner_database_info:
    instance: "{{ instance }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

常见返回值已记录在 此处，以下是此模块特有的字段

键

描述

resources

复杂类型

资源列表

返回：始终

encryptionConfig

复杂类型

数据库的加密配置。

返回：成功

kmsKeyName

字符串

用于加密此数据库的 KMS 密钥的全限定名称。此密钥必须存在于与 Spanner 数据库相同的位置。

返回：成功

extraStatements

列表 / 元素=字符串

一个可选的 DDL 语句列表，用于在新创建的数据库内运行。语句可以创建表、索引等。这些语句与数据库的创建一起原子地执行：如果任何语句出现错误，则不会创建数据库。

返回：成功

instance

字典

要在其上创建数据库的实例。

返回：成功

name

字符串

数据库的唯一标识符，在实例创建后无法更改。值格式为 [a-z][-a-z0-9]*[a-z0-9]。

返回：成功

作者

  • 谷歌公司 (@googlecloudplatform)