nebius.api.nebius.mk8s.v1.ControlPlaneSpec

class documentation

class ControlPlaneSpec(pb_classes.Message): (source)

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

Undocumented

Method	`__dir__`	Undocumented
Method	`__init__`	Create a wrapper around a protobuf message instance.
Method	`audit_logs.setter`	Undocumented
Method	`endpoints.setter`	Undocumented
Method	`etcd_cluster_size.setter`	Undocumented
Method	`karpenter.setter`	Undocumented
Method	`subnet_id.setter`	Undocumented
Method	`version.setter`	Undocumented
Constant	`__PB2_DESCRIPTOR__`	Undocumented
Constant	`__PY_TO_PB2__`	Undocumented
Class Variable	`__mask_functions__`	Undocumented
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. For now only acceptable format is `<major>.<minor>` like "1.31". Option for patch version update will be added later.

Inherited from Message:

Class Method	`get_descriptor`	Return the protobuf descriptor for this message class.
Class Method	`is_credentials`	Return True if the field contains credentials.
Class Method	`is_sensitive`	Return True if the field is marked as sensitive.
Method	`__repr__`	Return a human-readable representation of the message, sanitizing sensitive fields.
Method	`check_presence`	Check explicit presence for a field in the protobuf message.
Method	`get_full_update_reset_mask`	Build a reset mask for a full update of this message.
Method	`get_mask`	Return the tracked reset mask.
Method	`is_default`	Return True if a field equals its default value.
Method	`set_mask`	Replace the tracked reset mask.
Method	`which_field_in_oneof`	Return the set field name for a given oneof.
Instance Variable	`__PB2_CLASS__`	Protobuf message class associated with this wrapper.
Instance Variable	`__pb2_message__`	Underlying protobuf message instance.
Method	`_clear_field`	Clear a field and record it in the reset mask.
Method	`_get_field`	Return a field value with optional wrapping and presence handling.
Method	`_set_field`	Set a field value and update the reset mask.
Class Variable	`__credentials_fields`	Undocumented
Class Variable	`__default`	Undocumented
Class Variable	`__sensitive_fields`	Undocumented
Instance Variable	`__recorded_reset_mask`	Mask tracking fields cleared or set to default.

def __dir__(self) -> abc.Iterable[builtins.str]: (source) ¶

Undocumented

overrides nebius.base.protos.pb_classes.Message.__init__

Create a wrapper around a protobuf message instance.

Raises
`AttributeError`	If the wrapper is missing required class metadata.

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

__PB2_DESCRIPTOR__ = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__PB2_DESCRIPTOR__

Undocumented

Value

descriptor.DescriptorWrap[descriptor_1.Descriptor]('.nebius.mk8s.v1.ControlPlane↵
Spec',
                                                   cluster_pb2.DESCRIPTOR,
                                                   descriptor_1.Descriptor)

__PY_TO_PB2__: builtins.dict[builtins.str, builtins.str] = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__PY_TO_PB2__

Undocumented

Value

{'version': 'version',
 'subnet_id': 'subnet_id',
 'endpoints': 'endpoints',
 'etcd_cluster_size': 'etcd_cluster_size',
 'audit_logs': 'audit_logs',
 'karpenter': 'karpenter'}

__mask_functions__: dict = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__mask_functions__

Undocumented

@builtins.property
audit_logs: AuditLogsSpec | None = (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.

@builtins.property
endpoints: ControlPlaneEndpointsSpec = (source) ¶

Specification of endpoints of cluster control plane.

@builtins.property
etcd_cluster_size: builtins.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.

@builtins.property
karpenter: Karpenter | None = (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.

@builtins.property
subnet_id: builtins.str = (source) ¶

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

@builtins.property
version: builtins.str = (source) ¶

Desired Kubernetes version of the cluster. For now only acceptable format is <major>.<minor> like "1.31". Option for patch version update will be added later.