Improve godoc

Author: sbueringer

api/core/v1beta2/cluster_types.go

@@ -657,10 +657,19 @@ type ControlPlaneTopologyHealthCheck struct {
 	Enabled *bool `json:"enabled,omitempty"`
 
 	// checks are the checks that are used to evaluate if a Machine is healthy.
+	// Even if checks is not set, the MachineHealthCheck controller will still
+	// flag Machines with `cluster.x-k8s.io/remediate-machine` annotation and
+	// Machines with deleted Nodes as unhealthy. Furthermore, nodeStartupTimeoutSeconds
+	// is defaulted to 10 minutes and evaluated accordingly.
 	// +optional
 	Checks ControlPlaneTopologyHealthCheckChecks `json:"checks,omitempty,omitzero"`
 
 	// remediation configures if and how remediations are triggered if a Machine is unhealthy.
+	// If remediation is not set (and thus triggerIf is not set), remediation will always be
+	// triggered for unhealthy Machines.
+	// If remediation is not set (and thus 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.
 	// +optional
 	Remediation ControlPlaneTopologyHealthCheckRemediation `json:"remediation,omitempty,omitzero"`
 }
@@ -882,10 +891,19 @@ type MachineDeploymentTopologyHealthCheck struct {
 	Enabled *bool `json:"enabled,omitempty"`
 
 	// checks are the checks that are used to evaluate if a Machine is healthy.
+	// Even if checks is not set, the MachineHealthCheck controller will still
+	// flag Machines with `cluster.x-k8s.io/remediate-machine` annotation and
+	// Machines with deleted Nodes as unhealthy. Furthermore, nodeStartupTimeoutSeconds
+	// is defaulted to 10 minutes and evaluated accordingly.
 	// +optional
 	Checks MachineDeploymentTopologyHealthCheckChecks `json:"checks,omitempty,omitzero"`
 
 	// remediation configures if and how remediations are triggered if a Machine is unhealthy.
+	// If remediation is not set (and thus triggerIf is not set), remediation will always be
+	// triggered for unhealthy Machines.
+	// If remediation is not set (and thus 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.
 	// +optional
 	Remediation MachineDeploymentTopologyHealthCheckRemediation `json:"remediation,omitempty,omitzero"`
 }

api/core/v1beta2/clusterclass_types.go

@@ -202,10 +202,19 @@ type ControlPlaneClass struct {
 // +kubebuilder:validation:MinProperties=1
 type ControlPlaneClassHealthCheck struct {
 	// checks are the checks that are used to evaluate if a Machine is healthy.
+	// Even if checks is not set, the MachineHealthCheck controller will still
+	// flag Machines with `cluster.x-k8s.io/remediate-machine` annotation and
+	// Machines with deleted Nodes as unhealthy. Furthermore, nodeStartupTimeoutSeconds
+	// is defaulted to 10 minutes and evaluated accordingly.
 	// +optional
 	Checks ControlPlaneClassHealthCheckChecks `json:"checks,omitempty,omitzero"`
 
 	// remediation configures if and how remediations are triggered if a Machine is unhealthy.
+	// If remediation is not set (and thus triggerIf is not set), remediation will always be
+	// triggered for unhealthy Machines.
+	// If remediation is not set (and thus 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.
 	// +optional
 	Remediation ControlPlaneClassHealthCheckRemediation `json:"remediation,omitempty,omitzero"`
 }
@@ -439,10 +448,19 @@ type MachineDeploymentClass struct {
 // +kubebuilder:validation:MinProperties=1
 type MachineDeploymentClassHealthCheck struct {
 	// checks are the checks that are used to evaluate if a Machine is healthy.
+	// Even if checks is not set, the MachineHealthCheck controller will still
+	// flag Machines with `cluster.x-k8s.io/remediate-machine` annotation and
+	// Machines with deleted Nodes as unhealthy. Furthermore, nodeStartupTimeoutSeconds
+	// is defaulted to 10 minutes and evaluated accordingly.
 	// +optional
 	Checks MachineDeploymentClassHealthCheckChecks `json:"checks,omitempty,omitzero"`
 
 	// remediation configures if and how remediations are triggered if a Machine is unhealthy.
+	// If remediation is not set (and thus triggerIf is not set), remediation will always be
+	// triggered for unhealthy Machines.
+	// If remediation is not set (and thus 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.
 	// +optional
 	Remediation MachineDeploymentClassHealthCheckRemediation `json:"remediation,omitempty,omitzero"`
 }

api/core/v1beta2/machinehealthcheck_types.go

@@ -61,10 +61,19 @@ type MachineHealthCheckSpec struct {
 	Selector metav1.LabelSelector `json:"selector"`
 
 	// checks are the checks that are used to evaluate if a Machine is healthy.
+	// Even if checks is not set, the MachineHealthCheck controller will still
+	// flag Machines with `cluster.x-k8s.io/remediate-machine` annotation and
+	// Machines with deleted Nodes as unhealthy. Furthermore, nodeStartupTimeoutSeconds
+	// is defaulted to 10 minutes and evaluated accordingly.
 	// +optional
 	Checks MachineHealthCheckChecks `json:"checks,omitempty,omitzero"`
 
 	// remediation configures if and how remediations are triggered if a Machine is unhealthy.
+	// If remediation is not set (and thus triggerIf is not set), remediation will always be
+	// triggered for unhealthy Machines.
+	// If remediation is not set (and thus 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.
 	// +optional
 	Remediation MachineHealthCheckRemediation `json:"remediation,omitempty,omitzero"`
 }