google.cloud.gcp_container_node_pool_info 模块 – 收集 GCP 节点池的信息

注意

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

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

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

要在 playbook 中使用它，请指定：google.cloud.gcp_container_node_pool_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"
cluster 字典 / 必需	此节点池所属的集群。 此字段表示 GCP 中指向 Cluster 资源的链接。 可以通过两种方式指定它。 首先，您可以放置一个字典，其中键为“name”，值为您的资源的名称。或者，您可以将“register: name-of-resource”添加到 gcp_container_cluster 任务，然后将此集群字段设置为“{{ name-of-resource }}”
env_type 字符串	指定您在此模块中运行的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的 User Agent 字符串。
location 别名：region, zone 字符串 / 必需	部署节点池的位置。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / elements=字符串	要使用的作用域数组
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 a node pool
  gcp_container_node_pool_info:
    cluster: "{{ cluster }}"
    location: us-central1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键	描述
resources 复杂	资源列表 返回： 始终
autoscaling 复杂	此 NodePool 的自动缩放器配置。 仅当存在有效配置时，才会启用自动缩放器。 返回： 成功
enabled 布尔值	是否为此节点池启用了自动缩放。 返回： 成功
maxNodeCount 整数	NodePool 中的最大节点数。 必须 >= minNodeCount。 必须有足够的配额来扩展集群。 返回： 成功
minNodeCount 整数	NodePool 中的最小节点数。 必须 >= 1 且 <= maxNodeCount。 返回： 成功
cluster 字典	此节点池所属的集群。 返回： 成功
conditions 复杂	导致当前节点池状态的条件。 返回： 成功
code 字符串	条件的机器友好表示。 返回： 成功
config 复杂	池的节点配置。 返回： 成功
accelerators 复杂	要附加到每个节点的硬件加速器列表。 返回： 成功
acceleratorCount 整数	向实例公开的加速卡数量。 返回： 成功
acceleratorType 字符串	加速器类型资源名称。 返回： 成功
diskSizeGb 整数	附加到每个节点的磁盘大小，以 GB 为单位指定。 允许的最小磁盘大小为 10GB。 如果未指定，则默认磁盘大小为 100GB。 返回： 成功
diskType 字符串	附加到每个节点的磁盘类型（例如“pd-standard”或“pd-ssd”）。 如果未指定，则默认磁盘类型为“pd-standard”。 返回： 成功
imageType 字符串	要用于此节点的映像类型。 请注意，对于给定的映像类型，将使用它的最新版本。 返回： 成功
labels 字典	要应用于每个节点的 Kubernetes 标签（键/值对）的映射。 这些标签将添加到 Kubernetes 可能应用于节点的任何默认标签之外。 如果标签键发生冲突，则应用的集合可能会因 Kubernetes 版本而异 – 最好假设行为是未定义的，并且应避免冲突。 有关更多信息，包括用法和有效值，请参阅： https://kubernetes.ac.cn/v1.1/docs/user-guide/labels.html 包含“键”：“值”对列表的对象。 示例：{ “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }。 返回： 成功
localSsdCount 整数	要附加到节点的本地 SSD 磁盘的数量。 此值的限制取决于每个区域的机器上可用的最大磁盘数量。 有关更多信息，请参阅： https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits。 返回： 成功
machineType 字符串	Google Compute Engine 机器类型的名称（例如 n1-standard-1）。 如果未指定，则默认机器类型为 n1-standard-1。 返回： 成功
metadata 字典	分配给集群中实例的元数据键/值对。 键必须符合正则表达式 [a-zA-Z0-9-_]+，并且长度小于 128 字节。 这些会反映在元数据服务器的 URL 中。 此外，为避免歧义，键不得与项目的任何其他元数据键冲突，也不得是四个保留键之一：“instance-template”、“kube-env”、“startup-script”和“user-data”。 值是自由格式的字符串，并且只有在实例中运行的映像解释时才有意义。 对它们的唯一限制是每个值的大小必须小于或等于 32 KB。 所有键和值的总大小必须小于 512 KB。 包含“键”：“值”对列表的对象。 示例：{ “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }。 返回： 成功
minCpuPlatform 字符串	此实例要使用的最低 CPU 平台。该实例可能会在指定的或更新的 CPU 平台上进行调度。 返回： 成功
oauthScopes 列表 / elements=字符串	要在“默认”服务帐户下的所有节点虚拟机上提供的 Google API 范围集。 建议但不强制执行以下范围，默认情况下不包含这些范围： https://www.googleapis.com/auth/compute 是在节点上挂载持久存储所必需的。 https://www.googleapis.com/auth/devstorage.read_only 是与 gcr.io（Google 容器注册表）通信所必需的。 如果未指定，则不添加任何范围，除非启用了云日志记录或云监控，在这种情况下，将添加其所需的范围。 返回： 成功
preemptible 布尔值	是否将节点创建为抢占式虚拟机实例。 有关抢占式虚拟机实例的更多信息，请参阅： https://cloud.google.com/compute/docs/instances/preemptible。 返回： 成功
serviceAccount 字符串	节点虚拟机要使用的 Google Cloud Platform 服务帐户。 如果未指定服务帐户，则使用“默认”服务帐户。 返回： 成功
shieldedInstanceConfig 复杂	屏蔽实例选项。 返回： 成功
enableIntegrityMonitoring 布尔值	定义实例是否启用了完整性监控。 启用对实例启动完整性的监控和证明。 证明是根据完整性策略基线执行的。 此基线最初是从创建实例时隐式信任的启动映像派生的。 返回： 成功
enableSecureBoot 布尔值	定义实例是否启用了安全启动。 安全启动通过验证所有启动组件的数字签名，并在签名验证失败时停止启动过程，有助于确保系统仅运行正版软件。 返回： 成功
tags 列表 / elements=字符串	应用于所有节点的实例标签列表。 标签用于标识网络防火墙的有效源或目标，并由客户端在集群或节点池创建期间指定。 列表中的每个标签都必须符合 RFC1035。 返回： 成功
taints 复杂	要应用于每个节点的 Kubernetes 污点列表。 返回： 成功
effect 字符串	污点的效果。 返回： 成功
key 字符串	污点的键。 返回： 成功
value 字符串	污点的值。 返回： 成功
workloadMetaConfig 复杂	WorkloadMetadataConfig 定义要向节点池上的工作负载公开的元数据配置。 返回： 成功
mode 字符串	模式是关于如何向节点池上运行的工作负载公开元数据的配置。 返回： 成功
initialNodeCount 整数	池的初始节点计数。 您必须确保您的 Compute Engine 资源配额足以满足此实例数量。 您还必须有可用的防火墙和路由配额。 返回： 成功
location 字符串	部署节点池的位置。 返回： 成功
management 复杂	此节点池的管理配置。 返回： 成功
autoRepair 布尔值	一个标志，用于指定是否为节点池启用节点自动修复。 如果启用，将监控此节点池中的节点，并且如果它们多次未通过运行状况检查，将触发自动修复操作。 返回： 成功
autoUpgrade 布尔值	一个标志，用于指定是否为节点池启用节点自动升级。 如果启用，节点自动升级有助于使节点池中的节点与 Kubernetes 的最新发布版本保持同步。 返回： 成功
upgradeOptions 复杂	指定节点池的自动升级旋钮。 返回： 成功
autoUpgradeStartTime 字符串	当升级即将开始时，将设置此字段，该字段采用 RFC3339 文本格式，其中包含升级的大致开始时间。 返回： 成功
description 字符串	当升级即将开始时，将设置此字段，其中包含升级的描述。 返回： 成功
maxPodsConstraint 复杂	对节点池中节点上可以同时运行的最大 Pod 数量的约束。 返回： 成功
maxPodsPerNode 整数	对每个节点的最大 Pod 数强制执行的约束。 返回： 成功
name 字符串	节点池的名称。 返回： 成功
podIpv4CidrSize 整数	此节点池中每个节点的 Pod CIDR 块大小。 返回： 成功
status 字符串	此池实例中节点的状态。 返回： 成功
statusMessage 字符串	有关此节点池实例当前状态的其他信息。 返回： 成功
version 字符串	此节点的 Kubernetes 版本。 返回： 成功

作者

• Google Inc. (@googlecloudplatform)

集合链接

• 问题跟踪器
• 主页
• 存储库（源）