google.cloud.gcp_bigtable_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_bigtable_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_bigtable_instance_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂

资源列表

返回：始终

clusters

复杂

集群数组。最多 4 个。

返回：成功

defaultStorageType

字符串

此集群用于为其父实例的表提供服务的存储类型，除非明确覆盖。

返回：成功

location

字符串

此集群的节点和存储所在的地理位置。为了获得最佳性能，客户端应尽可能靠近此集群。目前仅支持区域，因此值应为 `projects/<project>/locations/<zone>` 形式。

返回：成功

name

字符串

集群的唯一名称。

返回：成功

serveNodes

整数

分配给此集群的节点数。更多节点可以实现更高的吞吐量和更一致的性能。

返回：成功

state

字符串

集群的当前状态。

返回：成功

displayName

字符串

此实例在 UI 中显示的描述性名称。

可以在任何时间更改，但应保持全局唯一以避免混淆。

返回：成功

labels

字典

标签是一种灵活且轻量级的机制，用于将云资源组织成反映客户组织需求和部署策略的组。它们可用于过滤资源和聚合指标。

返回：成功

name

字符串

实例的唯一名称。

返回：成功

state

字符串

实例的当前状态。

返回：成功

type

字符串

实例的类型。默认为 `PRODUCTION`。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)