nebius.api.nebius.mk8s.v1.NodeGroupDeploymentStrategy

class documentation

class NodeGroupDeploymentStrategy(Message): (source)

Constructor: NodeGroupDeploymentStrategy(initial_message, max_unavailable, max_surge, drain_timeout)

View In Hierarchy

Undocumented

Method __init__ Create a message from a source message and field values.
Method drain_timeout.setter Set or clear the generated drain_timeout field.
Method max_surge.setter Set or clear the generated max_surge field.
Method max_unavailable.setter Set or clear the generated max_unavailable field.
Constant __PROTO_DESCRIPTOR__ Protobuf message descriptor from the registry.
Constant __PROTO_FULL_NAME__ Fully qualified protobuf message name.
Constant __PY_TO_PB2__ Mapping from Python member names to protobuf names.
Property drain_timeout Maximum amount of time that the service will spend attempting to gracefully drain a node (evicting its pods) before falling back to pod deletion. A value of 0 means no timeout: the node can be drained for an unlimited time...
Property max_surge The maximum number of additional nodes that can be provisioned above the desired number of nodes during the update process.
Property max_unavailable The maximum number of nodes that can be simultaneously unavailable during the update process.

Inherited from Message:

Class Method from_json Create a message from protobuf JSON mapping.
Class Method FromString Create a message by parsing protobuf wire-format bytes.
Class Method get_descriptor Return the message descriptor from the registry.
Class Method is_credentials Return True if a Python field contains credentials.
Class Method is_sensitive Return True if a Python field has the sensitive annotation.
Method __dir__ List generated fields, oneofs, and nested declarations.
Method __repr__ Render non-default fields without disclosing annotated secrets.
Method ByteSize Return the serialized protobuf wire size in bytes.
Method check_presence Check presence using a generated Python field name.
Method Clear Clear all fields, extensions, unknown fields, and the reset mask.
Method clear_extension Clear an extension value.
Method ClearField Clear a protobuf field or oneof and record it in the reset mask.
Method CopyFrom Replace this message with an independent copy of another message.
Method FindInitializationErrors Return paths of missing required fields.
Method get_extension Return an extension value.
Method get_full_update_reset_mask Create a reset mask from the current protobuf state.
Method get_mask Return the reset mask for field changes.
Method has_extension Return True if an extension has explicit presence.
Method HasField Return True if a protobuf field or oneof has explicit presence.
Method is_default Return True if a generated field has its default value.
Method IsInitialized Return True if every required field is initialized.
Method MergeFrom Merge fields from another message of the same generated type.
Method MergeFromString Merge protobuf wire-format bytes into this message.
Method ParseFromString Parse protobuf wire-format bytes and replace this message.
Method SerializeToString Serialize the message using protobuf wire format.
Method set_extension Set an extension value.
Method set_mask Set the reset mask for this message.
Method to_json Serialize this message using protobuf JSON mapping.
Method which_field_in_oneof Return the selected Python field name for a protobuf oneof.
Method WhichOneof Return the selected protobuf field name for a oneof.
Constant __EXTENSION_REGISTRY__ Registry that decodes protobuf extensions.
Constant __FIELDS__ Runtime field data that the generator creates.
Constant __MAX_NESTING_DEPTH__ Maximum protobuf nesting depth for serialization, parsing, and initialization checks.
Constant __PB2_DESCRIPTOR__ Alias for code that expects a protobuf descriptor.
Constant __REGISTRY__ Registry for the message and its descriptor.
Property Extensions Provide protobuf-compatible mapping access to extension values.
Class Method _fields_by_number Undocumented
Class Method _fields_by_proto_name Undocumented
Class Method _fields_by_python_name Undocumented
Class Method _from_string Deserialize internally without invoking generated user warnings.
Class Method _oneof_python_name Undocumented
Class Method _public_fields_by_proto_name Undocumented
Class Method _public_fields_by_python_name Undocumented
Static Method _format_map_key Undocumented
Static Method _repr_field Undocumented
Method _bind_child Undocumented
Method _bind_mutation Undocumented
Method _check_same_type Undocumented
Method _child_changed Undocumented
Method _clear_state Undocumented
Method _closed_enum_unknown Undocumented
Method _converted_view Undocumented
Method _decode_map_entry Undocumented
Method _detach_child Undocumented
Method _field_has_value Undocumented
Method _field_is_default Undocumented
Method _find_initialization_errors Undocumented
Method _get_field Undocumented
Method _map Undocumented
Method _merge_from_string Undocumented
Method _nesting_limit Undocumented
Method _notify Undocumented
Method _record_reset Undocumented
Method _repeated Undocumented
Method _select Undocumented
Method _serialize_to_string Undocumented
Method _set_field Undocumented
Method _suspend_mutation Undocumented
Method _suspend_reset_mask Undocumented
Method _try_decode_field Undocumented
Method _write_field Undocumented
Instance Variable _extensions Undocumented
Instance Variable _mutation_suspended Undocumented
Instance Variable _on_mutation Undocumented
Instance Variable _oneofs Undocumented
Instance Variable _present Undocumented
Instance Variable _reset_mask Undocumented
Instance Variable _reset_mask_suspended Undocumented
Instance Variable _unknown_fields Undocumented
Instance Variable _values Undocumented
Instance Variable _views Undocumented
def __init__(self, initial_message: SerializableMessage | None = None, *, max_unavailable: PercentOrCount | None | UnsetType = _NEBIUS_UNSET, max_surge: PercentOrCount | None | UnsetType = _NEBIUS_UNSET, drain_timeout: timedelta | Duration | None | UnsetType = _NEBIUS_UNSET): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

@drain_timeout.setter
def drain_timeout(self, value: timedelta | Duration | None): (source)

Set or clear the generated drain_timeout field.

@max_surge.setter
def max_surge(self, value: PercentOrCount | None): (source)

Set or clear the generated max_surge field.

@max_unavailable.setter
def max_unavailable(self, value: PercentOrCount | None): (source)

Set or clear the generated max_unavailable field.

__PROTO_DESCRIPTOR__ = (source)
overrides nebius.base.protos.direct.Message.__PROTO_DESCRIPTOR__

Protobuf message descriptor from the registry.

Value
REGISTRY.message_descriptor('nebius.mk8s.v1.NodeGroupDeploymentStrategy')
__PROTO_FULL_NAME__: str = (source)
overrides nebius.base.protos.direct.Message.__PROTO_FULL_NAME__

Fully qualified protobuf message name.

Value
'nebius.mk8s.v1.NodeGroupDeploymentStrategy'
__PY_TO_PB2__: dict[str, str] = (source)
overrides nebius.base.protos.direct.Message.__PY_TO_PB2__

Mapping from Python member names to protobuf names.

Value
{'max_unavailable': 'max_unavailable',
 'max_surge': 'max_surge',
 'drain_timeout': 'drain_timeout'}
@_NebiusProperty
drain_timeout: timedelta | None = (source)

Maximum amount of time that the service will spend attempting to gracefully drain a node (evicting its pods) before falling back to pod deletion. A value of 0 means no timeout: the node can be drained for an unlimited time. Important consequence of that is if PodDisruptionBudget doesn't allow evicting a pod, then NodeGroup update with node re-creation will hang on that pod eviction. Note that this is different from kubectl drain --timeout, which gives up and returns an error.

On 2026-08-01, defaults to 0. IMPORTANT: starting from Q3 2026 new default is 10m; for new clusters it will default to 10m, node groups in existing clusters will be gradually migrated during Q3 to the default of 10m as well. To get the actual value for your node group, please see 'strategy' in its status.

@_NebiusProperty
max_surge: PercentOrCount = (source)

The maximum number of additional nodes that can be provisioned above the desired number of nodes during the update process.

This value can be specified either as an absolute number (for example 3) or as a percentage of the desired number of nodes (for example 5%).

When specified as a percentage, the actual number is calculated by rounding up to the nearest whole number. This value cannot be 0 if max_unavailable is also set to 0.

On 2026-08-01, defaults to 1. IMPORTANT: starting from Q3 2026 new default is 0; for new clusters it will default to 0, node groups in existing clusters will be gradually migrated during Q3 to the default of 0 as well. To get the actual value for your node group, please see 'strategy' in its status.

Example: If set to 25%, the node group can scale up by an additional 25% during the update, allowing new nodes to be added before old nodes are removed, which helps minimize workload disruption.

NOTE:

it is user responsibility to ensure that there are enough quota for provision nodes above the desired number. Available quota effectively limits max_surge. In case of not enough quota even for one extra node, update operation will hung because of quota exhausted error. Such error will be visible in Operation.progress_data.

@_NebiusProperty
max_unavailable: PercentOrCount = (source)

The maximum number of nodes that can be simultaneously unavailable during the update process.

This value can be specified either as an absolute number (for example 3) or as a percentage of the desired number of nodes (for example 5%).

When specified as a percentage, the actual number is calculated by rounding down to the nearest whole number. This value cannot be 0 if max_surge is also set to 0.

On 2026-08-01, defaults to 0. IMPORTANT: starting from Q3 2026 new default is 1; for new clusters it will default to 1, node groups in existing clusters will be gradually migrated during Q3 to the default of 1 as well. To get the actual value for your node group, please see 'strategy' in its status.

Example: If set to 20%, up to 20% of the nodes can be taken offline at once during the update, ensuring that at least 80% of the desired nodes remain operational.