google.cloud.gcp_container_node_pool 模块 – 创建 GCP NodePool

注意

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

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

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

要在剧本中使用它，请指定：google.cloud.gcp_container_node_pool。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在 未解决的完整性测试失败。请参阅 讨论主题 以了解更多信息。

概要

  • NodePool 包含集群节点池的名称和配置。

  • 节点池是一组节点（即虚拟机），它们具有通用的配置和规范，并受集群主节点控制。它们可能应用有一组 Kubernetes 标签，这些标签可用于在 Pod 调度期间引用它们。还可以对其进行向上或向下调整大小以适应工作负载。

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

autoscaling

字典

此 NodePool 的自动缩放器配置。只有存在有效的配置时才启用自动缩放器。

enabled

布尔值

此节点池是否启用了自动缩放。

选项

  • false

  • true

max_node_count

整数

NodePool 中节点的最大数量。必须 >= minNodeCount。

必须有足够的配额来扩展集群。

min_node_count

整数

NodePool 中节点的最小数量。必须 >= 1 且 <= maxNodeCount。

cluster

字典 / 必需

此节点池所属的集群。

此字段表示指向 GCP 中集群资源的链接。可以通过两种方式指定它。首先，您可以放置一个字典，其中键为“name”，值为资源的名称。或者，您可以将 `register: name-of-resource` 添加到 gcp_container_cluster 任务中，然后将此 cluster 字段设置为“{{ name-of-resource }}”

conditions

列表 / 元素=字典

导致当前节点池状态的条件。

code

字符串

条件的机器友好的表示。

一些有效的选项包括：“UNKNOWN”、“GCE_STOCKOUT”、“GKE_SERVICE_ACCOUNT_DELETED”、“GCE_QUOTA_EXCEEDED”、“SET_BY_OPERATOR”

config

字典

池的节点配置。

accelerators

列表 / 元素=字典

要附加到每个节点的一组硬件加速器。

accelerator_count

整数

公开给实例的加速器卡数量。

accelerator_type

字符串

加速器类型资源名称。

disk_size_gb

整数

附加到每个节点的磁盘大小（以 GB 为单位）。允许的最小磁盘大小为 10GB。如果未指定，则默认磁盘大小为 100GB。

disk_type

字符串

附加到每个节点的磁盘类型（例如“pd-standard”或“pd-ssd”）。如果未指定，则默认磁盘类型为“pd-standard”。

image_type

字符串

要为此节点使用的映像类型。请注意，对于给定的映像类型，将使用其最新版本。

labels

字典

要应用于每个节点的 Kubernetes 标签映射（键/值对）。这些将添加到 Kubernetes 可能应用于节点的任何默认标签之外。如果标签键冲突，则应用的集合可能因 Kubernetes 版本而异——最好假设行为未定义，应避免冲突。有关更多信息，包括用法和有效值，请参见：https://kubernetes.ac.cn/v1.1/docs/user-guide/labels.html 包含“键”：值对列表的对象。

示例：{“name”：“wrench”，“mass”：“1.3kg”，“count”：“3”}。

local_ssd_count

整数

要附加到节点的本地 SSD 磁盘数量。

此值的限制取决于每个区域中机器上可用的最大磁盘数量。有关更多信息，请参见：https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits

machine_type

字符串

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”}。

min_cpu_platform

字符串

此实例要使用的最小 CPU 平台。该实例可能安排在指定的或更新的 CPU 平台上。

oauth_scopes

列表 / 元素=字符串

要在“default”服务帐户下在所有节点 VM 上提供的 Google API 范围集。

建议但不是必需的范围，默认情况下不包括以下范围：https://www.googleapis.com/auth/compute 是在节点上挂载持久性存储所需的。

https://www.googleapis.com/auth/devstorage.read_only 是与 gcr.io（Google Container Registry）通信所需的。

如果未指定，则不会添加任何范围，除非启用了 Cloud Logging 或 Cloud Monitoring，在这种情况下，将添加它们所需的范围。

抢占式

布尔值

节点是否创建为抢占式虚拟机实例。有关抢占式虚拟机实例的更多信息，请参见：https://cloud.google.com/compute/docs/instances/preemptible

选项

  • false

  • true

service_account

字符串

节点虚拟机将使用的 Google Cloud Platform 服务帐号。如果未指定服务帐号，则使用“默认”服务帐号。

shielded_instance_config

字典

安全实例选项。

enable_integrity_monitoring

布尔值

定义实例是否启用了完整性监控。

启用对实例引导完整性的监控和验证。

验证针对完整性策略基线进行。此基线最初是在创建实例时从隐式受信任的引导映像派生的。

选项

  • false

  • true

enable_secure_boot

布尔值

定义实例是否启用了安全启动。

安全启动通过验证所有引导组件的数字签名并在签名验证失败时停止引导过程，帮助确保系统仅运行经过身份验证的软件。

选项

  • false

  • true

tags

列表 / 元素=字符串

应用于所有节点的实例标签列表。标签用于标识网络防火墙的有效来源或目标，并在集群或节点池创建期间由客户端指定。列表中的每个标签必须符合 RFC1035。

taints

列表 / 元素=字典

要应用于每个节点的 Kubernetes 污点列表。

effect

字符串

污点的效果。

key

字符串

污点的键。

value

字符串

污点的值。

workload_meta_config

字典

WorkloadMetadataConfig 定义要向节点池上工作负载公开的元数据配置。

mode

字符串

Mode 是关于如何向节点池上运行的工作负载公开元数据的配置。

一些有效的选项包括：“GCE_METADATA”、“GKE_METADATA”

env_type

字符串

指定您在此模块中运行的 Ansible 环境。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

initial_node_count

整数 / 必填

池的初始节点数。您必须确保您的 Compute Engine 资源配额足以满足此数量的实例。您还必须有可用的防火墙和路由配额。

位置

别名：区域、区域

字符串 / 必需

部署节点池的位置。

management

字典

此 NodePool 的管理配置。

auto_repair

布尔值

指定是否为节点池启用节点自动修复的标志。如果启用，则将监控此节点池中的节点，如果它们多次未能通过运行状况检查，则将触发自动修复操作。

选项

  • false

  • true

auto_upgrade

布尔值

指定是否为节点池启用节点自动升级的标志。如果启用，节点自动升级将帮助使节点池中的节点保持最新版本的 Kubernetes。

选项

  • false

  • true

upgrade_options

字典

指定节点池的自动升级旋钮。

max_pods_constraint

字典

对节点池中节点上可以同时运行的最大 Pod 数的约束。

max_pods_per_node

整数

对每个节点上最大 Pod 数施加的约束。

name

字符串

节点池的名称。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的范围数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

path

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

state

字符串

给定对象是否应存在于 GCP 中

选项

  • "present" ← (默认)

  • "absent"

version

字符串

此节点的 Kubernetes 版本。

示例

- name: create a cluster
  google.cloud.gcp_container_cluster:
    name: cluster-nodepool
    initial_node_count: 4
    location: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: cluster

- name: create a node pool
  google.cloud.gcp_container_node_pool:
    name: my-pool
    initial_node_count: 4
    cluster: "{{ cluster }}"
    location: us-central1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

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

键

描述

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

列表 / 元素=字符串

要在“default”服务帐户下在所有节点 VM 上提供的 Google API 范围集。

建议但不是必需的范围，默认情况下不包括以下范围：https://www.googleapis.com/auth/compute 是在节点上挂载持久性存储所需的。

https://www.googleapis.com/auth/devstorage.read_only 是与 gcr.io（Google Container Registry）通信所需的。

如果未指定，则不会添加任何范围，除非启用了 Cloud Logging 或 Cloud Monitoring，在这种情况下，将添加它们所需的范围。

返回：成功

抢占式

布尔值

节点是否创建为抢占式虚拟机实例。有关抢占式虚拟机实例的更多信息，请参见：https://cloud.google.com/compute/docs/instances/preemptible

返回：成功

serviceAccount

字符串

节点虚拟机将使用的 Google Cloud Platform 服务帐号。如果未指定服务帐号，则使用“默认”服务帐号。

返回：成功

shieldedInstanceConfig

复杂

安全实例选项。

返回：成功

enableIntegrityMonitoring

布尔值

定义实例是否启用了完整性监控。

启用对实例引导完整性的监控和验证。

验证针对完整性策略基线进行。此基线最初是在创建实例时从隐式受信任的引导映像派生的。

返回：成功

enableSecureBoot

布尔值

定义实例是否启用了安全启动。

安全启动通过验证所有引导组件的数字签名并在签名验证失败时停止引导过程，帮助确保系统仅运行经过身份验证的软件。

返回：成功

tags

列表 / 元素=字符串

应用于所有节点的实例标签列表。标签用于标识网络防火墙的有效来源或目标，并在集群或节点池创建期间由客户端指定。列表中的每个标签必须符合 RFC1035。

返回：成功

taints

复杂

要应用于每个节点的 Kubernetes 污点列表。

返回：成功

effect

字符串

污点的效果。

返回：成功

key

字符串

污点的键。

返回：成功

value

字符串

污点的值。

返回：成功

workloadMetaConfig

复杂

WorkloadMetadataConfig 定义要向节点池上工作负载公开的元数据配置。

返回：成功

mode

字符串

Mode 是关于如何向节点池上运行的工作负载公开元数据的配置。

返回：成功

initialNodeCount

整数

池的初始节点数。您必须确保您的 Compute Engine 资源配额足以满足此数量的实例。您还必须有可用的防火墙和路由配额。

返回：成功

location

字符串

部署节点池的位置。

返回：成功

management

复杂

此 NodePool 的管理配置。

返回：成功

autoRepair

布尔值

指定是否为节点池启用节点自动修复的标志。如果启用，则将监控此节点池中的节点，如果它们多次未能通过运行状况检查，则将触发自动修复操作。

返回：成功

autoUpgrade

布尔值

指定是否为节点池启用节点自动升级的标志。如果启用，节点自动升级将帮助使节点池中的节点保持最新版本的 Kubernetes。

返回：成功

upgradeOptions

复杂

指定节点池的自动升级旋钮。

返回：成功

autoUpgradeStartTime

字符串

当升级即将开始时，此字段将设置为升级的大致开始时间，以 RFC3339 文本格式表示。

返回：成功

description

字符串

当升级即将开始时，此字段将设置为升级的描述。

返回：成功

maxPodsConstraint

复杂

对节点池中节点上可以同时运行的最大 Pod 数的约束。

返回：成功

maxPodsPerNode

整数

对每个节点上最大 Pod 数施加的约束。

返回：成功

name

字符串

节点池的名称。

返回：成功

podIpv4CidrSize

整数

此节点池中每个节点的 Pod CIDR 块大小。

返回：成功

status

字符串

此池实例中节点的状态。

返回：成功

statusMessage

字符串

有关此节点池实例当前状态的附加信息。

返回：成功

version

字符串

此节点的 Kubernetes 版本。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)