Struct ClusterTopologyControlPlaneHealthCheck 

pub struct ClusterTopologyControlPlaneHealthCheck {
    pub checks: Option<ClusterTopologyControlPlaneHealthCheckChecks>,
    pub enabled: Option<bool>,
    pub remediation: Option<ClusterTopologyControlPlaneHealthCheckRemediation>,
}

healthCheck allows to enable, disable and override control plane health check configuration from the ClusterClass for this control plane.

Fields

checks: Option<ClusterTopologyControlPlaneHealthCheckChecks>

checks are the checks that are used to evaluate if a Machine is healthy.

If one of checks and remediation fields are set, the system assumes that an healthCheck override is defined, and as a consequence the checks and remediation fields from Cluster will be used instead of the corresponding fields in ClusterClass.

Independent of this configuration the MachineHealthCheck controller will always flag Machines with cluster.x-k8s.io/remediate-machine annotation and Machines with deleted Nodes as unhealthy.

Furthermore, if checks.nodeStartupTimeoutSeconds is not set it is defaulted to 10 minutes and evaluated accordingly.

enabled: Option<bool>

enabled controls if a MachineHealthCheck should be created for the target machines.

If false: No MachineHealthCheck will be created.

If not set(default): A MachineHealthCheck will be created if it is defined here or in the associated ClusterClass. If no MachineHealthCheck is defined then none will be created.

If true: A MachineHealthCheck is guaranteed to be created. Cluster validation will block if enable is true and no MachineHealthCheck definition is available.

remediation: Option<ClusterTopologyControlPlaneHealthCheckRemediation>

remediation configures if and how remediations are triggered if a Machine is unhealthy.

If one of checks and remediation fields are set, the system assumes that an healthCheck override is defined, and as a consequence the checks and remediation fields from cluster will be used instead of the corresponding fields in ClusterClass.

If an health check override is defined and remediation or remediation.triggerIf is not set, remediation will always be triggered for unhealthy Machines.

If an health check override is defined and remediation or remediation.templateRef is not set, the OwnerRemediated condition will be set on unhealthy Machines to trigger remediation via the owner of the Machines, for example a MachineSet or a KubeadmControlPlane.

Trait Implementations

impl Clone for ClusterTopologyControlPlaneHealthCheck

fn clone(&self) -> ClusterTopologyControlPlaneHealthCheck

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClusterTopologyControlPlaneHealthCheck

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

Formats the value using the given formatter.

impl Default for ClusterTopologyControlPlaneHealthCheck

fn default() -> ClusterTopologyControlPlaneHealthCheck

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClusterTopologyControlPlaneHealthCheck

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ClusterTopologyControlPlaneHealthCheck

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ClusterTopologyControlPlaneHealthCheck

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

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

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 ClusterTopologyControlPlaneHealthCheck

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 ClusterTopologyControlPlaneHealthCheck