google.cloud.gcp_bigtable_instance 模块 – 创建 GCP 实例

注意

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

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

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

要在 Playbook 中使用它，请指定： google.cloud.gcp_bigtable_instance。

注意

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

概要 

Bigtable 表及其服务的资源集合。实例中的所有表都由实例中的所有集群提供服务。

要求 

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

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

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
clusters 列表 / 元素=字典	集群数组。最大 4 个。
default_storage_type 字符串	此集群用于为其父实例的表提供服务的存储类型，除非显式覆盖。一些有效选项包括：“STORAGE_TYPE_UNSPECIFIED”、“SSD”、“HDD”
location 字符串	此集群的节点和存储所在的位置。为了获得最佳性能，客户端应尽可能靠近此集群。目前仅支持区域，因此值应采用 `projects//locations/` 的形式。
name 字符串	集群的唯一名称。
serve_nodes 整数	分配给此集群的节点数。更多节点可实现更高的吞吐量和更一致的性能。
display_name 字符串	此实例在 UI 中显示的描述性名称。可以随时更改，但应保持全局唯一，以避免混淆。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的 User-Agent 字符串。
labels 字典	标签是一种灵活且轻量级的机制，用于将云资源组织成反映客户组织需求和部署策略的组。它们可用于过滤资源和聚合指标。
name 字符串	实例的唯一名称。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / 元素=字符串	要使用的范围数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典，也可以是表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应存在于 GCP 中选项 `"present"` ←（默认） `"absent"`
type 字符串	实例的类型。默认为 `PRODUCTION`。一些有效选项包括：“TYPE_UNSPECIFIED”、“PRODUCTION”、“DEVELOPMENT”

示例 

- name: create a instance
  google.cloud.gcp_bigtable_instance:
    name: my-instance
    display_name: My Test Cluster
    clusters:
    - name: mycluster
      location: projects/test_project/locations/us-central1-a
      serve_nodes: 1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

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

键	描述
clusters 复杂	集群数组。最大 4 个。已返回：成功
defaultStorageType 字符串	此集群用于为其父实例的表提供服务的存储类型，除非显式覆盖。已返回：成功
location 字符串	此集群的节点和存储所在的位置。为了获得最佳性能，客户端应尽可能靠近此集群。目前仅支持区域，因此值应采用 `projects//locations/` 的形式。已返回：成功
name 字符串	集群的唯一名称。已返回：成功
serveNodes 整数	分配给此集群的节点数。更多节点可实现更高的吞吐量和更一致的性能。已返回：成功
state 字符串	集群的当前状态。已返回：成功
displayName 字符串	此实例在 UI 中显示的描述性名称。可以随时更改，但应保持全局唯一，以避免混淆。已返回：成功
labels 字典	标签是一种灵活且轻量级的机制，用于将云资源组织成反映客户组织需求和部署策略的组。它们可用于过滤资源和聚合指标。已返回：成功
name 字符串	实例的唯一名称。已返回：成功
state 字符串	实例的当前状态。已返回：成功
type 字符串	实例的类型。默认为 `PRODUCTION`。已返回：成功

作者

Google Inc. (@googlecloudplatform)