Restructure KCP spec.rollout fields

Signed-off-by: Stefan Büringer buringerst@vmware.com

Author: sbueringer

.golangci-kal.yml

@@ -167,7 +167,7 @@ linters:
       linters:
         - kubeapilinter
     - path: "api/controlplane/kubeadm/v1beta2"
-      text: "optionalfields: field (Spec|ObjectMeta|KubeadmConfigSpec|Remediation) is optional and should (be a pointer|have the omitempty tag)"
+      text: "optionalfields: field (Spec|ObjectMeta|KubeadmConfigSpec|Remediation|Rollout|Before) is optional and should (be a pointer|have the omitempty tag)"
       linters:
         - kubeapilinter
     - path: "api/core/v1beta2/cluster_types.go"

api/controlplane/kubeadm/v1beta1/conversion.go

@@ -169,6 +169,13 @@ func Convert_v1beta2_KubeadmControlPlaneSpec_To_v1beta1_KubeadmControlPlaneSpec(
 			return err
 		}
 	}
+	if !reflect.DeepEqual(in.Rollout.Before, controlplanev1.KubeadmControlPlaneRolloutBeforeSpec{}) {
+		out.RolloutBefore = &RolloutBefore{}
+		if in.Rollout.Before.CertificatesExpiryDays != 0 { // 0 was never a valid value
+			out.RolloutBefore.CertificatesExpiryDays = ptr.To(in.Rollout.Before.CertificatesExpiryDays)
+		}
+	}
+	out.RolloutAfter = in.Rollout.After
 
 	return nil
 }
@@ -183,6 +190,10 @@ func Convert_v1beta1_KubeadmControlPlaneSpec_To_v1beta2_KubeadmControlPlaneSpec(
 			return err
 		}
 	}
+	if in.RolloutBefore != nil && in.RolloutBefore.CertificatesExpiryDays != nil {
+		out.Rollout.Before.CertificatesExpiryDays = *in.RolloutBefore.CertificatesExpiryDays
+	}
+	out.Rollout.After = in.RolloutAfter
 
 	return nil
 }
@@ -198,6 +209,13 @@ func Convert_v1beta2_KubeadmControlPlaneTemplateResourceSpec_To_v1beta1_KubeadmC
 			return err
 		}
 	}
+	if !reflect.DeepEqual(in.Rollout.Before, controlplanev1.KubeadmControlPlaneRolloutBeforeSpec{}) {
+		out.RolloutBefore = &RolloutBefore{}
+		if in.Rollout.Before.CertificatesExpiryDays != 0 { // 0 was never a valid value
+			out.RolloutBefore.CertificatesExpiryDays = ptr.To(in.Rollout.Before.CertificatesExpiryDays)
+		}
+	}
+	out.RolloutAfter = in.Rollout.After
 
 	return nil
 }
@@ -212,6 +230,10 @@ func Convert_v1beta1_KubeadmControlPlaneTemplateResourceSpec_To_v1beta2_KubeadmC
 			return err
 		}
 	}
+	if in.RolloutBefore != nil && in.RolloutBefore.CertificatesExpiryDays != nil {
+		out.Rollout.Before.CertificatesExpiryDays = *in.RolloutBefore.CertificatesExpiryDays
+	}
+	out.Rollout.After = in.RolloutAfter
 
 	return nil
 }

api/controlplane/kubeadm/v1beta1/conversion_test.go

@@ -99,6 +99,7 @@ func KubeadmControlPlaneTemplateFuzzFuncs(_ runtimeserializer.CodecFactory) []in
 		spokeDiscovery,
 		hubKubeadmConfigSpec,
 		hubNodeRegistrationOptions,
+		spokeKubeadmControlPlaneTemplate,
 		spokeRemediationStrategy,
 		spokeKubeadmControlPlaneTemplateMachineTemplate,
 		spokeBootstrapToken,
@@ -162,6 +163,10 @@ func spokeKubeadmControlPlane(in *KubeadmControlPlane, c randfill.Continue) {
 	in.Spec.MachineTemplate.InfrastructureRef.UID = ""
 	in.Spec.MachineTemplate.InfrastructureRef.ResourceVersion = ""
 	in.Spec.MachineTemplate.InfrastructureRef.FieldPath = ""
+
+	if reflect.DeepEqual(in.Spec.RolloutBefore, &RolloutBefore{}) {
+		in.Spec.RolloutBefore = nil
+	}
 }
 
 func hubKubeadmControlPlaneStatus(in *controlplanev1.KubeadmControlPlaneStatus, c randfill.Continue) {
@@ -232,6 +237,14 @@ func spokeClusterConfiguration(in *bootstrapv1beta1.ClusterConfiguration, c rand
 	in.ClusterName = ""
 }
 
+func spokeKubeadmControlPlaneTemplate(in *KubeadmControlPlaneTemplate, c randfill.Continue) {
+	c.FillNoCustom(in)
+
+	if reflect.DeepEqual(in.Spec.Template.Spec.RolloutBefore, &RolloutBefore{}) {
+		in.Spec.Template.Spec.RolloutBefore = nil
+	}
+}
+
 func spokeRemediationStrategy(in *RemediationStrategy, c randfill.Continue) {
 	c.FillNoCustom(in)
 

api/controlplane/kubeadm/v1beta1/zz_generated.conversion.go

@@ -444,19 +444,9 @@ type KubeadmControlPlaneSpec struct {
 	// +optional
 	KubeadmConfigSpec bootstrapv1.KubeadmConfigSpec `json:"kubeadmConfigSpec,omitempty,omitzero"`
 
-	// rolloutBefore is a field to indicate a rollout should be performed
-	// if the specified criteria is met.
+	// rollout defines the rollout behavior.
 	// +optional
-	RolloutBefore *RolloutBefore `json:"rolloutBefore,omitempty"`
-
-	// rolloutAfter is a field to indicate a rollout should be performed
-	// after the specified time even if no changes have been made to the
-	// KubeadmControlPlane.
-	// Example: In the YAML the time can be specified in the RFC3339 format.
-	// To specify the rolloutAfter target as March 9, 2023, at 9 am UTC
-	// use "2023-03-09T09:00:00Z".
-	// +optional
-	RolloutAfter *metav1.Time `json:"rolloutAfter,omitempty"`
+	Rollout KubeadmControlPlaneRolloutSpec `json:"rollout,omitempty,omitzero"`
 
 	// rolloutStrategy is the RolloutStrategy to use to replace control plane machines with
 	// new ones.
@@ -540,12 +530,32 @@ type KubeadmControlPlaneMachineTemplateDeletionSpec struct {
 	NodeDeletionTimeoutSeconds *int32 `json:"nodeDeletionTimeoutSeconds,omitempty"`
 }
 
-// RolloutBefore describes when a rollout should be performed on the KCP machines.
-type RolloutBefore struct {
+// KubeadmControlPlaneRolloutSpec defines the rollout behavior.
+// +kubebuilder:validation:MinProperties=1
+type KubeadmControlPlaneRolloutSpec struct {
+	// before is a field to indicate a rollout should be performed
+	// if the specified criteria is met.
+	// +optional
+	Before KubeadmControlPlaneRolloutBeforeSpec `json:"before,omitempty,omitzero"`
+
+	// after is a field to indicate a rollout should be performed
+	// after the specified time even if no changes have been made to the
+	// KubeadmControlPlane.
+	// Example: In the YAML the time can be specified in the RFC3339 format.
+	// To specify the rolloutAfter target as March 9, 2023, at 9 am UTC
+	// use "2023-03-09T09:00:00Z".
+	// +optional
+	After *metav1.Time `json:"after,omitempty"`
+}
+
+// KubeadmControlPlaneRolloutBeforeSpec describes when a rollout should be performed on the KCP machines.
+// +kubebuilder:validation:MinProperties=1
+type KubeadmControlPlaneRolloutBeforeSpec struct {
 	// certificatesExpiryDays indicates a rollout needs to be performed if the
 	// certificates of the machine will expire within the specified days.
 	// +optional
-	CertificatesExpiryDays *int32 `json:"certificatesExpiryDays,omitempty"`
+	// +kubebuilder:validation:Minimum=7
+	CertificatesExpiryDays int32 `json:"certificatesExpiryDays,omitempty"`
 }
 
 // RolloutStrategy describes how to replace existing machines

api/controlplane/kubeadm/v1beta2/kubeadm_control_plane_types.go

@@ -95,18 +95,9 @@ type KubeadmControlPlaneTemplateResourceSpec struct {
 	// +optional
 	KubeadmConfigSpec bootstrapv1.KubeadmConfigSpec `json:"kubeadmConfigSpec,omitempty,omitzero"`
 
-	// rolloutBefore is a field to indicate a rollout should be performed
-	// if the specified criteria is met.
-	//
+	// rollout defines the rollout behavior.
 	// +optional
-	RolloutBefore *RolloutBefore `json:"rolloutBefore,omitempty"`
-
-	// rolloutAfter is a field to indicate a rollout should be performed
-	// after the specified time even if no changes have been made to the
-	// KubeadmControlPlane.
-	//
-	// +optional
-	RolloutAfter *metav1.Time `json:"rolloutAfter,omitempty"`
+	Rollout KubeadmControlPlaneRolloutSpec `json:"rollout,omitempty,omitzero"`
 
 	// rolloutStrategy is the RolloutStrategy to use to replace control plane machines with
 	// new ones.

api/controlplane/kubeadm/v1beta2/kubeadmcontrolplanetemplate_types.go

@@ -49,7 +49,7 @@ func getKubeadmControlPlane(ctx context.Context, proxy cluster.Proxy, name, name
 
 // setRolloutAfterOnKCP sets KubeadmControlPlane.spec.rolloutAfter.
 func setRolloutAfterOnKCP(ctx context.Context, proxy cluster.Proxy, name, namespace string) error {
-	patch := client.RawPatch(types.MergePatchType, []byte(fmt.Sprintf(`{"spec":{"rolloutAfter":"%v"}}`, time.Now().Format(time.RFC3339))))
+	patch := client.RawPatch(types.MergePatchType, []byte(fmt.Sprintf(`{"spec":{"rollout":{"after":"%v"}}}`, time.Now().Format(time.RFC3339))))
 	return patchKubeadmControlPlane(ctx, proxy, name, namespace, patch)
 }
 

api/controlplane/kubeadm/v1beta2/zz_generated.deepcopy.go

@@ -53,7 +53,7 @@ func (r *rollout) ObjectRestarter(ctx context.Context, proxy cluster.Proxy, ref
 		if annotations.HasPaused(kcp.GetObjectMeta()) {
 			return errors.Errorf("can't restart paused KubeadmControlPlane (remove annotation 'cluster.x-k8s.io/paused' first): %v/%v", ref.Kind, ref.Name)
 		}
-		if kcp.Spec.RolloutAfter != nil && kcp.Spec.RolloutAfter.After(time.Now()) {
+		if kcp.Spec.Rollout.After != nil && kcp.Spec.Rollout.After.After(time.Now()) {
 			return errors.Errorf("can't update KubeadmControlPlane (remove 'spec.rolloutAfter' first): %v/%v", ref.Kind, ref.Name)
 		}
 		if err := setRolloutAfterOnKCP(ctx, proxy, ref.Name, ref.Namespace); err != nil {