Struct UpgradeSettings 

#[non_exhaustive]
pub struct UpgradeSettings {
    pub max_surge: i32,
    pub max_unavailable: i32,
    pub strategy: Option<NodePoolUpdateStrategy>,
    pub blue_green_settings: Option<BlueGreenSettings>,
    /* private fields */
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_surge: i32

The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

max_unavailable: i32

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: Option<NodePoolUpdateStrategy>

Update strategy of the node pool.

blue_green_settings: Option<BlueGreenSettings>

Settings for blue-green upgrade strategy.

Implementations

impl UpgradeSettings

pub fn new() -> Self

pub fn set_max_surge<T: Into<i32>>(self, v: T) -> Self

Sets the value of max_surge.

Example

let x = UpgradeSettings::new().set_max_surge(42);

pub fn set_max_unavailable<T: Into<i32>>(self, v: T) -> Self

Sets the value of max_unavailable.

Example

let x = UpgradeSettings::new().set_max_unavailable(42);

pub fn set_strategy<T>(self, v: T) -> Self

where T: Into<NodePoolUpdateStrategy>,

Sets the value of strategy.

Example

use google_cloud_container_v1::model::NodePoolUpdateStrategy;
let x0 = UpgradeSettings::new().set_strategy(NodePoolUpdateStrategy::BlueGreen);
let x1 = UpgradeSettings::new().set_strategy(NodePoolUpdateStrategy::Surge);

pub fn set_or_clear_strategy<T>(self, v: Option<T>) -> Self

where T: Into<NodePoolUpdateStrategy>,

Sets or clears the value of strategy.

Example

use google_cloud_container_v1::model::NodePoolUpdateStrategy;
let x0 = UpgradeSettings::new().set_or_clear_strategy(Some(NodePoolUpdateStrategy::BlueGreen));
let x1 = UpgradeSettings::new().set_or_clear_strategy(Some(NodePoolUpdateStrategy::Surge));
let x_none = UpgradeSettings::new().set_or_clear_strategy(None::<NodePoolUpdateStrategy>);

pub fn set_blue_green_settings<T>(self, v: T) -> Self

where T: Into<BlueGreenSettings>,

Sets the value of blue_green_settings.

Example

use google_cloud_container_v1::model::BlueGreenSettings;
let x = UpgradeSettings::new().set_blue_green_settings(BlueGreenSettings::default()/* use setters */);

pub fn set_or_clear_blue_green_settings<T>(self, v: Option<T>) -> Self

where T: Into<BlueGreenSettings>,

Sets or clears the value of blue_green_settings.

Example

use google_cloud_container_v1::model::BlueGreenSettings;
let x = UpgradeSettings::new().set_or_clear_blue_green_settings(Some(BlueGreenSettings::default()/* use setters */));
let x = UpgradeSettings::new().set_or_clear_blue_green_settings(None::<BlueGreenSettings>);

Trait Implementations

impl Clone for UpgradeSettings

fn clone(&self) -> UpgradeSettings

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpgradeSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UpgradeSettings

fn default() -> UpgradeSettings

Returns the “default value” for a type.

impl Message for UpgradeSettings

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UpgradeSettings

fn eq(&self, other: &UpgradeSettings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpgradeSettings