REST Resource: projects.zones.clusters.nodePools

Resource: NodePool

NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

JSON representation
{
  "name": string,
  "config": {
    object(NodeConfig)
  },
  "initialNodeCount": number,
  "selfLink": string,
  "version": string,
  "instanceGroupUrls": [
    string
  ],
  "status": enum(Status),
  "statusMessage": string,
  "autoscaling": {
    object(NodePoolAutoscaling)
  },
  "management": {
    object(NodeManagement)
  },
}
Fields
name

string

The name of the node pool.

config

object(NodeConfig)

The node configuration of the pool.

initialNodeCount

number

The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.

version

string

The version of the Kubernetes of this node.

instanceGroupUrls[]

string

[Output only] The resource URLs of the managed instance groups associated with this node pool.

status

enum(Status)

[Output only] The status of the nodes in this pool instance.

statusMessage

string

[Output only] Additional information about the current status of this node pool instance, if available.

autoscaling

object(NodePoolAutoscaling)

Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

management

object(NodeManagement)

NodeManagement configuration for this NodePool.

Status

The current status of the node pool instance.

Enums
STATUS_UNSPECIFIED Not set.
PROVISIONING The PROVISIONING state indicates the node pool is being created.
RUNNING The RUNNING state indicates the node pool has been created and is fully usable.
RUNNING_WITH_ERROR The RUNNING_WITH_ERROR state indicates the node pool has been created and is partially usable. Some error state has occurred and some functionality may be impaired. Customer may need to reissue a request or trigger a new update.
RECONCILING The RECONCILING state indicates that some work is actively being done on the node pool, such as upgrading node software. Details can be found in the statusMessage field.
STOPPING The STOPPING state indicates the node pool is being deleted.
ERROR The ERROR state indicates the node pool may be unusable. Details can be found in the statusMessage field.

NodePoolAutoscaling

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.

JSON representation
{
  "enabled": boolean,
  "minNodeCount": number,
  "maxNodeCount": number,
}
Fields
enabled

boolean

Is autoscaling enabled for this node pool.

minNodeCount

number

Minimum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount.

maxNodeCount

number

Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster.

NodeManagement

NodeManagement defines the set of node management services turned on for the node pool.

JSON representation
{
  "autoUpgrade": boolean,
  "autoRepair": boolean,
  "upgradeOptions": {
    object(AutoUpgradeOptions)
  },
}
Fields
autoUpgrade

boolean

A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

autoRepair

boolean

A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

upgradeOptions

object(AutoUpgradeOptions)

Specifies the Auto Upgrade knobs for the node pool.

AutoUpgradeOptions

AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.

JSON representation
{
  "autoUpgradeStartTime": string,
  "description": string,
}
Fields
autoUpgradeStartTime

string

[Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in RFC3339 text format.

description

string

[Output only] This field is set when upgrades are about to commence with the description of the upgrade.

Methods

autoscaling

Sets the autoscaling settings of a specific node pool.

create

Creates a node pool for a cluster.

delete

Deletes a node pool from a cluster.

get

Retrieves the node pool requested.

list

Lists the node pools for a cluster.

rollback

Roll back the previously Aborted or Failed NodePool upgrade.

setManagement

Sets the NodeManagement options for a node pool.

setSize

Sets the size of a specific node pool.

update

Updates the version and/or image type of a specific node pool.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Kubernetes Engine