Struct ClusterTopologyControlPlane

pub struct ClusterTopologyControlPlane {
    pub machine_health_check: Option<ClusterTopologyControlPlaneMachineHealthCheck>,
    pub metadata: Option<ClusterTopologyControlPlaneMetadata>,
    pub node_deletion_timeout: Option<String>,
    pub node_drain_timeout: Option<String>,
    pub node_volume_detach_timeout: Option<String>,
    pub readiness_gates: Option<Vec<ClusterTopologyControlPlaneReadinessGates>>,
    pub replicas: Option<i32>,
    pub variables: Option<ClusterTopologyControlPlaneVariables>,
}

controlPlane describes the cluster control plane.

Fields

machine_health_check: Option<ClusterTopologyControlPlaneMachineHealthCheck>

machineHealthCheck allows to enable, disable and override the MachineHealthCheck configuration in the ClusterClass for this control plane.

metadata: Option<ClusterTopologyControlPlaneMetadata>

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

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.

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

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.

readiness_gates: Option<Vec<ClusterTopologyControlPlaneReadinessGates>>

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.

If this field is not defined, readinessGates from the corresponding ControlPlaneClass will be used, if any.

NOTE: This field is considered only for computing v1beta2 conditions. 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.

replicas: Option<i32>

replicas is the number of control plane nodes. If the value is nil, the ControlPlane object is created without the number of Replicas and it’s assumed that the control plane controller does not implement support for this field. When specified against a control plane provider that lacks support for this field, this value will be ignored.

variables: Option<ClusterTopologyControlPlaneVariables>

variables can be used to customize the ControlPlane through patches.

Trait Implementations

impl Clone for ClusterTopologyControlPlane

fn clone(&self) -> ClusterTopologyControlPlane

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClusterTopologyControlPlane

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

Formats the value using the given formatter.

impl Default for ClusterTopologyControlPlane

fn default() -> ClusterTopologyControlPlane

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClusterTopologyControlPlane

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ClusterTopologyControlPlane

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 ClusterTopologyControlPlane

fn eq(&self, other: &ClusterTopologyControlPlane) -> 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 ClusterTopologyControlPlane

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 ClusterTopologyControlPlane