google.cloud.gcp_spanner_instance 模块 – 创建 GCP 实例

注意

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

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

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

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

注意

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

概要

  • 一组隔离的 Cloud Spanner 资源，可在其上托管数据库。

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

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

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

config

字符串 / 必需

实例配置的名称（类似于但并非完全相同于区域），它定义了此实例中数据库的地理位置和复制。它决定了数据存储位置。值通常采用 `regional-europe-west1`、`us-central` 等形式。

要获取有效列表，请参考 [文档的配置部分](https://cloud.google.com/spanner/docs/instances)。

display_name

字符串 / 必需

此实例在 UI 中显示的描述性名称。每个项目以及项目之间都必须唯一，长度必须在 4 到 30 个字符之间。

env_type

字符串

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

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

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

labels

字典

包含“键”：值对列表的对象。

示例：{ “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }。

name

字符串 / 必需

实例的唯一标识符，创建实例后无法更改。名称长度必须在 6 到 30 个字符之间。

node_count

整数

分配给此实例的节点数。在 terraform 中，最多只能存在 node_count 或 processing_units 中的一个。

processing_units

整数

分配给此实例的处理单元数。在 terraform 中，最多只能存在 processing_units 或 node_count 中的一个。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组

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

  • 官方文档：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。

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

  • service_account_email 和 service_account_file 选项是互斥的。

示例

- name: create a instance
  google.cloud.gcp_spanner_instance:
    name: testinstance
    display_name: My Spanner Instance
    node_count: 2
    labels:
      cost_center: ti-1700004
    config: regional-us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

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

键

描述

config

字符串

实例配置的名称（类似于但并非完全相同于区域），它定义了此实例中数据库的地理位置和复制。它决定了数据存储位置。值通常采用 `regional-europe-west1`、`us-central` 等形式。

要获取有效列表，请参考 [文档的配置部分](https://cloud.google.com/spanner/docs/instances)。

返回：success

显示名称

字符串

此实例在 UI 中显示的描述性名称。每个项目以及项目之间都必须唯一，长度必须在 4 到 30 个字符之间。

返回：success

labels

字典

包含“键”：值对列表的对象。

示例：{ “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }。

返回：success

name

字符串

实例的唯一标识符，创建实例后无法更改。名称长度必须在 6 到 30 个字符之间。

返回：success

节点数量

整数

分配给此实例的节点数。在 terraform 中，最多只能存在 node_count 或 processing_units 中的一个。

返回：success

处理单元

整数

分配给此实例的处理单元数。在 terraform 中，最多只能存在 processing_units 或 node_count 中的一个。

返回：success

作者

  • 谷歌公司 (@googlecloudplatform)