public sealed class UpdateSettings : IMessage<UpdateSettings>, IEquatable<UpdateSettings>, IDeepCloneable<UpdateSettings>, IBufferMessage, IMessage
Reference documentation and code samples for the Anthos Multi-Cloud v1 API class UpdateSettings.
UpdateSettings control the level of parallelism and the level of
disruption caused during the update of a node pool.
These settings are applicable when the node pool update requires replacing
the existing node pool nodes with the updated ones.
UpdateSettings are optional. When UpdateSettings are not specified during the
node pool creation, a default is chosen based on the parent cluster's
version. For clusters with minor version 1.27 and later, a default
surge_settings configuration with max_surge = 1 and max_unavailable = 0 is
used. For clusters with older versions, node pool updates use the traditional
rolling update mechanism of updating one node at a time in a
"terminate before create" fashion and update_settings is not applicable.
Set the surge_settings parameter to use the Surge Update mechanism for
the rolling update of node pool nodes.
max_surge controls the number of additional nodes that can be created
beyond the current size of the node pool temporarily for the time of the
update to increase the number of available nodes.
max_unavailable controls the number of nodes that can be simultaneously
unavailable during the update.
(max_surge + max_unavailable) determines the level of parallelism (i.e.,
the number of nodes being updated at the same time).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eUpdateSettings\u003c/code\u003e class in the Anthos Multi-Cloud v1 API controls the parallelism and disruption level during node pool updates that involve replacing existing nodes.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of \u003ccode\u003eUpdateSettings\u003c/code\u003e is 2.8.0, with several previous versions also available for reference including versions 2.7.0 down to 2.0.0, along with version 1.0.0-beta01.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eUpdateSettings\u003c/code\u003e uses \u003ccode\u003esurge_settings\u003c/code\u003e for rolling updates, which includes parameters \u003ccode\u003emax_surge\u003c/code\u003e and \u003ccode\u003emax_unavailable\u003c/code\u003e to manage the number of additional and simultaneously unavailable nodes during updates.\u003c/p\u003e\n"],["\u003cp\u003eWhen \u003ccode\u003eUpdateSettings\u003c/code\u003e is not specified, it will use a default surge update configuration for versions 1.27 and later or a traditional one-node-at-a-time update mechanism for older versions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSurgeSettings\u003c/code\u003e property of the \u003ccode\u003eUpdateSettings\u003c/code\u003e class is optional and is used to configure settings for the surge update process.\u003c/p\u003e\n"]]],[],null,[]]
