google.cloud.gcp_compute_node_group_info 模块 – 收集 GCP 节点组信息

注意

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

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

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

要在 playbook 中使用它，请指定：google.cloud.gcp_compute_node_group_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 请求的用户代理字符串。

filters

列表 / elements=字符串

过滤器值对的列表。可用的过滤器在此处列出：https://cloud.google.com/sdk/gcloud/reference/topic/filters。

列表中的每个附加过滤器都将作为 AND 条件（filter1 和 filter2）添加。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / elements=字符串

要使用的范围数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串形式。

service_account_email

字符串

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

zone

字符串 / 必需

此节点组所在的区域。

注意

注意

  • 对于身份验证，您可以使用 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 a node group
  gcp_compute_node_group_info:
    zone: us-central1-a
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂

资源列表

返回：始终

autoscalingPolicy

复杂

如果您为工作负载使用单租户节点，则可以使用节点组自动缩放器自动管理节点组的大小。

返回：成功

maxNodes

整数

节点组的最大大小。设置为小于或等于 100 且大于或等于 min-nodes 的值。

返回：成功

minNodes

整数

节点组的最小大小。必须小于或等于 max-nodes。默认值为 0。

返回：成功

mode

字符串

自动缩放模式。设置为以下之一： - OFF：禁用自动缩放器。

  • ON：启用横向扩展和横向缩减。

  • ONLY_SCALE_OUT：仅启用横向扩展。

如果您的节点组配置为在最小服务器上重新启动其托管的 VM，则必须使用此模式。

返回：成功

creationTimestamp

字符串

RFC3339 文本格式的创建时间戳。

返回：成功

description

字符串

资源的可选文本描述。

返回：成功

maintenancePolicy

字符串

指定当组中的节点进行维护时如何处理实例。设置为以下之一：DEFAULT、RESTART_IN_PLACE 或 MIGRATE_WITHIN_NODE_GROUP。默认值为 DEFAULT。

返回：成功

maintenanceWindow

复杂

包含维护时间范围的属性。

返回：成功

startTime

字符串

instances.窗口的开始时间。这必须采用 UTC 格式，解析为 00:00、04:00、08:00、12:00、16:00 或 20:00 之一。例如，13:00-5 和 08:00 都是有效的。

返回：成功

name

字符串

资源的名称。

返回：成功

nodeTemplate

字典

此节点组所属的节点模板的 URL。

返回：成功

size

整数

节点组中节点的总数。

返回：成功

zone

字符串

此节点组所在的区域。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)