Reference documentation and code samples for the Google Cloud Container V1 Client class UpgradeSettings.
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.
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 controls the number of nodes that can be simultaneously
unavailable.
(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.
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.
node_pool_soak_duration is the soak time after all blue nodes are
drained. After this period, the blue pool nodes will be deleted.
Generated from protobuf message google.container.v1.NodePool.UpgradeSettings
Namespace
Google \ Cloud \ Container \ V1 \ NodePool
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ max_surge
int
The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
↳ max_unavailable
int
The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Container V1 Client - Class UpgradeSettings (2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/php/docs/reference/cloud-container/latest/V1.NodePool.UpgradeSettings)\n- [2.4.0](/php/docs/reference/cloud-container/2.4.0/V1.NodePool.UpgradeSettings)\n- [2.3.4](/php/docs/reference/cloud-container/2.3.4/V1.NodePool.UpgradeSettings)\n- [2.2.1](/php/docs/reference/cloud-container/2.2.1/V1.NodePool.UpgradeSettings)\n- [2.1.0](/php/docs/reference/cloud-container/2.1.0/V1.NodePool.UpgradeSettings)\n- [2.0.0](/php/docs/reference/cloud-container/2.0.0/V1.NodePool.UpgradeSettings)\n- [1.33.0](/php/docs/reference/cloud-container/1.33.0/V1.NodePool.UpgradeSettings)\n- [1.32.0](/php/docs/reference/cloud-container/1.32.0/V1.NodePool.UpgradeSettings)\n- [1.31.0](/php/docs/reference/cloud-container/1.31.0/V1.NodePool.UpgradeSettings)\n- [1.30.3](/php/docs/reference/cloud-container/1.30.3/V1.NodePool.UpgradeSettings)\n- [1.24.0](/php/docs/reference/cloud-container/1.24.0/V1.NodePool.UpgradeSettings)\n- [1.23.0](/php/docs/reference/cloud-container/1.23.0/V1.NodePool.UpgradeSettings)\n- [1.22.0](/php/docs/reference/cloud-container/1.22.0/V1.NodePool.UpgradeSettings)\n- [1.21.1](/php/docs/reference/cloud-container/1.21.1/V1.NodePool.UpgradeSettings)\n- [1.20.0](/php/docs/reference/cloud-container/1.20.0/V1.NodePool.UpgradeSettings)\n- [1.19.0](/php/docs/reference/cloud-container/1.19.0/V1.NodePool.UpgradeSettings)\n- [1.18.0](/php/docs/reference/cloud-container/1.18.0/V1.NodePool.UpgradeSettings)\n- [1.17.1](/php/docs/reference/cloud-container/1.17.1/V1.NodePool.UpgradeSettings)\n- [1.16.0](/php/docs/reference/cloud-container/1.16.0/V1.NodePool.UpgradeSettings)\n- [1.15.0](/php/docs/reference/cloud-container/1.15.0/V1.NodePool.UpgradeSettings)\n- [1.14.0](/php/docs/reference/cloud-container/1.14.0/V1.NodePool.UpgradeSettings)\n- [1.13.1](/php/docs/reference/cloud-container/1.13.1/V1.NodePool.UpgradeSettings)\n- [1.12.1](/php/docs/reference/cloud-container/1.12.1/V1.NodePool.UpgradeSettings)\n- [1.10.3](/php/docs/reference/cloud-container/1.10.3/V1.NodePool.UpgradeSettings)\n- [1.9.1](/php/docs/reference/cloud-container/1.9.1/V1.NodePool.UpgradeSettings) \nReference documentation and code samples for the Google Cloud Container V1 Client class UpgradeSettings.\n\nThese upgrade settings control the level of parallelism and the level of\ndisruption caused by an upgrade.\n\nmaxUnavailable controls the number of nodes that can be simultaneously\nunavailable.\nmaxSurge controls the number of additional nodes that can be added to the\nnode pool temporarily for the time of the upgrade to increase the number of\navailable nodes.\n(maxUnavailable + maxSurge) determines the level of parallelism (how many\nnodes are being upgraded at the same time).\nNote: upgrades inevitably introduce some disruption since workloads need to\nbe moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,\nthis holds true. (Disruption stays within the limits of\nPodDisruptionBudget, if it is configured.)\nConsider a hypothetical node pool with 5 nodes having maxSurge=2,\nmaxUnavailable=1. This means the upgrade process upgrades 3 nodes\nsimultaneously. It creates 2 additional (upgraded) nodes, then it brings\ndown 3 old (not yet upgraded) nodes at the same time. This ensures that\nthere are always at least 4 nodes available.\nThese upgrade settings configure the upgrade strategy for the node pool.\nUse strategy to switch between the strategies applied to the node pool.\nIf the strategy is ROLLING, use max_surge and max_unavailable to control\nthe level of parallelism and the level of disruption caused by upgrade.\n\n1. 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.\n2. maxUnavailable controls the number of nodes that can be simultaneously unavailable.\n3. (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.\n4. 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.\n5. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted.\n\nGenerated from protobuf message `google.container.v1.NodePool.UpgradeSettings`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Container \\\\ V1 \\\\ NodePool\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMaxSurge\n\nThe maximum number of nodes that can be created beyond the current size\nof the node pool during the upgrade process.\n\n### setMaxSurge\n\nThe maximum number of nodes that can be created beyond the current size\nof the node pool during the upgrade process.\n\n### getMaxUnavailable\n\nThe maximum number of nodes that can be simultaneously unavailable during\nthe upgrade process. A node is considered available if its status is\nReady.\n\n### setMaxUnavailable\n\nThe maximum number of nodes that can be simultaneously unavailable during\nthe upgrade process. A node is considered available if its status is\nReady.\n\n### getStrategy\n\nUpdate strategy of the node pool.\n\n### hasStrategy\n\n### clearStrategy\n\n### setStrategy\n\nUpdate strategy of the node pool.\n\n### getBlueGreenSettings\n\nSettings for blue-green upgrade strategy.\n\n### hasBlueGreenSettings\n\n### clearBlueGreenSettings\n\n### setBlueGreenSettings\n\nSettings for blue-green upgrade strategy."]]
