public static final class NodePool.UpgradeSettings extends GeneratedMessageV3 implements NodePool.UpgradeSettingsOrBuilder
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.
Protobuf type google.container.v1.NodePool.UpgradeSettings
Static Fields
BLUE_GREEN_SETTINGS_FIELD_NUMBER
public static final int BLUE_GREEN_SETTINGS_FIELD_NUMBER
Field Value
MAX_SURGE_FIELD_NUMBER
public static final int MAX_SURGE_FIELD_NUMBER
Field Value
MAX_UNAVAILABLE_FIELD_NUMBER
public static final int MAX_UNAVAILABLE_FIELD_NUMBER
Field Value
STRATEGY_FIELD_NUMBER
public static final int STRATEGY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static NodePool.UpgradeSettings getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static NodePool.UpgradeSettings.Builder newBuilder()
Returns
newBuilder(NodePool.UpgradeSettings prototype)
public static NodePool.UpgradeSettings.Builder newBuilder(NodePool.UpgradeSettings prototype)
Parameter
Returns
public static NodePool.UpgradeSettings parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static NodePool.UpgradeSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static NodePool.UpgradeSettings parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NodePool.UpgradeSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static NodePool.UpgradeSettings parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NodePool.UpgradeSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static NodePool.UpgradeSettings parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static NodePool.UpgradeSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static NodePool.UpgradeSettings parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static NodePool.UpgradeSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static NodePool.UpgradeSettings parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static NodePool.UpgradeSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<NodePool.UpgradeSettings> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getBlueGreenSettings()
public BlueGreenSettings getBlueGreenSettings()
Settings for blue-green upgrade strategy.
optional .google.container.v1.BlueGreenSettings blue_green_settings = 4;
getBlueGreenSettingsOrBuilder()
public BlueGreenSettingsOrBuilder getBlueGreenSettingsOrBuilder()
Settings for blue-green upgrade strategy.
optional .google.container.v1.BlueGreenSettings blue_green_settings = 4;
getDefaultInstanceForType()
public NodePool.UpgradeSettings getDefaultInstanceForType()
Returns
getMaxSurge()
The maximum number of nodes that can be created beyond the current size
of the node pool during the upgrade process.
int32 max_surge = 1;
| Type | Description |
int | The maxSurge.
|
getMaxUnavailable()
public int 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.
int32 max_unavailable = 2;
| Type | Description |
int | The maxUnavailable.
|
getParserForType()
public Parser<NodePool.UpgradeSettings> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getStrategy()
public NodePoolUpdateStrategy getStrategy()
Update strategy of the node pool.
optional .google.container.v1.NodePoolUpdateStrategy strategy = 3;
getStrategyValue()
public int getStrategyValue()
Update strategy of the node pool.
optional .google.container.v1.NodePoolUpdateStrategy strategy = 3;
| Type | Description |
int | The enum numeric value on the wire for strategy.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasBlueGreenSettings()
public boolean hasBlueGreenSettings()
Settings for blue-green upgrade strategy.
optional .google.container.v1.BlueGreenSettings blue_green_settings = 4;
| Type | Description |
boolean | Whether the blueGreenSettings field is set.
|
hasStrategy()
public boolean hasStrategy()
Update strategy of the node pool.
optional .google.container.v1.NodePoolUpdateStrategy strategy = 3;
| Type | Description |
boolean | Whether the strategy field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public NodePool.UpgradeSettings.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected NodePool.UpgradeSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public NodePool.UpgradeSettings.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
