Struct ClusterClassControlPlane

pub struct ClusterClassControlPlane {
    pub machine_health_check: Option<ClusterClassControlPlaneMachineHealthCheck>,
    pub machine_infrastructure: Option<ClusterClassControlPlaneMachineInfrastructure>,
    pub metadata: Option<ClusterClassControlPlaneMetadata>,
    pub naming_strategy: Option<ClusterClassControlPlaneNamingStrategy>,
    pub node_deletion_timeout: Option<String>,
    pub node_drain_timeout: Option<String>,
    pub node_volume_detach_timeout: Option<String>,
    pub readiness_gates: Option<Vec<ClusterClassControlPlaneReadinessGates>>,
    pub ref: ObjectReference,
}

controlPlane is a reference to a local struct that holds the details for provisioning the Control Plane for the Cluster.

Fields

machine_health_check: Option<ClusterClassControlPlaneMachineHealthCheck>

machineHealthCheck defines a MachineHealthCheck for this ControlPlaneClass. This field is supported if and only if the ControlPlane provider template referenced above is Machine based and supports setting replicas.

machine_infrastructure: Option<ClusterClassControlPlaneMachineInfrastructure>

machineInfrastructure defines the metadata and infrastructure information for control plane machines.

This field is supported if and only if the control plane provider template referenced above is Machine based and supports setting replicas.

metadata: Option<ClusterClassControlPlaneMetadata>

metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane if the ControlPlaneTemplate referenced is machine based. If not, it is applied only to the ControlPlane. At runtime this metadata is merged with the corresponding metadata from the topology.

This field is supported if and only if the control plane provider template referenced is Machine based.

naming_strategy: Option<ClusterClassControlPlaneNamingStrategy>

namingStrategy allows changing the naming pattern used when creating the control plane provider object.

node_deletion_timeout: Option<String>

nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine hosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely. Defaults to 10 seconds. NOTE: This value can be overridden while defining a Cluster.Topology.

node_drain_timeout: Option<String>

nodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from kubectl drain --timeout NOTE: This value can be overridden while defining a Cluster.Topology.

node_volume_detach_timeout: Option<String>

nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes to be detached. The default value is 0, meaning that the volumes can be detached without any time limitations. NOTE: This value can be overridden while defining a Cluster.Topology.

readiness_gates: Option<Vec<ClusterClassControlPlaneReadinessGates>>

readinessGates specifies additional conditions to include when evaluating Machine Ready condition.

This field can be used e.g. to instruct the machine controller to include in the computation for Machine’s ready computation a condition, managed by an external controllers, reporting the status of special software/hardware installed on the Machine.

NOTE: This field is considered only for computing v1beta2 conditions. NOTE: If a Cluster defines a custom list of readinessGates for the control plane, such list overrides readinessGates defined in this field. NOTE: Specific control plane provider implementations might automatically extend the list of readinessGates; e.g. the kubeadm control provider adds ReadinessGates for the APIServerPodHealthy, SchedulerPodHealthy conditions, etc.

ref: ObjectReference

ref is a required reference to a custom resource offered by a provider.

Trait Implementations

impl Clone for ClusterClassControlPlane

fn clone(&self) -> ClusterClassControlPlane

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClusterClassControlPlane

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ClusterClassControlPlane

fn default() -> ClusterClassControlPlane

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClusterClassControlPlane

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ClusterClassControlPlane

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for ClusterClassControlPlane

fn eq(&self, other: &ClusterClassControlPlane) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ClusterClassControlPlane

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClusterClassControlPlane