Reference documentation and code samples for the Anthos Multi-Cloud V1 API class Google::Cloud::GkeMultiCloud::V1::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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Anthos Multi-Cloud V1 API - Class Google::Cloud::GkeMultiCloud::V1::UpdateSettings (v0.15.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.15.0 (latest)](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/latest/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.14.1](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.14.1/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.13.0](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.13.0/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.12.0](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.12.0/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.11.0](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.11.0/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.10.1](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.10.1/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.9.0](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.9.0/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.8.2](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.8.2/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.7.0](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.7.0/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.6.0](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.6.0/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.5.0](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.5.0/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.4.0](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.4.0/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.3.0](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.3.0/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.2.0](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.2.0/Google-Cloud-GkeMultiCloud-V1-UpdateSettings)\n- [0.1.0](/ruby/docs/reference/google-cloud-gke_multi_cloud-v1/0.1.0/Google-Cloud-GkeMultiCloud-V1-UpdateSettings) \nReference documentation and code samples for the Anthos Multi-Cloud V1 API class Google::Cloud::GkeMultiCloud::V1::UpdateSettings.\n\nUpdateSettings control the level of parallelism and the level of\ndisruption caused during the update of a node pool.\n\nThese settings are applicable when the node pool update requires replacing\nthe existing node pool nodes with the updated ones.\n\nUpdateSettings are optional. When UpdateSettings are not specified during the\nnode pool creation, a default is chosen based on the parent cluster's\nversion. For clusters with minor version 1.27 and later, a default\nsurge_settings configuration with max_surge = 1 and max_unavailable = 0 is\nused. For clusters with older versions, node pool updates use the traditional\nrolling update mechanism of updating one node at a time in a\n\"terminate before create\" fashion and update_settings is not applicable.\n\nSet the surge_settings parameter to use the Surge Update mechanism for\nthe rolling update of node pool nodes.\n\n1. 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.\n2. max_unavailable controls the number of nodes that can be simultaneously unavailable during the update.\n3. (max_surge + max_unavailable) determines the level of parallelism (i.e., the number of nodes being updated at the same time). \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #surge_settings\n\n def surge_settings() -\u003e ::Google::Cloud::GkeMultiCloud::V1::SurgeSettings\n\n**Returns**\n\n- ([::Google::Cloud::GkeMultiCloud::V1::SurgeSettings](./Google-Cloud-GkeMultiCloud-V1-SurgeSettings)) --- Optional. Settings for surge update.\n\n### #surge_settings=\n\n def surge_settings=(value) -\u003e ::Google::Cloud::GkeMultiCloud::V1::SurgeSettings\n\n**Parameter**\n\n- **value** ([::Google::Cloud::GkeMultiCloud::V1::SurgeSettings](./Google-Cloud-GkeMultiCloud-V1-SurgeSettings)) --- Optional. Settings for surge update. \n**Returns**\n\n- ([::Google::Cloud::GkeMultiCloud::V1::SurgeSettings](./Google-Cloud-GkeMultiCloud-V1-SurgeSettings)) --- Optional. Settings for surge update."]]