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": integer,
  "locations": [
    string
  ],
  "networkConfig": {
    object (NodeNetworkConfig)
  },
  "selfLink": string,
  "version": string,
  "instanceGroupUrls": [
    string
  ],
  "status": enum (Status),
  "statusMessage": string,
  "autoscaling": {
    object (NodePoolAutoscaling)
  },
  "management": {
    object (NodeManagement)
  },
  "maxPodsConstraint": {
    object (MaxPodsConstraint)
  },
  "conditions": [
    {
      object (StatusCondition)
    }
  ],
  "podIpv4CidrSize": integer,
  "upgradeSettings": {
    object (UpgradeSettings)
  },
  "placementPolicy": {
    object (PlacementPolicy)
  },
  "updateInfo": {
    object (UpdateInfo)
  },
  "etag": string,
  "queuedProvisioning": {
    object (QueuedProvisioning)
  },
  "bestEffortProvisioning": {
    object (BestEffortProvisioning)
  },
  "autopilotConfig": {
    object (AutopilotConfig)
  }
}
Fields
name

string

The name of the node pool.
config

object (NodeConfig)

The node configuration of the pool.
initialNodeCount

integer

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.
locations[]

string

The list of Google Compute Engine zones in which the NodePool's nodes should be located.

If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead.

Warning: changing node pool locations will result in nodes being added and/or removed.
networkConfig

object (NodeNetworkConfig)

Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
version

string

The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here.
instanceGroupUrls[]

string

Output only. The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
status

enum (Status)

Output only. The status of the nodes in this pool instance.
statusMessage
(deprecated)

string

Output only. Deprecated. Use conditions instead. 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.
maxPodsConstraint

object (MaxPodsConstraint)

The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
conditions[]

object (StatusCondition)

Which conditions caused the current node pool state.
podIpv4CidrSize

integer

Output only. The pod CIDR block size per node in this node pool.
upgradeSettings

object (UpgradeSettings)

Upgrade settings control disruption and speed of the upgrade.
placementPolicy

object (PlacementPolicy)

Specifies the node placement policy.
updateInfo

object (UpdateInfo)

Output only. Update info contains relevant information during a node pool update.
etag

string

This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
queuedProvisioning

object (QueuedProvisioning)

Specifies the configuration of queued provisioning.
bestEffortProvisioning

object (BestEffortProvisioning)

Enable best effort provisioning for nodes
autopilotConfig

object (AutopilotConfig)

Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler.

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.

fetchNodePoolUpgradeInfo

 Fetch upgrade information of a specific nodepool.

get

 Retrieves the requested node pool.

list

 Lists the node pools for a cluster.

rollback

 Rolls back a previously Aborted or Failed NodePool upgrade.

setManagement

 Sets the NodeManagement options for a node pool.

setSize

 SetNodePoolSizeRequest sets the size of a node pool.

update

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