⚠️ Drop unnecessary fields from Machine status.nodeRef (#12352)

* Refactor machine nodeRef

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

* Address comments

* More comments

Author: fabriziopandini

api/core/v1beta1/conversion.go

@@ -1140,6 +1140,18 @@ func Convert_v1beta2_ExternalPatchDefinition_To_v1beta1_ExternalPatchDefinition(
 	return nil
 }
 
+func Convert_v1_ObjectReference_To_v1beta2_MachineNodeReference(in *corev1.ObjectReference, out *clusterv1.MachineNodeReference, _ apimachineryconversion.Scope) error {
+	out.Name = in.Name
+	return nil
+}
+
+func Convert_v1beta2_MachineNodeReference_To_v1_ObjectReference(in *clusterv1.MachineNodeReference, out *corev1.ObjectReference, _ apimachineryconversion.Scope) error {
+	out.Name = in.Name
+	out.APIVersion = corev1.SchemeGroupVersion.String()
+	out.Kind = "Node"
+	return nil
+}
+
 func Convert_v1beta1_LocalObjectTemplate_To_v1beta2_ClusterClassTemplate(in *LocalObjectTemplate, out *clusterv1.ClusterClassTemplate, _ apimachineryconversion.Scope) error {
 	if in.Ref == nil {
 		return nil

api/core/v1beta1/conversion_test.go

@@ -321,6 +321,15 @@ func spokeMachineStatus(in *MachineStatus, c randfill.Continue) {
 			in.V1Beta2 = nil
 		}
 	}
+
+	if in.NodeRef != nil {
+		// Drop everything except name
+		in.NodeRef = &corev1.ObjectReference{
+			Name:       in.NodeRef.Name,
+			APIVersion: corev1.SchemeGroupVersion.String(),
+			Kind:       "Node",
+		}
+	}
 }
 
 func MachineSetFuzzFuncs(_ runtimeserializer.CodecFactory) []interface{} {

api/core/v1beta1/zz_generated.conversion.go

@@ -20,7 +20,6 @@ import (
 	"testing"
 
 	. "github.com/onsi/gomega"
-	corev1 "k8s.io/api/core/v1"
 	"k8s.io/utils/ptr"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
@@ -42,7 +41,7 @@ func TestIndexMachineByNodeName(t *testing.T) {
 			name: "when the machine has valid a NodeRef",
 			object: &clusterv1.Machine{
 				Status: clusterv1.MachineStatus{
-					NodeRef: &corev1.ObjectReference{
+					NodeRef: &clusterv1.MachineNodeReference{
 						Name: "node1",
 					},
 				},

api/core/v1beta2/index/machine_test.go

@@ -516,7 +516,7 @@ type MachineStatus struct {
 
 	// nodeRef will point to the corresponding Node if it exists.
 	// +optional
-	NodeRef *corev1.ObjectReference `json:"nodeRef,omitempty"`
+	NodeRef *MachineNodeReference `json:"nodeRef,omitempty"`
 
 	// nodeInfo is a set of ids/uuids to uniquely identify the node.
 	// More info: https://kubernetes.io/docs/concepts/nodes/node/#info
@@ -556,6 +556,17 @@ type MachineStatus struct {
 	Deprecated *MachineDeprecatedStatus `json:"deprecated,omitempty"`
 }
 
+// MachineNodeReference is a reference to the node running on the machine.
+type MachineNodeReference struct {
+	// name of the node.
+	// 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"`
+}
+
 // MachineInitializationStatus provides observations of the Machine initialization process.
 // NOTE: Fields in this struct are part of the Cluster API contract and are used to orchestrate initial Machine provisioning.
 type MachineInitializationStatus struct {

api/core/v1beta2/machine_types.go

@@ -1213,19 +1213,15 @@ func TestBootstrapTokenTTLExtension(t *testing.T) {
 
 	patchHelper, err = patch.NewHelper(workerMachine, myclient)
 	g.Expect(err).ShouldNot(HaveOccurred())
-	workerMachine.Status.NodeRef = &corev1.ObjectReference{
-		APIVersion: "v1",
-		Kind:       "Node",
-		Name:       "worker-node",
+	workerMachine.Status.NodeRef = &clusterv1.MachineNodeReference{
+		Name: "worker-node",
 	}
 	g.Expect(patchHelper.Patch(ctx, workerMachine)).To(Succeed())
 
 	patchHelper, err = patch.NewHelper(controlPlaneJoinMachine, myclient)
 	g.Expect(err).ShouldNot(HaveOccurred())
-	controlPlaneJoinMachine.Status.NodeRef = &corev1.ObjectReference{
-		APIVersion: "v1",
-		Kind:       "Node",
-		Name:       "control-plane-node",
+	controlPlaneJoinMachine.Status.NodeRef = &clusterv1.MachineNodeReference{
+		Name: "control-plane-node",
 	}
 	g.Expect(patchHelper.Patch(ctx, controlPlaneJoinMachine)).To(Succeed())
 

api/core/v1beta2/zz_generated.deepcopy.go

@@ -221,10 +221,8 @@ func TestHasNodeRefs(t *testing.T) {
 				Initialization: &clusterv1.MachineInitializationStatus{
 					InfrastructureProvisioned: true,
 				},
-				NodeRef: &corev1.ObjectReference{
-					Kind:      "Node",
-					Namespace: metav1.NamespaceDefault,
-					Name:      "node-0",
+				NodeRef: &clusterv1.MachineNodeReference{
+					Name: "node-0",
 				},
 			},
 		}

api/core/v1beta2/zz_generated.openapi.go

@@ -1626,7 +1626,7 @@ func Test_objectMover_checkProvisioningCompleted(t *testing.T) {
 							},
 						},
 						Status: clusterv1.MachineStatus{
-							NodeRef: &corev1.ObjectReference{},
+							NodeRef: &clusterv1.MachineNodeReference{},
 						},
 					},
 				},

bootstrap/kubeadm/internal/controllers/kubeadmconfig_controller_test.go

@@ -149,23 +149,23 @@ func TestHasMachinesToBeRemediated(t *testing.T) {
 	// healthy machine (without MachineHealthCheckSucceded condition)
 	healthyMachineNotProvisioned := &clusterv1.Machine{ObjectMeta: metav1.ObjectMeta{Name: "healthyMachine1"}}
 	// healthy machine (with MachineHealthCheckSucceded == true)
-	healthyMachineProvisioned := &clusterv1.Machine{ObjectMeta: metav1.ObjectMeta{Name: "healthyMachine2"}, Status: clusterv1.MachineStatus{NodeRef: &corev1.ObjectReference{Kind: "Node", Name: "node1"}}}
+	healthyMachineProvisioned := &clusterv1.Machine{ObjectMeta: metav1.ObjectMeta{Name: "healthyMachine2"}, Status: clusterv1.MachineStatus{NodeRef: &clusterv1.MachineNodeReference{Name: "node1"}}}
 	healthyMachineProvisioned.SetConditions([]metav1.Condition{
 		{
 			Type:   clusterv1.MachineHealthCheckSucceededCondition,
 			Status: metav1.ConditionTrue,
 		},
 	})
 	// unhealthy machine NOT eligible for KCP remediation (with MachineHealthCheckSucceded == False, but without MachineOwnerRemediated condition)
-	unhealthyMachineNOTOwnerRemediated := &clusterv1.Machine{ObjectMeta: metav1.ObjectMeta{Name: "unhealthyMachineNOTOwnerRemediated"}, Status: clusterv1.MachineStatus{NodeRef: &corev1.ObjectReference{Kind: "Node", Name: "node2"}}}
+	unhealthyMachineNOTOwnerRemediated := &clusterv1.Machine{ObjectMeta: metav1.ObjectMeta{Name: "unhealthyMachineNOTOwnerRemediated"}, Status: clusterv1.MachineStatus{NodeRef: &clusterv1.MachineNodeReference{Name: "node2"}}}
 	unhealthyMachineNOTOwnerRemediated.SetConditions([]metav1.Condition{
 		{
 			Type:   clusterv1.MachineHealthCheckSucceededCondition,
 			Status: metav1.ConditionFalse,
 		},
 	})
 	// unhealthy machine eligible for KCP remediation (with MachineHealthCheckSucceded == False, with MachineOwnerRemediated condition)
-	unhealthyMachineOwnerRemediated := &clusterv1.Machine{ObjectMeta: metav1.ObjectMeta{Name: "unhealthyMachineOwnerRemediated"}, Status: clusterv1.MachineStatus{NodeRef: &corev1.ObjectReference{Kind: "Node", Name: "node3"}}}
+	unhealthyMachineOwnerRemediated := &clusterv1.Machine{ObjectMeta: metav1.ObjectMeta{Name: "unhealthyMachineOwnerRemediated"}, Status: clusterv1.MachineStatus{NodeRef: &clusterv1.MachineNodeReference{Name: "node3"}}}
 	unhealthyMachineOwnerRemediated.SetConditions([]metav1.Condition{
 		{
 			Type:   clusterv1.MachineHealthCheckSucceededCondition,
@@ -232,7 +232,7 @@ func TestHasHealthyMachineStillProvisioning(t *testing.T) {
 
 	// healthy machine (without MachineHealthCheckSucceded condition) provisioned (with NodeRef)
 	healthyMachineProvisioned1 := &clusterv1.Machine{ObjectMeta: metav1.ObjectMeta{Name: "healthyMachineProvisioned1"}}
-	healthyMachineProvisioned1.Status.NodeRef = &corev1.ObjectReference{}
+	healthyMachineProvisioned1.Status.NodeRef = &clusterv1.MachineNodeReference{}
 
 	// unhealthy machine (with MachineHealthCheckSucceded condition) still provisioning (without NodeRef)
 	unhealthyMachineStillProvisioning1 := &clusterv1.Machine{ObjectMeta: metav1.ObjectMeta{Name: "unhealthyMachineStillProvisioning1"}}
@@ -249,7 +249,7 @@ func TestHasHealthyMachineStillProvisioning(t *testing.T) {
 
 	// unhealthy machine (with MachineHealthCheckSucceded condition) provisioned (with NodeRef)
 	unhealthyMachineProvisioned1 := &clusterv1.Machine{ObjectMeta: metav1.ObjectMeta{Name: "unhealthyMachineProvisioned1"}}
-	unhealthyMachineProvisioned1.Status.NodeRef = &corev1.ObjectReference{}
+	unhealthyMachineProvisioned1.Status.NodeRef = &clusterv1.MachineNodeReference{}
 	unhealthyMachineProvisioned1.SetConditions([]metav1.Condition{
 		{
 			Type:   clusterv1.MachineHealthCheckSucceededCondition,
@@ -292,7 +292,7 @@ func TestStatusToLogKeyAndValues(t *testing.T) {
 	healthyMachine := &clusterv1.Machine{
 		ObjectMeta: metav1.ObjectMeta{Name: "healthy"},
 		Status: clusterv1.MachineStatus{
-			NodeRef: &corev1.ObjectReference{Name: "healthy-node"},
+			NodeRef: &clusterv1.MachineNodeReference{Name: "healthy-node"},
 			Conditions: []metav1.Condition{
 				{Type: controlplanev1.KubeadmControlPlaneMachineAPIServerPodHealthyCondition, Status: metav1.ConditionTrue},
 				{Type: controlplanev1.KubeadmControlPlaneMachineControllerManagerPodHealthyCondition, Status: metav1.ConditionTrue},