google_container_api::UpgradeSettings Class Reference

#include <upgrade_settings.h>

Inheritance diagram for google_container_api::UpgradeSettings:

Public Member Functions
	UpgradeSettings (const Json::Value &storage)
	UpgradeSettings (Json::Value *storage)
virtual	~UpgradeSettings ()
const StringPiece	GetTypeName () const
bool	has_max_surge () const
void	clear_max_surge ()
int32	get_max_surge () const
void	set_max_surge (int32 value)
bool	has_max_unavailable () const
void	clear_max_unavailable ()
int32	get_max_unavailable () const
void	set_max_unavailable (int32 value)

Static Public Member Functions
static UpgradeSettings *	New ()

Detailed Description

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.

Constructor & Destructor Documentation

UpgradeSettings() [1/2]

google_container_api::UpgradeSettings::UpgradeSettings ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

UpgradeSettings() [2/2]

google_container_api::UpgradeSettings::UpgradeSettings ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~UpgradeSettings()

google_container_api::UpgradeSettings::~UpgradeSettings ( )

virtual

Standard destructor.

Member Function Documentation

clear_max_surge()

void google_container_api::UpgradeSettings::clear_max_surge ( )

inline

Clears the 'maxSurge' attribute.

clear_max_unavailable()

void google_container_api::UpgradeSettings::clear_max_unavailable ( )

inline

Clears the 'maxUnavailable' attribute.

get_max_surge()

int32 google_container_api::UpgradeSettings::get_max_surge ( ) const

inline

Get the value of the 'maxSurge' attribute.

get_max_unavailable()

int32 google_container_api::UpgradeSettings::get_max_unavailable ( ) const

inline

Get the value of the 'maxUnavailable' attribute.

GetTypeName()

const StringPiece google_container_api::UpgradeSettings::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_container_api::UpgradeSettings

has_max_surge()

bool google_container_api::UpgradeSettings::has_max_surge ( ) const

inline

Determine if the 'maxSurge' attribute was set.

Returns

true if the 'maxSurge' attribute was set.

has_max_unavailable()

bool google_container_api::UpgradeSettings::has_max_unavailable ( ) const

inline

Determine if the 'maxUnavailable' attribute was set.

Returns

true if the 'maxUnavailable' attribute was set.

New()

UpgradeSettings * google_container_api::UpgradeSettings::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_max_surge()

void google_container_api::UpgradeSettings::set_max_surge ( int32  value )

inline

Change the 'maxSurge' attribute.

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

Parameters

[in]

value

The new value.

set_max_unavailable()

void google_container_api::UpgradeSettings::set_max_unavailable ( int32  value )

inline

Change the 'maxUnavailable' attribute.

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

Parameters

[in]

value

The new value.

---

The documentation for this class was generated from the following files:

• google/container_api/upgrade_settings.h
• google/container_api/upgrade_settings.cc