Class NodePool.UpgradeSettings (2.5.2)

Stay organized with collections Save and categorize content based on your preferences.
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.

  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.
  4. 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.
  5. 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
TypeDescription
int

MAX_SURGE_FIELD_NUMBER

public static final int MAX_SURGE_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_UNAVAILABLE_FIELD_NUMBER

public static final int MAX_UNAVAILABLE_FIELD_NUMBER
Field Value
TypeDescription
int

STRATEGY_FIELD_NUMBER

public static final int STRATEGY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static NodePool.UpgradeSettings getDefaultInstance()
Returns
TypeDescription
NodePool.UpgradeSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static NodePool.UpgradeSettings.Builder newBuilder()
Returns
TypeDescription
NodePool.UpgradeSettings.Builder

newBuilder(NodePool.UpgradeSettings prototype)

public static NodePool.UpgradeSettings.Builder newBuilder(NodePool.UpgradeSettings prototype)
Parameter
NameDescription
prototypeNodePool.UpgradeSettings
Returns
TypeDescription
NodePool.UpgradeSettings.Builder

parseDelimitedFrom(InputStream input)

public static NodePool.UpgradeSettings parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NodePool.UpgradeSettings
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NodePool.UpgradeSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NodePool.UpgradeSettings
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static NodePool.UpgradeSettings parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
NodePool.UpgradeSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static NodePool.UpgradeSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NodePool.UpgradeSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static NodePool.UpgradeSettings parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
NodePool.UpgradeSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static NodePool.UpgradeSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NodePool.UpgradeSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static NodePool.UpgradeSettings parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
NodePool.UpgradeSettings
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static NodePool.UpgradeSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NodePool.UpgradeSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static NodePool.UpgradeSettings parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NodePool.UpgradeSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NodePool.UpgradeSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NodePool.UpgradeSettings
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static NodePool.UpgradeSettings parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
NodePool.UpgradeSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static NodePool.UpgradeSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NodePool.UpgradeSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<NodePool.UpgradeSettings> parser()
Returns
TypeDescription
Parser<UpgradeSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBlueGreenSettings()

public BlueGreenSettings getBlueGreenSettings()

Settings for blue-green upgrade strategy.

optional .google.container.v1.BlueGreenSettings blue_green_settings = 4;

Returns
TypeDescription
BlueGreenSettings

The blueGreenSettings.

getBlueGreenSettingsOrBuilder()

public BlueGreenSettingsOrBuilder getBlueGreenSettingsOrBuilder()

Settings for blue-green upgrade strategy.

optional .google.container.v1.BlueGreenSettings blue_green_settings = 4;

Returns
TypeDescription
BlueGreenSettingsOrBuilder

getDefaultInstanceForType()

public NodePool.UpgradeSettings getDefaultInstanceForType()
Returns
TypeDescription
NodePool.UpgradeSettings

getMaxSurge()

public int 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;

Returns
TypeDescription
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;

Returns
TypeDescription
int

The maxUnavailable.

getParserForType()

public Parser<NodePool.UpgradeSettings> getParserForType()
Returns
TypeDescription
Parser<UpgradeSettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStrategy()

public NodePoolUpdateStrategy getStrategy()

Update strategy of the node pool.

optional .google.container.v1.NodePoolUpdateStrategy strategy = 3;

Returns
TypeDescription
NodePoolUpdateStrategy

The strategy.

getStrategyValue()

public int getStrategyValue()

Update strategy of the node pool.

optional .google.container.v1.NodePoolUpdateStrategy strategy = 3;

Returns
TypeDescription
int

The enum numeric value on the wire for strategy.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasBlueGreenSettings()

public boolean hasBlueGreenSettings()

Settings for blue-green upgrade strategy.

optional .google.container.v1.BlueGreenSettings blue_green_settings = 4;

Returns
TypeDescription
boolean

Whether the blueGreenSettings field is set.

hasStrategy()

public boolean hasStrategy()

Update strategy of the node pool.

optional .google.container.v1.NodePoolUpdateStrategy strategy = 3;

Returns
TypeDescription
boolean

Whether the strategy field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public NodePool.UpgradeSettings.Builder newBuilderForType()
Returns
TypeDescription
NodePool.UpgradeSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NodePool.UpgradeSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
NodePool.UpgradeSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public NodePool.UpgradeSettings.Builder toBuilder()
Returns
TypeDescription
NodePool.UpgradeSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException