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
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. |
↳ strategy |
int
Update strategy of the node pool. |
↳ blue_green_settings |
Google\Cloud\Container\V1\BlueGreenSettings
Settings for blue-green upgrade strategy. |
getMaxSurge
The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
Generated from protobuf field int32 max_surge = 1;
| Returns | |
|---|---|
| Type | Description |
int | |
setMaxSurge
The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
Generated from protobuf field int32 max_surge = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaxUnavailable
The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
Generated from protobuf field int32 max_unavailable = 2;
| Returns | |
|---|---|
| Type | Description |
int | |
setMaxUnavailable
The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
Generated from protobuf field int32 max_unavailable = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStrategy
Update strategy of the node pool.
Generated from protobuf field optional .google.container.v1.NodePoolUpdateStrategy strategy = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
hasStrategy
clearStrategy
setStrategy
Update strategy of the node pool.
Generated from protobuf field optional .google.container.v1.NodePoolUpdateStrategy strategy = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBlueGreenSettings
Settings for blue-green upgrade strategy.
Generated from protobuf field optional .google.container.v1.BlueGreenSettings blue_green_settings = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\BlueGreenSettings|null | |
hasBlueGreenSettings
clearBlueGreenSettings
setBlueGreenSettings
Settings for blue-green upgrade strategy.
Generated from protobuf field optional .google.container.v1.BlueGreenSettings blue_green_settings = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\BlueGreenSettings
|
| Returns | |
|---|---|
| Type | Description |
$this | |