REST Resource: projects.locations.azureClusters.azureNodePools

资源:AzureNodePool

在 Azure 上运行的 Anthos 节点池。

JSON 表示法
{
  "name": string,
  "version": string,
  "config": {
    object (AzureNodeConfig)
  },
  "subnetId": string,
  "autoscaling": {
    object (AzureNodePoolAutoscaling)
  },
  "state": enum (State),
  "uid": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "maxPodsConstraint": {
    object (MaxPodsConstraint)
  },
  "azureAvailabilityZone": string,
  "errors": [
    {
      object (AzureNodePoolError)
    }
  ],
  "management": {
    object (AzureNodeManagement)
  }
}
字段
name

string

此资源的名称。

节点池名称采用 projects/<project-number>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id> 格式。

如需详细了解 Google Cloud 资源名称,请参阅资源名称

version

string

必需。在此节点池上运行的 Kubernetes 版本(例如 1.19.10-gke.1000)。

config

object (AzureNodeConfig)

必需。节点池的节点配置。

subnetId

string

必需。在其中运行节点池虚拟机的子网的 ARM ID。确保它是集群配置中虚拟网络下的子网。

autoscaling

object (AzureNodePoolAutoscaling)

必需。此节点池的自动扩缩器配置。

state

enum (State)

仅限输出。节点池的当前状态。

uid

string

仅限输出。节点池的全局唯一标识符。

reconciling

boolean

仅限输出。如果设置,则目前存在节点池的待更改项。

createTime

string (Timestamp format)

仅限输出。此节点池的创建时间。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

仅限输出。此节点池的上次更新时间。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

etag

string

允许客户端通过乐观并发控制执行一致的“读取-修改-写入”操作。

可在更新和删除请求中发送,以确保客户端在继续操作之前具有最新值。

annotations

map (key: string, value: string)

可选。节点池上的注解。

此字段的限制与 Kubernetes 注解相同。所有键和值的总大小不得超过 256k。键可以包含 2 个部分:前缀(可选)和名称(必需),以斜杠 (/) 分隔。前缀必须是 DNS 子网域。名称不得超过 63 个字符,以字母数字字符开头和结尾,中间可以使用短划线 (-)、下划线 (_)、点 (.) 和字母数字字符。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

maxPodsConstraint

object (MaxPodsConstraint)

必需。可在节点池中的节点上同时运行的 pod 数上限的限制。

azureAvailabilityZone

string

可选。此节点池中节点的 Azure 可用区。

如果未指定,则默认为 1

errors[]

object (AzureNodePoolError)

仅限输出。在节点池中发现的一组错误。

management

object (AzureNodeManagement)

可选。此节点池的管理配置。

AzureNodeConfig

用于描述给定节点池上所有节点机器的配置的参数。

JSON 表示法
{
  "vmSize": string,
  "rootVolume": {
    object (AzureDiskTemplate)
  },
  "tags": {
    string: string,
    ...
  },
  "imageType": string,
  "sshConfig": {
    object (AzureSshConfig)
  },
  "proxyConfig": {
    object (AzureProxyConfig)
  },
  "configEncryption": {
    object (AzureConfigEncryption)
  },
  "taints": [
    {
      object (NodeTaint)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
字段
vmSize

string

可选。Azure 虚拟机大小名称。示例:Standard_DS2_v2

如需了解相关选项,请参阅支持的虚拟机大小

如果未指定,则默认为 Standard_DS2_v2

rootVolume

object (AzureDiskTemplate)

可选。与为每个节点池机器预配的根卷相关的配置。

如果未指定,则默认为 32 GiB Azure 磁盘。

tags

map (key: string, value: string)

可选。要应用于此节点池的所有底层 Azure 资源的一组标记。目前仅包括虚拟机规模集。

最多指定 50 对,其中包含字母数字字符、空格和符号 (.+-=_:@/)。键不得超过 127 个 Unicode 字符。值不得超过 255 个 Unicode 字符。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

imageType

string

可选。要在节点池实例上使用的操作系统映像类型。可以不指定,也可以指定为 ubuntu 值。

如果未指定,则默认为 ubuntu

sshConfig

object (AzureSshConfig)

必需。用于指定节点池机器访问方式的 SSH 配置。

proxyConfig

object (AzureProxyConfig)

可选。出站 HTTP(S) 流量的代理配置。

configEncryption

object (AzureConfigEncryption)

可选。与虚拟机 config 加密相关的配置。

taints[]

object (NodeTaint)

可选。分配给此节点池的节点的初始污点。

labels

map (key: string, value: string)

可选。分配给此节点池的节点的初始标签。包含 "key": value 对列表的对象。例如:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

AzureNodePoolAutoscaling

与 Kubernetes 集群自动扩缩器相关的配置。

Kubernetes 集群自动扩缩器将根据集群负载自动调整节点池的大小。

JSON 表示法
{
  "minNodeCount": integer,
  "maxNodeCount": integer
}
字段
minNodeCount

integer

必需。节点池中的节点数下限。必须大于或等于 1,且小于或等于 maxNodeCount。

maxNodeCount

integer

必需。节点池中的节点数上限。必须大于或等于 minNodeCount,且小于或等于 50。

状态

节点池的生命周期状态。

枚举
STATE_UNSPECIFIED 未设置。
PROVISIONING “PROVISIONING”状态表示正在创建节点池。
RUNNING “RUNNING”状态表示节点池已创建并且完全可用。
RECONCILING “RECONCILING”状态表示节点池正在协调。
STOPPING “STOPPING”状态表示节点池正在被删除。
ERROR “ERROR”状态表示节点池处于不可恢复的损坏状态。
DEGRADED “DEGRADED”状态表示节点池需要用户执行操作才能恢复全部功能。

AzureNodePoolError

AzureNodePoolError 描述在 Azure 节点池上发现的错误。

JSON 表示法
{
  "message": string
}
字段
message

string

直观易懂的错误说明。

AzureNodeManagement

AzureNodeManagement 定义了为 Azure 节点池启用的一组节点管理功能。

JSON 表示法
{
  "autoRepair": boolean
}
字段
autoRepair

boolean

可选。指定是否自动修复节点。如果设置为 true,此节点池中的节点将受到监控,并且如果这些节点在一段时间内始终未通过健康检查,则会触发自动修复操作,将其替换为新节点。

方法

create

创建附加到给定 AzureCluster 的新 AzureNodePool

delete

删除特定的 AzureNodePool 资源。

get

描述特定的 AzureNodePool 资源。

list

列出给定 AzureCluster 中的所有 AzureNodePool 资源。

patch

更新 AzureNodePool