nebius.api.nebius.mk8s.v1.ControlPlaneSpec

class documentation

class ControlPlaneSpec(Message): (source)

Constructor: ControlPlaneSpec(initial_message, version, subnet_id, endpoints, ...)

View In Hierarchy

Undocumented

Method __init__ Create a message from a source message and field values.
Method audit_logs.setter Set or clear the generated audit_logs field.
Method endpoints.setter Set or clear the generated endpoints field.
Method etcd_cluster_size.setter Set or clear the generated etcd_cluster_size field.
Method karpenter.setter Set or clear the generated karpenter field.
Method subnet_id.setter Set or clear the generated subnet_id field.
Method version.setter Set or clear the generated version 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 audit_logs Specify configuration of the pushing k8s audit logs into service logs and show it in the UI. By default cluster will be created without it.
Property endpoints Specification of endpoints of cluster control plane.
Property etcd_cluster_size Number of instances in etcd cluster. 3 by default. Control plane with etcd_cluster_size: 3 called "Highly Available" ("HA"), because it's Kubernetes API will be available despite a failure of one control plane instance.
Property karpenter Enables installation of the Karpenter inside a cluster. Karpenter will be installed as a helm chart inside cluster so it requires creation of at least one CPU public node group.
Property subnet_id Nebius VPC Subnet ID where control plane instances will be located. Also will be default NodeGroup subnet.
Property version Desired Kubernetes version of the cluster. May be lower than the actual cluster version if the desired version is no longer supported and the cluster has been automatically updated. For now only acceptable format is ...

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, *, version: str | None | UnsetType = _NEBIUS_UNSET, subnet_id: str | None | UnsetType = _NEBIUS_UNSET, endpoints: ControlPlaneEndpointsSpec | None | UnsetType = _NEBIUS_UNSET, etcd_cluster_size: int | None | UnsetType = _NEBIUS_UNSET, audit_logs: AuditLogsSpec | None | UnsetType = _NEBIUS_UNSET, karpenter: Karpenter | None | UnsetType = _NEBIUS_UNSET): (source)
overrides nebius.base.protos.direct.Message.__init__

Create a message from a source message and field values.

@audit_logs.setter
def audit_logs(self, value: AuditLogsSpec | None): (source)

Set or clear the generated audit_logs field.

@endpoints.setter
def endpoints(self, value: ControlPlaneEndpointsSpec | None): (source)

Set or clear the generated endpoints field.

@etcd_cluster_size.setter
def etcd_cluster_size(self, value: int | None): (source)

Set or clear the generated etcd_cluster_size field.

@karpenter.setter
def karpenter(self, value: Karpenter | None): (source)

Set or clear the generated karpenter field.

@subnet_id.setter
def subnet_id(self, value: str | None): (source)

Set or clear the generated subnet_id field.

@version.setter
def version(self, value: str | None): (source)

Set or clear the generated version 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.ControlPlaneSpec')
__PROTO_FULL_NAME__: str = (source)
overrides nebius.base.protos.direct.Message.__PROTO_FULL_NAME__

Fully qualified protobuf message name.

Value
'nebius.mk8s.v1.ControlPlaneSpec'
__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
{'version': 'version',
 'subnet_id': 'subnet_id',
 'endpoints': 'endpoints',
 'etcd_cluster_size': 'etcd_cluster_size',
 'audit_logs': 'audit_logs',
 'karpenter': 'karpenter'}
@_NebiusProperty
audit_logs: AuditLogsSpec = (source)

Specify configuration of the pushing k8s audit logs into service logs and show it in the UI. By default cluster will be created without it.

@_NebiusProperty
endpoints: ControlPlaneEndpointsSpec = (source)

Specification of endpoints of cluster control plane.

@_NebiusProperty
etcd_cluster_size: int = (source)

Number of instances in etcd cluster. 3 by default. Control plane with etcd_cluster_size: 3 called "Highly Available" ("HA"), because it's Kubernetes API will be available despite a failure of one control plane instance.

@_NebiusProperty
karpenter: Karpenter = (source)

Enables installation of the Karpenter inside a cluster. Karpenter will be installed as a helm chart inside cluster so it requires creation of at least one CPU public node group.

Please note that there is no feature parity between Karpenter node pools and public node groups. By default cluster will be created without it.

@_NebiusProperty
subnet_id: str = (source)

Nebius VPC Subnet ID where control plane instances will be located. Also will be default NodeGroup subnet.

@_NebiusProperty
version: str = (source)

Desired Kubernetes version of the cluster. May be lower than the actual cluster version if the desired version is no longer supported and the cluster has been automatically updated. For now only acceptable format is <major>.<minor> like "1.31". Option for patch version update will be added later.