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.

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.
Was this page helpful? Let us know how we did:

Send feedback about...

Kubernetes Engine