Add initialization to Machine Status

Author: fabriziopandini

api/v1beta1/conversion.go

@@ -478,6 +478,12 @@ func Convert_v1beta2_MachineStatus_To_v1beta1_MachineStatus(in *clusterv1.Machin
 		out.FailureMessage = in.Deprecated.V1Beta1.FailureMessage
 	}
 
+	// Move initialization to old fields
+	if in.Initialization != nil {
+		out.BootstrapReady = in.Initialization.BootstrapDataSecretCreated
+		out.InfrastructureReady = in.Initialization.InfrastructureProvisioned
+	}
+
 	// Move new conditions (v1beta2) to the v1beta2 field.
 	if in.Conditions == nil {
 		return nil
@@ -501,6 +507,15 @@ func Convert_v1beta1_MachineStatus_To_v1beta2_MachineStatus(in *MachineStatus, o
 		out.Conditions = in.V1Beta2.Conditions
 	}
 
+	// Move BootstrapReady and InfrastructureReady to Initialization
+	if in.BootstrapReady || in.InfrastructureReady {
+		if out.Initialization == nil {
+			out.Initialization = &clusterv1.MachineInitializationStatus{}
+		}
+		out.Initialization.BootstrapDataSecretCreated = in.BootstrapReady
+		out.Initialization.InfrastructureProvisioned = in.InfrastructureReady
+	}
+
 	// Move legacy conditions (v1beta1), failureReason and failureMessage to the deprecated field.
 	if in.Conditions == nil && in.FailureReason == nil && in.FailureMessage == nil {
 		return nil

api/v1beta1/conversion_test.go

@@ -225,6 +225,13 @@ func hubMachineStatus(in *clusterv1.MachineStatus, c fuzz.Continue) {
 			in.Deprecated = nil
 		}
 	}
+
+	// Drop empty structs with only omit empty fields.
+	if in.Initialization != nil {
+		if reflect.DeepEqual(in.Initialization, &clusterv1.MachineInitializationStatus{}) {
+			in.Initialization = nil
+		}
+	}
 }
 
 func spokeMachineStatus(in *MachineStatus, c fuzz.Continue) {

api/v1beta1/zz_generated.conversion.go

@@ -509,6 +509,11 @@ type MachineStatus struct {
 	// +kubebuilder:validation:MaxItems=32
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 
+	// initialization 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.
+	// +optional
+	Initialization *MachineInitializationStatus `json:"initialization,omitempty"`
+
 	// nodeRef will point to the corresponding Node if it exists.
 	// +optional
 	NodeRef *corev1.ObjectReference `json:"nodeRef,omitempty"`
@@ -537,14 +542,6 @@ type MachineStatus struct {
 	// +optional
 	CertificatesExpiryDate *metav1.Time `json:"certificatesExpiryDate,omitempty"`
 
-	// bootstrapReady is the state of the bootstrap provider.
-	// +optional
-	BootstrapReady bool `json:"bootstrapReady"`
-
-	// infrastructureReady is the state of the infrastructure provider.
-	// +optional
-	InfrastructureReady bool `json:"infrastructureReady"`
-
 	// observedGeneration is the latest generation observed by the controller.
 	// +optional
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
@@ -559,6 +556,22 @@ type MachineStatus struct {
 	Deprecated *MachineDeprecatedStatus `json:"deprecated,omitempty"`
 }
 
+// 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 {
+	// infrastructureProvisioned is true when the infrastructure provider reports that Machine's infrastructure is fully provisioned.
+	// NOTE: this field is part of the Cluster API contract, and it is used to orchestrate provisioning.
+	// The value of this field is never updated after provisioning is completed.
+	// +optional
+	InfrastructureProvisioned bool `json:"infrastructureProvisioned"`
+
+	// bootstrapDataSecretCreated is true when the bootstrap provider reports that the Machine's boostrap secret is created.
+	// NOTE: this field is part of the Cluster API contract, and it is used to orchestrate provisioning.
+	// The value of this field is never updated after provisioning is completed.
+	// +optional
+	BootstrapDataSecretCreated bool `json:"bootstrapDataSecretCreated"`
+}
+
 // MachineDeprecatedStatus groups all the status fields that are deprecated and will be removed in a future version.
 // See https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more context.
 type MachineDeprecatedStatus struct {

api/v1beta2/machine_types.go

@@ -1166,12 +1166,16 @@ func TestBootstrapTokenTTLExtension(t *testing.T) {
 
 	patchHelper, err := patch.NewHelper(workerMachine, myclient)
 	g.Expect(err).ShouldNot(HaveOccurred())
-	workerMachine.Status.InfrastructureReady = true
+	workerMachine.Status.Initialization = &clusterv1.MachineInitializationStatus{
+		InfrastructureProvisioned: true,
+	}
 	g.Expect(patchHelper.Patch(ctx, workerMachine)).To(Succeed())
 
 	patchHelper, err = patch.NewHelper(controlPlaneJoinMachine, myclient)
 	g.Expect(err).ShouldNot(HaveOccurred())
-	controlPlaneJoinMachine.Status.InfrastructureReady = true
+	controlPlaneJoinMachine.Status.Initialization = &clusterv1.MachineInitializationStatus{
+		InfrastructureProvisioned: true,
+	}
 	g.Expect(patchHelper.Patch(ctx, controlPlaneJoinMachine)).To(Succeed())
 
 	for _, req := range []ctrl.Request{

api/v1beta2/zz_generated.deepcopy.go

@@ -42,7 +42,14 @@ type ConfigOwner struct {
 
 // IsInfrastructureReady extracts infrastructure status from the config owner.
 func (co ConfigOwner) IsInfrastructureReady() bool {
-	infrastructureReady, _, err := unstructured.NestedBool(co.Object, "status", "infrastructureReady")
+	if co.IsMachinePool() {
+		infrastructureReady, _, err := unstructured.NestedBool(co.Object, "status", "infrastructureReady")
+		if err != nil {
+			return false
+		}
+		return infrastructureReady
+	}
+	infrastructureReady, _, err := unstructured.NestedBool(co.Object, "status", "initialization", "infrastructureProvisioned")
 	if err != nil {
 		return false
 	}

api/v1beta2/zz_generated.openapi.go

@@ -58,7 +58,9 @@ func TestGetConfigOwner(t *testing.T) {
 					Version: ptr.To("v1.19.6"),
 				},
 				Status: clusterv1.MachineStatus{
-					InfrastructureReady: true,
+					Initialization: &clusterv1.MachineInitializationStatus{
+						InfrastructureProvisioned: true,
+					},
 				},
 			}
 
@@ -215,7 +217,9 @@ func TestHasNodeRefs(t *testing.T) {
 				Namespace: metav1.NamespaceDefault,
 			},
 			Status: clusterv1.MachineStatus{
-				InfrastructureReady: true,
+				Initialization: &clusterv1.MachineInitializationStatus{
+					InfrastructureProvisioned: true,
+				},
 				NodeRef: &corev1.ObjectReference{
 					Kind:      "Node",
 					Namespace: metav1.NamespaceDefault,

bootstrap/kubeadm/internal/controllers/kubeadmconfig_controller_test.go

@@ -131,6 +131,15 @@ func (src *Machine) ConvertTo(dstRaw conversion.Hub) error {
 		dst.Status.Deprecated.V1Beta1.FailureMessage = src.Status.FailureMessage
 	}
 
+	// Move BootstrapReady and InfrastructureReady to Initialization
+	if src.Status.BootstrapReady || src.Status.InfrastructureReady {
+		if dst.Status.Initialization == nil {
+			dst.Status.Initialization = &clusterv1.MachineInitializationStatus{}
+		}
+		dst.Status.Initialization.BootstrapDataSecretCreated = src.Status.BootstrapReady
+		dst.Status.Initialization.InfrastructureProvisioned = src.Status.InfrastructureReady
+	}
+
 	// Manually restore data.
 	restored := &clusterv1.Machine{}
 	if ok, err := utilconversion.UnmarshalData(src, restored); err != nil || !ok {
@@ -170,6 +179,12 @@ func (dst *Machine) ConvertFrom(srcRaw conversion.Hub) error {
 		}
 	}
 
+	// Move initialization to old fields
+	if src.Status.Initialization != nil {
+		dst.Status.BootstrapReady = src.Status.Initialization.BootstrapDataSecretCreated
+		dst.Status.InfrastructureReady = src.Status.Initialization.InfrastructureProvisioned
+	}
+
 	// Preserve Hub data on down-conversion except for metadata
 	if err := utilconversion.MarshalData(src, dst); err != nil {
 		return err

bootstrap/util/configowner.go

@@ -83,6 +83,13 @@ func hubMachineStatus(in *clusterv1.MachineStatus, c fuzz.Continue) {
 			in.Deprecated = nil
 		}
 	}
+
+	// Drop empty structs with only omit empty fields.
+	if in.Initialization != nil {
+		if reflect.DeepEqual(in.Initialization, &clusterv1.MachineInitializationStatus{}) {
+			in.Initialization = nil
+		}
+	}
 }
 
 func spokeMachineStatus(in *MachineStatus, c fuzz.Continue) {