⚠️ Drop unnecessary fields from remediationTemplate references (#12368)

* Drop unnecessary fields from remediationTemplate references

# Conflicts:
#	api/core/v1beta1/conversion.go
#	api/core/v1beta1/zz_generated.conversion.go

* Address feedback

* More comments

Author: fabriziopandini

api/core/v1beta1/conversion.go

@@ -37,8 +37,23 @@ func (src *Cluster) ConvertTo(dstRaw conversion.Hub) error {
 
 func (dst *Cluster) ConvertFrom(srcRaw conversion.Hub) error {
 	src := srcRaw.(*clusterv1.Cluster)
+	if err := Convert_v1beta2_Cluster_To_v1beta1_Cluster(src, dst, nil); err != nil {
+		return err
+	}
 
-	return Convert_v1beta2_Cluster_To_v1beta1_Cluster(src, dst, nil)
+	if dst.Spec.Topology != nil {
+		if dst.Spec.Topology.ControlPlane.MachineHealthCheck != nil && dst.Spec.Topology.ControlPlane.MachineHealthCheck.RemediationTemplate != nil {
+			dst.Spec.Topology.ControlPlane.MachineHealthCheck.RemediationTemplate.Namespace = dst.Namespace
+		}
+		if dst.Spec.Topology.Workers != nil {
+			for _, md := range dst.Spec.Topology.Workers.MachineDeployments {
+				if md.MachineHealthCheck != nil && md.MachineHealthCheck.RemediationTemplate != nil {
+					md.MachineHealthCheck.RemediationTemplate.Namespace = dst.Namespace
+				}
+			}
+		}
+	}
+	return nil
 }
 
 func (src *ClusterClass) ConvertTo(dstRaw conversion.Hub) error {
@@ -49,8 +64,19 @@ func (src *ClusterClass) ConvertTo(dstRaw conversion.Hub) error {
 
 func (dst *ClusterClass) ConvertFrom(srcRaw conversion.Hub) error {
 	src := srcRaw.(*clusterv1.ClusterClass)
+	if err := Convert_v1beta2_ClusterClass_To_v1beta1_ClusterClass(src, dst, nil); err != nil {
+		return err
+	}
 
-	return Convert_v1beta2_ClusterClass_To_v1beta1_ClusterClass(src, dst, nil)
+	if dst.Spec.ControlPlane.MachineHealthCheck != nil && dst.Spec.ControlPlane.MachineHealthCheck.RemediationTemplate != nil {
+		dst.Spec.ControlPlane.MachineHealthCheck.RemediationTemplate.Namespace = dst.Namespace
+	}
+	for _, md := range dst.Spec.Workers.MachineDeployments {
+		if md.MachineHealthCheck != nil && md.MachineHealthCheck.RemediationTemplate != nil {
+			md.MachineHealthCheck.RemediationTemplate.Namespace = dst.Namespace
+		}
+	}
+	return nil
 }
 
 func (src *Machine) ConvertTo(dstRaw conversion.Hub) error {
@@ -140,8 +166,14 @@ func (src *MachineHealthCheck) ConvertTo(dstRaw conversion.Hub) error {
 
 func (dst *MachineHealthCheck) ConvertFrom(srcRaw conversion.Hub) error {
 	src := srcRaw.(*clusterv1.MachineHealthCheck)
+	if err := Convert_v1beta2_MachineHealthCheck_To_v1beta1_MachineHealthCheck(src, dst, nil); err != nil {
+		return err
+	}
 
-	return Convert_v1beta2_MachineHealthCheck_To_v1beta1_MachineHealthCheck(src, dst, nil)
+	if dst.Spec.RemediationTemplate != nil {
+		dst.Spec.RemediationTemplate.Namespace = src.Namespace
+	}
+	return nil
 }
 
 func (src *MachinePool) ConvertTo(dstRaw conversion.Hub) error {
@@ -1140,6 +1172,20 @@ func Convert_v1beta2_ExternalPatchDefinition_To_v1beta1_ExternalPatchDefinition(
 	return nil
 }
 
+func Convert_v1_ObjectReference_To_v1beta2_MachineHealthCheckRemediationTemplateReference(in *corev1.ObjectReference, out *clusterv1.MachineHealthCheckRemediationTemplateReference, _ apimachineryconversion.Scope) error {
+	out.Name = in.Name
+	out.Kind = in.Kind
+	out.APIVersion = in.APIVersion
+	return nil
+}
+
+func Convert_v1beta2_MachineHealthCheckRemediationTemplateReference_To_v1_ObjectReference(in *clusterv1.MachineHealthCheckRemediationTemplateReference, out *corev1.ObjectReference, _ apimachineryconversion.Scope) error {
+	out.Name = in.Name
+	out.Kind = in.Kind
+	out.APIVersion = in.APIVersion
+	return nil
+}
+
 func Convert_v1_ObjectReference_To_v1beta2_MachineNodeReference(in *corev1.ObjectReference, out *clusterv1.MachineNodeReference, _ apimachineryconversion.Scope) error {
 	out.Name = in.Name
 	return nil

api/core/v1beta1/conversion_test.go

@@ -29,6 +29,7 @@ import (
 	"k8s.io/apimachinery/pkg/api/apitesting/fuzzer"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	runtimeserializer "k8s.io/apimachinery/pkg/runtime/serializer"
+	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/utils/ptr"
 	"sigs.k8s.io/randfill"
 
@@ -79,7 +80,9 @@ func TestFuzzyConversion(t *testing.T) {
 func ClusterFuzzFuncs(_ runtimeserializer.CodecFactory) []interface{} {
 	return []interface{}{
 		hubClusterStatus,
+		spokeCluster,
 		spokeClusterTopology,
+		spokeObjectReference,
 		spokeClusterStatus,
 		spokeClusterVariable,
 		spokeControlPlaneTopology,
@@ -107,6 +110,12 @@ func hubClusterStatus(in *clusterv1.ClusterStatus, c randfill.Continue) {
 	}
 }
 
+func spokeCluster(in *Cluster, c randfill.Continue) {
+	c.FillNoCustom(in)
+
+	in.Namespace = "foo"
+}
+
 func spokeClusterTopology(in *Topology, c randfill.Continue) {
 	c.FillNoCustom(in)
 
@@ -136,6 +145,7 @@ func ClusterClassFuncs(_ runtimeserializer.CodecFactory) []interface{} {
 		hubClusterClassStatus,
 		hubJSONSchemaProps,
 		spokeClusterClass,
+		spokeObjectReference,
 		spokeClusterClassStatus,
 		spokeJSONSchemaProps,
 		spokeControlPlaneClass,
@@ -414,8 +424,10 @@ func spokeMachineDeploymentStatus(in *MachineDeploymentStatus, c randfill.Contin
 func MachineHealthCheckFuzzFuncs(_ runtimeserializer.CodecFactory) []interface{} {
 	return []interface{}{
 		hubMachineHealthCheckStatus,
-		spokeMachineHealthCheckStatus,
+		spokeMachineHealthCheck,
 		spokeMachineHealthCheckSpec,
+		spokeObjectReference,
+		spokeMachineHealthCheckStatus,
 		spokeUnhealthyCondition,
 	}
 }
@@ -430,6 +442,12 @@ func hubMachineHealthCheckStatus(in *clusterv1.MachineHealthCheckStatus, c randf
 	}
 }
 
+func spokeMachineHealthCheck(in *MachineHealthCheck, c randfill.Continue) {
+	c.FillNoCustom(in)
+
+	in.Namespace = "foo"
+}
+
 func spokeMachineHealthCheckStatus(in *MachineHealthCheckStatus, c randfill.Continue) {
 	c.FillNoCustom(in)
 	// Drop empty structs with only omit empty fields.
@@ -440,6 +458,19 @@ func spokeMachineHealthCheckStatus(in *MachineHealthCheckStatus, c randfill.Cont
 	}
 }
 
+func spokeObjectReference(in *corev1.ObjectReference, c randfill.Continue) {
+	c.FillNoCustom(in)
+
+	if in == nil {
+		return
+	}
+
+	in.Namespace = "foo"
+	in.UID = types.UID("")
+	in.ResourceVersion = ""
+	in.FieldPath = ""
+}
+
 func MachinePoolFuzzFuncs(_ runtimeserializer.CodecFactory) []interface{} {
 	return []interface{}{
 		hubMachinePoolStatus,

api/core/v1beta1/zz_generated.conversion.go

@@ -433,7 +433,7 @@ type MachineHealthCheckClass struct {
 	// creates a new object from the template referenced and hands off remediation of the machine to
 	// a controller that lives outside of Cluster API.
 	// +optional
-	RemediationTemplate *corev1.ObjectReference `json:"remediationTemplate,omitempty"`
+	RemediationTemplate *MachineHealthCheckRemediationTemplateReference `json:"remediationTemplate,omitempty"`
 }
 
 // MachinePoolClass serves as a template to define a pool of worker nodes of the cluster

api/core/v1beta2/clusterclass_types.go

@@ -19,6 +19,7 @@ package v1beta2
 import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/apimachinery/pkg/util/intstr"
 )
 
@@ -114,7 +115,53 @@ type MachineHealthCheckSpec struct {
 	// creates a new object from the template referenced and hands off remediation of the machine to
 	// a controller that lives outside of Cluster API.
 	// +optional
-	RemediationTemplate *corev1.ObjectReference `json:"remediationTemplate,omitempty"`
+	RemediationTemplate *MachineHealthCheckRemediationTemplateReference `json:"remediationTemplate,omitempty"`
+}
+
+// MachineHealthCheckRemediationTemplateReference is a reference to a remediation template.
+type MachineHealthCheckRemediationTemplateReference struct {
+	// kind of the remediation template.
+	// kind must consist of alphanumeric characters or '-', start with an alphabetic character, and end with an alphanumeric character.
+	// +required
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=63
+	// +kubebuilder:validation:Pattern=`^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$`
+	Kind string `json:"kind"`
+
+	// name of the remediation template.
+	// name must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.
+	// +required
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=253
+	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
+	Name string `json:"name"`
+
+	// apiVersion of the remediation template.
+	// apiVersion must be fully qualified domain name followed by / and a version.
+	// NOTE: This field must be kept in sync with the APIVersion of the remediation template.
+	// +required
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=317
+	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[a-z]([-a-z0-9]*[a-z0-9])?$`
+	APIVersion string `json:"apiVersion"`
+}
+
+// ToObjectReference returns an object reference for the MachineHealthCheckRemediationTemplateReference in a given namespace.
+func (r *MachineHealthCheckRemediationTemplateReference) ToObjectReference(namespace string) *corev1.ObjectReference {
+	if r == nil {
+		return nil
+	}
+	return &corev1.ObjectReference{
+		APIVersion: r.APIVersion,
+		Kind:       r.Kind,
+		Namespace:  namespace,
+		Name:       r.Name,
+	}
+}
+
+// GroupVersionKind gets the GroupVersionKind for a MachineHealthCheckRemediationTemplateReference.
+func (r *MachineHealthCheckRemediationTemplateReference) GroupVersionKind() schema.GroupVersionKind {
+	return schema.FromAPIVersionAndKind(r.APIVersion, r.Kind)
 }
 
 // ANCHOR_END: MachineHealthCHeckSpec