Struct cluster_api_rs::api::capi_clusterclass::ClusterClassWorkersMachineDeploymentsMachineHealthCheck

pub struct ClusterClassWorkersMachineDeploymentsMachineHealthCheck {
    pub max_unhealthy: Option<IntOrString>,
    pub node_startup_timeout: Option<String>,
    pub remediation_template: Option<ObjectReference>,
    pub unhealthy_conditions: Option<Vec<ClusterClassWorkersMachineDeploymentsMachineHealthCheckUnhealthyConditions>>,
    pub unhealthy_range: Option<String>,
}

MachineHealthCheck defines a MachineHealthCheck for this MachineDeploymentClass.

Fields

max_unhealthy: Option<IntOrString>

Any further remediation is only allowed if at most “MaxUnhealthy” machines selected by “selector” are not healthy.

node_startup_timeout: Option<String>

NodeStartupTimeout allows to set the maximum time for MachineHealthCheck to consider a Machine unhealthy if a corresponding Node isn’t associated through a Spec.ProviderID field.

The duration set in this field is compared to the greatest of:

• Cluster’s infrastructure ready condition timestamp (if and when available)
• Control Plane’s initialized condition timestamp (if and when available)
• Machine’s infrastructure ready condition timestamp (if and when available)
• Machine’s metadata creation timestamp

Defaults to 10 minutes. If you wish to disable this feature, set the value explicitly to 0.

remediation_template: Option<ObjectReference>

RemediationTemplate is a reference to a remediation template provided by an infrastructure provider.

This field is completely optional, when filled, the MachineHealthCheck controller creates a new object from the template referenced and hands off remediation of the machine to a controller that lives outside of Cluster API.

unhealthy_conditions: Option<Vec<ClusterClassWorkersMachineDeploymentsMachineHealthCheckUnhealthyConditions>>

UnhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.

unhealthy_range: Option<String>

Any further remediation is only allowed if the number of machines selected by “selector” as not healthy is within the range of “UnhealthyRange”. Takes precedence over MaxUnhealthy. Eg. “[3-5]” - This means that remediation will be allowed only when: (a) there are at least 3 unhealthy machines (and) (b) there are at most 5 unhealthy machines

Trait Implementations

impl Clone for ClusterClassWorkersMachineDeploymentsMachineHealthCheck

fn clone(&self) -> ClusterClassWorkersMachineDeploymentsMachineHealthCheck

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClusterClassWorkersMachineDeploymentsMachineHealthCheck

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

Formats the value using the given formatter.

impl Default for ClusterClassWorkersMachineDeploymentsMachineHealthCheck

fn default() -> ClusterClassWorkersMachineDeploymentsMachineHealthCheck

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClusterClassWorkersMachineDeploymentsMachineHealthCheck

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ClusterClassWorkersMachineDeploymentsMachineHealthCheck

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(gen: &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 Serialize for ClusterClassWorkersMachineDeploymentsMachineHealthCheck

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

where __S: Serializer,

Serialize this value into the given Serde serializer.