google.cloud.gcp_spanner_database 模块 – 创建一个 GCP 数据库

注意

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

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

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

要在剧本中使用它，请指定：google.cloud.gcp_spanner_database。

注意

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

概要 

一个 Cloud Spanner 数据库，它托管在 Spanner 实例上。

要求 

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

参数 

参数	注释
access_token 字符串	如果凭据类型是 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选择 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
encryption_config 字典	数据库的加密配置。
kms_key_name 字符串 / 必需	用于加密此数据库的 KMS 密钥的完全限定名称。此密钥必须与 Spanner 数据库位于同一位置。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
extra_statements 列表 / elements=字符串	一个可选的 DDL 语句列表，用于在新创建的数据库中运行。语句可以创建表、索引等。这些语句与数据库的创建原子执行：如果任何语句中存在错误，则不会创建数据库。
instance 字典 / 必需	在其上创建数据库的实例。此字段表示 GCP 中实例资源的链接。可以通过两种方式指定它。首先，您可以放置一个字典，其中包含键“name”和您的资源名称的值。或者，您可以将 `register: name-of-resource` 添加到 gcp_spanner_instance 任务，然后将此实例字段设置为“{{ name-of-resource }}”
name 字符串 / 必需	数据库的唯一标识符，实例创建后无法更改。值的形式为 [a-z][-a-z0-9]*[a-z0-9]。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / elements=字符串	要使用的范围数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择了 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应存在于 GCP 中选择 `"present"` ← （默认） `"absent"`

注释 

注意

API 参考：https://cloud.google.com/spanner/docs/reference/rest/v1/projects.instances.databases
官方文档：https://cloud.google.com/spanner/
对于身份验证，您可以使用 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。
仅当未设置剧本值时，才会使用环境变量值。
service_account_email 和 service_account_file 选项是互斥的。

示例 

- name: create a instance
  google.cloud.gcp_spanner_instance:
    name: instance-database
    display_name: My Spanner Instance
    node_count: 2
    labels:
      cost_center: ti-1700004
    config: regional-us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instance

- name: create a database
  google.cloud.gcp_spanner_database:
    name: webstore
    instance: "{{ instance }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

通用的返回值记录在这里，以下是此模块特有的字段

键	描述
encryptionConfig 复杂类型	数据库的加密配置。返回: 成功
kmsKeyName 字符串	用于加密此数据库的 KMS 密钥的完全限定名称。此密钥必须与 Spanner 数据库位于同一位置。返回: 成功
extraStatements 列表 / elements=字符串	一个可选的 DDL 语句列表，用于在新创建的数据库中运行。语句可以创建表、索引等。这些语句与数据库的创建原子执行：如果任何语句中存在错误，则不会创建数据库。返回: 成功
instance 字典	在其上创建数据库的实例。返回: 成功
name 字符串	数据库的唯一标识符，实例创建后无法更改。值的形式为 [a-z][-a-z0-9][a-z0-9]。返回:* 成功

作者

Google Inc. (@googlecloudplatform)