REST Resource: projects.locations.clusters.nodePools

Resource: NodePool
Methods

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

JSON representation
{ "name": string, "config": { object (`NodeConfig`) }, "initialNodeCount": integer, "locations": [ string ], "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`) } }

{
  "name": string,
  "config": {
    object (NodeConfig)
  },
  "initialNodeCount": integer,
  "locations": [
    string
  ],
  "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)
  }
}

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.
`selfLink`	`string` [Output only] Server-defined URL for the resource.
`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 (deprecated)`	`string` This item is deprecated! [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.

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": integer, "maxNodeCount": integer, "autoprovisioned": boolean }

Fields
`enabled`	`boolean` Is autoscaling enabled for this node pool.
`minNodeCount`	`integer` Minimum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount.
`maxNodeCount`	`integer` Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster.
`autoprovisioned`	`boolean` Can this node pool be deleted automatically.

Methods
`create`	Creates a node pool for a cluster.
`delete`	Deletes a node pool from a cluster.
`get`	Retrieves the requested node pool.
`list`	Lists the node pools for a cluster.
`rollback`	Rolls back a previously Aborted or Failed NodePool upgrade.
`setAutoscaling`	Sets the autoscaling settings for the specified node pool.
`setManagement`	Sets the NodeManagement options for a node pool.
`setSize`	Sets the size for a specific node pool.
`update`	Updates the version and/or image type for the specified node pool.

REST Resource: projects.locations.clusters.nodePools

Resource: NodePool

Status

NodePoolAutoscaling

Methods

`create`

`delete`

`get`

`list`

`rollback`

`setAutoscaling`

`setManagement`

`setSize`

`update`