Class 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.

Attributes
NameDescription
strname
The name of the node pool.
google.cloud.container_v1.types.NodeConfigconfig
The node configuration of the pool.
intinitial_node_count
The initial node count for the pool. You must ensure that your Compute Engine `resource quota
Sequence[str]locations
The list of Google Compute Engine `zones
strself_link
[Output only] Server-defined URL for the resource.
strversion
The version of the Kubernetes of this node.
Sequence[str]instance_group_urls
[Output only] The resource URLs of the `managed instance groups
google.cloud.container_v1.types.NodePool.Statusstatus
[Output only] The status of the nodes in this pool instance.
strstatus_message
[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
google.cloud.container_v1.types.NodePoolAutoscalingautoscaling
Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
google.cloud.container_v1.types.NodeManagementmanagement
NodeManagement configuration for this NodePool.
google.cloud.container_v1.types.MaxPodsConstraintmax_pods_constraint
The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
Sequence[google.cloud.container_v1.types.StatusCondition]conditions
Which conditions caused the current node pool state.
intpod_ipv4_cidr_size
[Output only] The pod CIDR block size per node in this node pool.
google.cloud.container_v1.types.NodePool.UpgradeSettingsupgrade_settings
Upgrade settings control disruption and speed of the upgrade.

Inheritance

builtins.object > proto.message.Message > NodePool

Classes

Status

Status(value)

The current status of the node pool instance.

UpgradeSettings

UpgradeSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.