node_pools

Overview

Name	node_pools
Type	Resource
Id	google.container.node_pools

Fields

Name	Datatype	Description
name	string	The name of the node pool.
locations	array	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.
instanceGroupUrls	array	[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.
autoscaling	object	NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.
version	string	The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here.
conditions	array	Which conditions caused the current node pool state.
upgradeSettings	object	These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted.
bestEffortProvisioning	object	Best effort provisioning.
networkConfig	object	Parameters for node pool-level network config.
statusMessage	string	[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
updateInfo	object	UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade.
podIpv4CidrSize	integer	[Output only] The pod CIDR block size per node in this node pool.
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.
selfLink	string	[Output only] Server-defined URL for the resource.
management	object	NodeManagement defines the set of node management services turned on for the node pool.
maxPodsConstraint	object	Constraints applied to pods.
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.
config	object	Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in NodeConfig. Use AutoprovisioningNodePoolDefaults instead.
placementPolicy	object	PlacementPolicy defines the placement policy used by the node pool.
status	string	[Output only] The status of the nodes in this pool instance.

Methods

Name	Accessible by	Required Params	Description
projects_locations_clusters_node_pools_get	SELECT	clustersId, locationsId, nodePoolsId, projectsId	Retrieves the requested node pool.
projects_locations_clusters_node_pools_list	SELECT	clustersId, locationsId, projectsId	Lists the node pools for a cluster.
projects_zones_clusters_node_pools_get	SELECT	clusterId, nodePoolId, projectId, zone	Retrieves the requested node pool.
projects_zones_clusters_node_pools_list	SELECT	clusterId, projectId, zone	Lists the node pools for a cluster.
projects_locations_clusters_node_pools_create	INSERT	clustersId, locationsId, projectsId	Creates a node pool for a cluster.
projects_zones_clusters_node_pools_create	INSERT	clusterId, projectId, zone	Creates a node pool for a cluster.
projects_locations_clusters_node_pools_delete	DELETE	clustersId, locationsId, nodePoolsId, projectsId	Deletes a node pool from a cluster.
projects_zones_clusters_node_pools_delete	DELETE	clusterId, nodePoolId, projectId, zone	Deletes a node pool from a cluster.
projects_locations_clusters_node_pools_complete_upgrade	EXEC	clustersId, locationsId, nodePoolsId, projectsId	CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete.
projects_locations_clusters_node_pools_rollback	EXEC	clustersId, locationsId, nodePoolsId, projectsId	Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
projects_locations_clusters_node_pools_set_autoscaling	EXEC	clustersId, locationsId, nodePoolsId, projectsId	Sets the autoscaling settings for the specified node pool.
projects_locations_clusters_node_pools_set_management	EXEC	clustersId, locationsId, nodePoolsId, projectsId	Sets the NodeManagement options for a node pool.
projects_locations_clusters_node_pools_set_size	EXEC	clustersId, locationsId, nodePoolsId, projectsId	Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.
projects_locations_clusters_node_pools_update	EXEC	clustersId, locationsId, nodePoolsId, projectsId	Updates the version and/or image type for the specified node pool.
projects_zones_clusters_node_pools_autoscaling	EXEC	clusterId, nodePoolId, projectId, zone	Sets the autoscaling settings for the specified node pool.
projects_zones_clusters_node_pools_rollback	EXEC	clusterId, nodePoolId, projectId, zone	Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
projects_zones_clusters_node_pools_set_management	EXEC	clusterId, nodePoolId, projectId, zone	Sets the NodeManagement options for a node pool.
projects_zones_clusters_node_pools_set_size	EXEC	clusterId, nodePoolId, projectId, zone	Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.
projects_zones_clusters_node_pools_update	EXEC	clusterId, nodePoolId, projectId, zone	Updates the version and/or image type for the specified node pool.