google.cloud.gcp_spanner_instance_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_instance_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 请求的用户代理字符串。

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 an instance
  gcp_spanner_instance_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂类型

资源列表

返回：始终

config

字符串

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

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

返回：成功

displayName

字符串

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

返回：成功

labels

字典

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

示例：{ “name”: “扳手”, “mass”: “1.3kg”, “count”: “3” }.

返回：成功

name（名称）

字符串

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

返回：成功

nodeCount（节点数）

整数

分配给此实例的节点数。在 Terraform 中，最多只能出现 node_count 或 processing_units 之一。

返回：成功

processingUnits（处理单元）

整数

分配给此实例的处理单元数。在 Terraform 中，最多只能出现 processing_units 或 node_count 之一。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)