Class: Google::Apis::ContainerV1::UpgradeSettings

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/container_v1/classes.rb,
lib/google/apis/container_v1/representations.rb,
lib/google/apis/container_v1/representations.rb

Overview

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. 1. 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. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UpgradeSettings

Returns a new instance of UpgradeSettings.



6882
6883
6884
 
# File 'lib/google/apis/container_v1/classes.rb', line 6882

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#blue_green_settings ⇒ Google::Apis::ContainerV1::BlueGreenSettings

Settings for blue-green upgrade. Corresponds to the JSON property blueGreenSettings

Returns:



6863
6864
6865
 
# File 'lib/google/apis/container_v1/classes.rb', line 6863

def blue_green_settings
  @blue_green_settings
end

#max_surge ⇒ Fixnum

The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process. Corresponds to the JSON property maxSurge

Returns:

  • (Fixnum) 


6869
6870
6871
 
# File 'lib/google/apis/container_v1/classes.rb', line 6869

def max_surge
  @max_surge
end

#max_unavailable ⇒ Fixnum

The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. Corresponds to the JSON property maxUnavailable

Returns:

  • (Fixnum) 


6875
6876
6877
 
# File 'lib/google/apis/container_v1/classes.rb', line 6875

def max_unavailable
  @max_unavailable
end

#strategy ⇒ String

Update strategy of the node pool. Corresponds to the JSON property strategy

Returns:

  • (String) 


6880
6881
6882
 
# File 'lib/google/apis/container_v1/classes.rb', line 6880

def strategy
  @strategy
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6887
6888
6889
6890
6891
6892
 
# File 'lib/google/apis/container_v1/classes.rb', line 6887

def update!(**args)
  @blue_green_settings = args[:blue_green_settings] if args.key?(:blue_green_settings)
  @max_surge = args[:max_surge] if args.key?(:max_surge)
  @max_unavailable = args[:max_unavailable] if args.key?(:max_unavailable)
  @strategy = args[:strategy] if args.key?(:strategy)
end