✨ Remove pointer, add omitzero & MinProperties for initialization fields/structs

.golangci-kal.yml

@@ -159,7 +159,7 @@ linters:
         - kubeapilinter
     # KAL does not handle omitzero correctly yet: https://github.com/kubernetes-sigs/kube-api-linter/pull/115
     - path: "api/.*"
-      text: "optionalfields: field Status is optional and should (be a pointer|have the omitempty tag)"
+      text: "optionalfields: field (Status|Initialization) is optional and should (be a pointer|have the omitempty tag)"
       linters:
         - kubeapilinter
     - path: "api/bootstrap/kubeadm/v1beta2"

.golangci.yml

@@ -168,6 +168,10 @@ linters:
         # CAPI utils
         - pkg: sigs.k8s.io/cluster-api/util/conditions/deprecated/v1beta1
           alias: v1beta1conditions
+        - pkg: sigs.k8s.io/cluster-api/util/conditions
+          alias: ""
+        - pkg: sigs.k8s.io/cluster-api/util/patch
+          alias: ""
         - pkg: sigs.k8s.io/cluster-api/internal/topology/names
           alias: topologynames
         # CAPD

api/bootstrap/kubeadm/v1beta1/conversion.go

@@ -47,13 +47,10 @@ func (src *KubeadmConfig) ConvertTo(dstRaw conversion.Hub) error {
 
 	// Recover intent for bool values converted to *bool.
 	initialization := bootstrapv1.KubeadmConfigInitializationStatus{}
-	var restoredBootstrapDataSecretCreated *bool
-	if restored.Status.Initialization != nil {
-		restoredBootstrapDataSecretCreated = restored.Status.Initialization.DataSecretCreated
-	}
+	restoredBootstrapDataSecretCreated := restored.Status.Initialization.DataSecretCreated
 	clusterv1.Convert_bool_To_Pointer_bool(src.Status.Ready, ok, restoredBootstrapDataSecretCreated, &initialization.DataSecretCreated)
 	if !reflect.DeepEqual(initialization, bootstrapv1.KubeadmConfigInitializationStatus{}) {
-		dst.Status.Initialization = &initialization
+		dst.Status.Initialization = initialization
 	}
 	if err := RestoreBoolIntentKubeadmConfigSpec(&src.Spec, &dst.Spec, ok, &restored.Spec); err != nil {
 		return err
@@ -363,9 +360,7 @@ func Convert_v1beta2_KubeadmConfigStatus_To_v1beta1_KubeadmConfigStatus(in *boot
 	}
 
 	// Move initialization to old fields
-	if in.Initialization != nil {
-		out.Ready = ptr.Deref(in.Initialization.DataSecretCreated, false)
-	}
+	out.Ready = ptr.Deref(in.Initialization.DataSecretCreated, false)
 
 	// Move new conditions (v1beta2) to the v1beta2 field.
 	if in.Conditions == nil {

api/bootstrap/kubeadm/v1beta1/conversion_test.go

@@ -102,13 +102,6 @@ func hubKubeadmConfigStatus(in *bootstrapv1.KubeadmConfigStatus, c randfill.Cont
 	if in.Deprecated.V1Beta1 == nil {
 		in.Deprecated.V1Beta1 = &bootstrapv1.KubeadmConfigV1Beta1DeprecatedStatus{}
 	}
-
-	// Drop empty structs with only omit empty fields.
-	if in.Initialization != nil {
-		if reflect.DeepEqual(in.Initialization, &bootstrapv1.KubeadmConfigInitializationStatus{}) {
-			in.Initialization = nil
-		}
-	}
 }
 
 func hubKubeadmConfigSpec(in *bootstrapv1.KubeadmConfigSpec, c randfill.Continue) {

api/bootstrap/kubeadm/v1beta2/kubeadmconfig_types.go

@@ -470,7 +470,7 @@ type KubeadmConfigStatus struct {
 	// initialization provides observations of the KubeadmConfig initialization process.
 	// NOTE: Fields in this struct are part of the Cluster API contract and are used to orchestrate initial Machine provisioning.
 	// +optional
-	Initialization *KubeadmConfigInitializationStatus `json:"initialization,omitempty"`
+	Initialization KubeadmConfigInitializationStatus `json:"initialization,omitempty,omitzero"`
 
 	// dataSecretName is the name of the secret that stores the bootstrap data script.
 	// +optional
@@ -489,6 +489,7 @@ type KubeadmConfigStatus struct {
 }
 
 // KubeadmConfigInitializationStatus provides observations of the KubeadmConfig initialization process.
+// +kubebuilder:validation:MinProperties=1
 type KubeadmConfigInitializationStatus struct {
 	// dataSecretCreated is true when the Machine's boostrap secret is created.
 	// NOTE: this field is part of the Cluster API contract, and it is used to orchestrate initial Machine provisioning.

api/controlplane/kubeadm/v1beta1/conversion.go

@@ -65,13 +65,10 @@ func (src *KubeadmControlPlane) ConvertTo(dstRaw conversion.Hub) error {
 
 	// Recover intent for bool values converted to *bool.
 	initialization := controlplanev1.KubeadmControlPlaneInitializationStatus{}
-	var restoredControlPlaneInitialized *bool
-	if restored.Status.Initialization != nil {
-		restoredControlPlaneInitialized = restored.Status.Initialization.ControlPlaneInitialized
-	}
+	restoredControlPlaneInitialized := restored.Status.Initialization.ControlPlaneInitialized
 	clusterv1.Convert_bool_To_Pointer_bool(src.Status.Initialized, ok, restoredControlPlaneInitialized, &initialization.ControlPlaneInitialized)
 	if !reflect.DeepEqual(initialization, controlplanev1.KubeadmControlPlaneInitializationStatus{}) {
-		dst.Status.Initialization = &initialization
+		dst.Status.Initialization = initialization
 	}
 
 	if err := bootstrapv1beta1.RestoreBoolIntentKubeadmConfigSpec(&src.Spec.KubeadmConfigSpec, &dst.Spec.KubeadmConfigSpec, ok, &restored.Spec.KubeadmConfigSpec); err != nil {
@@ -201,9 +198,7 @@ func Convert_v1beta2_KubeadmControlPlaneStatus_To_v1beta1_KubeadmControlPlaneSta
 	}
 
 	// Move initialized to ControlPlaneInitialized, rebuild ready
-	if in.Initialization != nil {
-		out.Initialized = ptr.Deref(in.Initialization.ControlPlaneInitialized, false)
-	}
+	out.Initialized = ptr.Deref(in.Initialization.ControlPlaneInitialized, false)
 	out.Ready = out.ReadyReplicas > 0
 
 	// Move new conditions (v1beta2) and replica counter to the v1beta2 field.

api/controlplane/kubeadm/v1beta1/conversion_test.go

@@ -174,13 +174,6 @@ func hubKubeadmControlPlaneStatus(in *controlplanev1.KubeadmControlPlaneStatus,
 		in.Deprecated.V1Beta1 = &controlplanev1.KubeadmControlPlaneV1Beta1DeprecatedStatus{}
 	}
 
-	// Drop empty structs with only omit empty fields.
-	if in.Initialization != nil {
-		if reflect.DeepEqual(in.Initialization, &controlplanev1.KubeadmControlPlaneInitializationStatus{}) {
-			in.Initialization = nil
-		}
-	}
-
 	// nil becomes &0 after hub => spoke => hub conversion
 	// This is acceptable as usually Replicas is set and controllers using older apiVersions are not writing MachineSet status.
 	if in.Replicas == nil {

api/controlplane/kubeadm/v1beta2/kubeadm_control_plane_types.go

@@ -637,7 +637,7 @@ type KubeadmControlPlaneStatus struct {
 	// initialization provides observations of the KubeadmControlPlane initialization process.
 	// NOTE: Fields in this struct are part of the Cluster API contract and are used to orchestrate initial Machine provisioning.
 	// +optional
-	Initialization *KubeadmControlPlaneInitializationStatus `json:"initialization,omitempty"`
+	Initialization KubeadmControlPlaneInitializationStatus `json:"initialization,omitempty,omitzero"`
 
 	// selector is the label selector in string format to avoid introspection
 	// by clients, and is used to provide the CRD-based integration for the
@@ -688,6 +688,7 @@ type KubeadmControlPlaneStatus struct {
 }
 
 // KubeadmControlPlaneInitializationStatus provides observations of the KubeadmControlPlane initialization process.
+// +kubebuilder:validation:MinProperties=1
 type KubeadmControlPlaneInitializationStatus struct {
 	// controlPlaneInitialized is true when the KubeadmControlPlane provider reports that the Kubernetes control plane is initialized;
 	// A control plane is considered initialized when it can accept requests, no matter if this happens before

api/core/v1beta1/conversion.go

@@ -77,15 +77,12 @@ func (src *Cluster) ConvertTo(dstRaw conversion.Hub) error {
 	clusterv1.Convert_bool_To_Pointer_bool(src.Spec.Paused, ok, restored.Spec.Paused, &dst.Spec.Paused)
 
 	initialization := clusterv1.ClusterInitializationStatus{}
-	var restoredControlPlaneInitialized, restoredInfrastructureProvisioned *bool
-	if restored.Status.Initialization != nil {
-		restoredControlPlaneInitialized = restored.Status.Initialization.ControlPlaneInitialized
-		restoredInfrastructureProvisioned = restored.Status.Initialization.InfrastructureProvisioned
-	}
+	restoredControlPlaneInitialized := restored.Status.Initialization.ControlPlaneInitialized
+	restoredInfrastructureProvisioned := restored.Status.Initialization.InfrastructureProvisioned
 	clusterv1.Convert_bool_To_Pointer_bool(src.Status.ControlPlaneReady, ok, restoredControlPlaneInitialized, &initialization.ControlPlaneInitialized)
 	clusterv1.Convert_bool_To_Pointer_bool(src.Status.InfrastructureReady, ok, restoredInfrastructureProvisioned, &initialization.InfrastructureProvisioned)
 	if !reflect.DeepEqual(initialization, clusterv1.ClusterInitializationStatus{}) {
-		dst.Status.Initialization = &initialization
+		dst.Status.Initialization = initialization
 	}
 	return nil
 }
@@ -381,15 +378,12 @@ func (src *Machine) ConvertTo(dstRaw conversion.Hub) error {
 
 	// Recover intent for bool values converted to *bool.
 	initialization := clusterv1.MachineInitializationStatus{}
-	var restoredBootstrapDataSecretCreated, restoredInfrastructureProvisioned *bool
-	if restored.Status.Initialization != nil {
-		restoredBootstrapDataSecretCreated = restored.Status.Initialization.BootstrapDataSecretCreated
-		restoredInfrastructureProvisioned = restored.Status.Initialization.InfrastructureProvisioned
-	}
+	restoredBootstrapDataSecretCreated := restored.Status.Initialization.BootstrapDataSecretCreated
+	restoredInfrastructureProvisioned := restored.Status.Initialization.InfrastructureProvisioned
 	clusterv1.Convert_bool_To_Pointer_bool(src.Status.BootstrapReady, ok, restoredBootstrapDataSecretCreated, &initialization.BootstrapDataSecretCreated)
 	clusterv1.Convert_bool_To_Pointer_bool(src.Status.InfrastructureReady, ok, restoredInfrastructureProvisioned, &initialization.InfrastructureProvisioned)
 	if !reflect.DeepEqual(initialization, clusterv1.MachineInitializationStatus{}) {
-		dst.Status.Initialization = &initialization
+		dst.Status.Initialization = initialization
 	}
 
 	// Recover other values.
@@ -553,15 +547,12 @@ func (src *MachinePool) ConvertTo(dstRaw conversion.Hub) error {
 
 	// Recover intent for bool values converted to *bool.
 	initialization := clusterv1.MachinePoolInitializationStatus{}
-	var restoredBootstrapDataSecretCreated, restoredInfrastructureProvisioned *bool
-	if restored.Status.Initialization != nil {
-		restoredBootstrapDataSecretCreated = restored.Status.Initialization.BootstrapDataSecretCreated
-		restoredInfrastructureProvisioned = restored.Status.Initialization.InfrastructureProvisioned
-	}
+	restoredBootstrapDataSecretCreated := restored.Status.Initialization.BootstrapDataSecretCreated
+	restoredInfrastructureProvisioned := restored.Status.Initialization.InfrastructureProvisioned
 	clusterv1.Convert_bool_To_Pointer_bool(src.Status.BootstrapReady, ok, restoredBootstrapDataSecretCreated, &initialization.BootstrapDataSecretCreated)
 	clusterv1.Convert_bool_To_Pointer_bool(src.Status.InfrastructureReady, ok, restoredInfrastructureProvisioned, &initialization.InfrastructureProvisioned)
 	if !reflect.DeepEqual(initialization, clusterv1.MachinePoolInitializationStatus{}) {
-		dst.Status.Initialization = &initialization
+		dst.Status.Initialization = initialization
 	}
 
 	return nil
@@ -917,10 +908,8 @@ func Convert_v1beta2_ClusterStatus_To_v1beta1_ClusterStatus(in *clusterv1.Cluste
 	}
 
 	// Move initialization to old fields
-	if in.Initialization != nil {
-		out.ControlPlaneReady = ptr.Deref(in.Initialization.ControlPlaneInitialized, false)
-		out.InfrastructureReady = ptr.Deref(in.Initialization.InfrastructureProvisioned, false)
-	}
+	out.ControlPlaneReady = ptr.Deref(in.Initialization.ControlPlaneInitialized, false)
+	out.InfrastructureReady = ptr.Deref(in.Initialization.InfrastructureProvisioned, false)
 
 	// Move FailureDomains
 	if in.FailureDomains != nil {
@@ -1316,10 +1305,8 @@ func Convert_v1beta2_MachineStatus_To_v1beta1_MachineStatus(in *clusterv1.Machin
 	}
 
 	// Move initialization to old fields
-	if in.Initialization != nil {
-		out.BootstrapReady = ptr.Deref(in.Initialization.BootstrapDataSecretCreated, false)
-		out.InfrastructureReady = ptr.Deref(in.Initialization.InfrastructureProvisioned, false)
-	}
+	out.BootstrapReady = ptr.Deref(in.Initialization.BootstrapDataSecretCreated, false)
+	out.InfrastructureReady = ptr.Deref(in.Initialization.InfrastructureProvisioned, false)
 
 	// Move new conditions (v1beta2) to the v1beta2 field.
 	if in.Conditions == nil {
@@ -1436,10 +1423,8 @@ func Convert_v1beta2_MachinePoolStatus_To_v1beta1_MachinePoolStatus(in *clusterv
 	}
 
 	// Move initialization to old fields
-	if in.Initialization != nil {
-		out.BootstrapReady = ptr.Deref(in.Initialization.BootstrapDataSecretCreated, false)
-		out.InfrastructureReady = ptr.Deref(in.Initialization.InfrastructureProvisioned, false)
-	}
+	out.BootstrapReady = ptr.Deref(in.Initialization.BootstrapDataSecretCreated, false)
+	out.InfrastructureReady = ptr.Deref(in.Initialization.InfrastructureProvisioned, false)
 
 	// Move new conditions (v1beta2) and replica counters to the v1beta2 field.
 	if in.Conditions == nil && in.ReadyReplicas == nil && in.AvailableReplicas == nil && in.UpToDateReplicas == nil {

api/core/v1beta1/conversion_test.go

@@ -136,13 +136,6 @@ func hubClusterStatus(in *clusterv1.ClusterStatus, c randfill.Continue) {
 		}
 	}
 
-	// Drop empty structs with only omit empty fields.
-	if in.Initialization != nil {
-		if reflect.DeepEqual(in.Initialization, &clusterv1.ClusterInitializationStatus{}) {
-			in.Initialization = nil
-		}
-	}
-
 	if len(in.FailureDomains) > 0 {
 		in.FailureDomains = nil // Remove all pre-existing potentially invalid FailureDomains
 		for i := range c.Int31n(20) {
@@ -456,13 +449,6 @@ func hubMachineStatus(in *clusterv1.MachineStatus, c randfill.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 spokeMachine(in *Machine, c randfill.Continue) {
@@ -703,13 +689,6 @@ func hubMachinePoolStatus(in *clusterv1.MachinePoolStatus, c randfill.Continue)
 		in.Deprecated.V1Beta1 = &clusterv1.MachinePoolV1Beta1DeprecatedStatus{}
 	}
 
-	// Drop empty structs with only omit empty fields.
-	if in.Initialization != nil {
-		if reflect.DeepEqual(in.Initialization, &clusterv1.MachinePoolInitializationStatus{}) {
-			in.Initialization = nil
-		}
-	}
-
 	// nil becomes &0 after hub => spoke => hub conversion
 	// This is acceptable as usually Replicas is set and controllers using older apiVersions are not writing MachineSet status.
 	if in.Replicas == nil {

api/core/v1beta2/cluster_types.go

@@ -976,7 +976,7 @@ type ClusterStatus struct {
 	// initialization provides observations of the Cluster initialization process.
 	// NOTE: Fields in this struct are part of the Cluster API contract and are used to orchestrate initial Cluster provisioning.
 	// +optional
-	Initialization *ClusterInitializationStatus `json:"initialization,omitempty"`
+	Initialization ClusterInitializationStatus `json:"initialization,omitempty,omitzero"`
 
 	// controlPlane groups all the observations about Cluster's ControlPlane current state.
 	// +optional
@@ -1011,8 +1011,7 @@ type ClusterStatus struct {
 
 // ClusterInitializationStatus provides observations of the Cluster initialization process.
 // NOTE: Fields in this struct are part of the Cluster API contract and are used to orchestrate initial Cluster provisioning.
-
-// ClusterInitializationStatus provides observations of the Cluster initialization process.
+// +kubebuilder:validation:MinProperties=1
 type ClusterInitializationStatus struct {
 	// infrastructureProvisioned is true when the infrastructure provider reports that Cluster's infrastructure is fully provisioned.
 	// NOTE: this field is part of the Cluster API contract, and it is used to orchestrate provisioning.

api/core/v1beta2/machine_types.go

@@ -513,7 +513,7 @@ type MachineStatus struct {
 	// 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"`
+	Initialization MachineInitializationStatus `json:"initialization,omitempty,omitzero"`
 
 	// nodeRef will point to the corresponding Node if it exists.
 	// +optional
@@ -571,6 +571,7 @@ type MachineNodeReference struct {
 
 // 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.
+// +kubebuilder:validation:MinProperties=1
 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.

api/core/v1beta2/machinepool_types.go

@@ -120,7 +120,7 @@ type MachinePoolStatus struct {
 	// initialization provides observations of the MachinePool initialization process.
 	// NOTE: Fields in this struct are part of the Cluster API contract and are used to orchestrate initial MachinePool provisioning.
 	// +optional
-	Initialization *MachinePoolInitializationStatus `json:"initialization,omitempty"`
+	Initialization MachinePoolInitializationStatus `json:"initialization,omitempty,omitzero"`
 
 	// nodeRefs will point to the corresponding Nodes if it they exist.
 	// +optional
@@ -161,6 +161,7 @@ type MachinePoolStatus struct {
 
 // MachinePoolInitializationStatus provides observations of the MachinePool initialization process.
 // NOTE: Fields in this struct are part of the Cluster API contract and are used to orchestrate initial MachinePool provisioning.
+// +kubebuilder:validation:MinProperties=1
 type MachinePoolInitializationStatus struct {
 	// infrastructureProvisioned is true when the infrastructure provider reports that MachinePool's infrastructure is fully provisioned.
 	// NOTE: this field is part of the Cluster API contract, and it is used to orchestrate provisioning.