🌱 Add v1beta2 conditions to ExtensionConfig (#11848)

* Add v1beta2 conditions to ExtensionConfig

* Address comments

Author: fabriziopandini

config/crd/bases/runtime.cluster.x-k8s.io_extensionconfigs.yaml

@@ -112,6 +112,22 @@ type ExtensionConfigStatus struct {
 	// conditions define the current service state of the ExtensionConfig.
 	// +optional
 	Conditions clusterv1.Conditions `json:"conditions,omitempty"`
+
+	// v1beta2 groups all the fields that will be added or modified in ExtensionConfig's status with the V1Beta2 version.
+	// +optional
+	V1Beta2 *ExtensionConfigV1Beta2Status `json:"v1beta2,omitempty"`
+}
+
+// ExtensionConfigV1Beta2Status groups all the fields that will be added or modified in ExtensionConfig with the V1Beta2 version.
+// See https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more context.
+type ExtensionConfigV1Beta2Status struct {
+	// conditions represents the observations of a ExtensionConfig's current state.
+	// Known condition types are Discovered, Paused.
+	// +optional
+	// +listType=map
+	// +listMapKey=type
+	// +kubebuilder:validation:MaxItems=32
+	Conditions []metav1.Condition `json:"conditions,omitempty"`
 }
 
 // ExtensionHandler specifies the details of a handler for a particular runtime hook registered by an Extension server.
@@ -187,6 +203,22 @@ func (e *ExtensionConfig) SetConditions(conditions clusterv1.Conditions) {
 	e.Status.Conditions = conditions
 }
 
+// GetV1Beta2Conditions returns the set of conditions for this object.
+func (e *ExtensionConfig) GetV1Beta2Conditions() []metav1.Condition {
+	if e.Status.V1Beta2 == nil {
+		return nil
+	}
+	return e.Status.V1Beta2.Conditions
+}
+
+// SetV1Beta2Conditions sets conditions for an API object.
+func (e *ExtensionConfig) SetV1Beta2Conditions(conditions []metav1.Condition) {
+	if e.Status.V1Beta2 == nil {
+		e.Status.V1Beta2 = &ExtensionConfigV1Beta2Status{}
+	}
+	e.Status.V1Beta2.Conditions = conditions
+}
+
 // +kubebuilder:object:root=true
 
 // ExtensionConfigList contains a list of ExtensionConfig.
@@ -200,6 +232,18 @@ func init() {
 	objectTypes = append(objectTypes, &ExtensionConfig{}, &ExtensionConfigList{})
 }
 
+// ExtensionConfig's Discovered conditions and corresponding reasons that will be used in v1Beta2 API version.
+const (
+	// ExtensionConfigDiscoveredV1Beta2Condition is true if the runtime extension has been successfully discovered.
+	ExtensionConfigDiscoveredV1Beta2Condition = "Discovered"
+
+	// ExtensionConfigDiscoveredV1Beta2Reason surfaces that the runtime extension has been successfully discovered.
+	ExtensionConfigDiscoveredV1Beta2Reason = "Discovered"
+
+	// ExtensionConfigNotDiscoveredV1Beta2Reason surfaces that the runtime extension has not been successfully discovered.
+	ExtensionConfigNotDiscoveredV1Beta2Reason = "NotDiscovered"
+)
+
 const (
 	// RuntimeExtensionDiscoveredCondition is a condition set on an ExtensionConfig object once it has been discovered by the Runtime SDK client.
 	RuntimeExtensionDiscoveredCondition clusterv1.ConditionType = "Discovered"

exp/runtime/api/v1alpha1/extensionconfig_types.go

@@ -39,9 +39,10 @@ import (
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	runtimev1 "sigs.k8s.io/cluster-api/exp/runtime/api/v1alpha1"
 	runtimeclient "sigs.k8s.io/cluster-api/exp/runtime/client"
-	"sigs.k8s.io/cluster-api/util/annotations"
 	"sigs.k8s.io/cluster-api/util/conditions"
+	v1beta2conditions "sigs.k8s.io/cluster-api/util/conditions/v1beta2"
 	"sigs.k8s.io/cluster-api/util/patch"
+	"sigs.k8s.io/cluster-api/util/paused"
 	"sigs.k8s.io/cluster-api/util/predicates"
 )
 
@@ -84,7 +85,7 @@ func (r *Reconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager, opt
 			predicates.TypedResourceIsChanged[*metav1.PartialObjectMetadata](mgr.GetScheme(), predicateLog),
 		)).
 		WithOptions(options).
-		WithEventFilter(predicates.ResourceNotPausedAndHasFilterLabel(mgr.GetScheme(), predicateLog, r.WatchFilterValue)).
+		WithEventFilter(predicates.ResourceHasFilterLabel(mgr.GetScheme(), predicateLog, r.WatchFilterValue)).
 		Complete(r)
 	if err != nil {
 		return errors.Wrap(err, "failed setting up with a controller manager")
@@ -131,10 +132,8 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
 		return ctrl.Result{}, err
 	}
 
-	// Return early if the ExtensionConfig is paused.
-	if annotations.HasPaused(extensionConfig) {
-		log.Info("Reconciliation is paused for this object")
-		return ctrl.Result{}, nil
+	if isPaused, conditionChanged, err := paused.EnsurePausedCondition(ctx, r.Client, nil, extensionConfig); err != nil || isPaused || conditionChanged {
+		return ctrl.Result{}, err
 	}
 
 	// Handle deletion reconciliation loop.
@@ -179,9 +178,14 @@ func patchExtensionConfig(ctx context.Context, client client.Client, original, m
 		return err
 	}
 
-	options = append(options, patch.WithOwnedConditions{Conditions: []clusterv1.ConditionType{
-		runtimev1.RuntimeExtensionDiscoveredCondition,
-	}})
+	options = append(options,
+		patch.WithOwnedConditions{Conditions: []clusterv1.ConditionType{
+			runtimev1.RuntimeExtensionDiscoveredCondition,
+		}},
+		patch.WithOwnedV1Beta2Conditions{Conditions: []string{
+			runtimev1.ExtensionConfigDiscoveredV1Beta2Condition,
+		}},
+	)
 	return patchHelper.Patch(ctx, modified, options...)
 }
 
@@ -226,11 +230,22 @@ func discoverExtensionConfig(ctx context.Context, runtimeClient runtimeclient.Cl
 	discoveredExtension, err := runtimeClient.Discover(ctx, extensionConfig.DeepCopy())
 	if err != nil {
 		modifiedExtensionConfig := extensionConfig.DeepCopy()
-		conditions.MarkFalse(modifiedExtensionConfig, runtimev1.RuntimeExtensionDiscoveredCondition, runtimev1.DiscoveryFailedReason, clusterv1.ConditionSeverityError, "error in discovery: %v", err)
+		conditions.MarkFalse(modifiedExtensionConfig, runtimev1.RuntimeExtensionDiscoveredCondition, runtimev1.DiscoveryFailedReason, clusterv1.ConditionSeverityError, "Error in discovery: %v", err)
+		v1beta2conditions.Set(modifiedExtensionConfig, metav1.Condition{
+			Type:    runtimev1.ExtensionConfigDiscoveredV1Beta2Condition,
+			Status:  metav1.ConditionFalse,
+			Reason:  runtimev1.ExtensionConfigNotDiscoveredV1Beta2Reason,
+			Message: fmt.Sprintf("Error in discovery: %v", err),
+		})
 		return modifiedExtensionConfig, errors.Wrapf(err, "failed to discover ExtensionConfig %s", klog.KObj(extensionConfig))
 	}
 
 	conditions.MarkTrue(discoveredExtension, runtimev1.RuntimeExtensionDiscoveredCondition)
+	v1beta2conditions.Set(discoveredExtension, metav1.Condition{
+		Type:   runtimev1.ExtensionConfigDiscoveredV1Beta2Condition,
+		Status: metav1.ConditionTrue,
+		Reason: runtimev1.ExtensionConfigDiscoveredV1Beta2Reason,
+	})
 	return discoveredExtension, nil
 }
 

exp/runtime/api/v1alpha1/zz_generated.deepcopy.go

@@ -106,7 +106,10 @@ func TestExtensionReconciler_Reconcile(t *testing.T) {
 		}
 		g.Expect(warmup.Start(ctx)).To(Succeed())
 
-		// Reconcile the extension and assert discovery has succeeded.
+		// Reconcile the extension and assert discovery has succeeded (the first reconcile adds Paused).
+		_, err = r.Reconcile(ctx, ctrl.Request{NamespacedName: util.ObjectKey(extensionConfig)})
+		g.Expect(err).ToNot(HaveOccurred())
+
 		_, err = r.Reconcile(ctx, ctrl.Request{NamespacedName: util.ObjectKey(extensionConfig)})
 		g.Expect(err).ToNot(HaveOccurred())
 
@@ -124,6 +127,13 @@ func TestExtensionReconciler_Reconcile(t *testing.T) {
 		g.Expect(conditions).To(HaveLen(1))
 		g.Expect(conditions[0].Status).To(Equal(corev1.ConditionTrue))
 		g.Expect(conditions[0].Type).To(Equal(runtimev1.RuntimeExtensionDiscoveredCondition))
+
+		v1beta2Conditions := config.GetV1Beta2Conditions()
+		g.Expect(v1beta2Conditions).To(HaveLen(2)) // Second condition is paused.
+		g.Expect(v1beta2Conditions[0].Type).To(Equal(runtimev1.ExtensionConfigDiscoveredV1Beta2Condition))
+		g.Expect(v1beta2Conditions[0].Status).To(Equal(metav1.ConditionTrue))
+		g.Expect(v1beta2Conditions[0].Reason).To(Equal(runtimev1.ExtensionConfigDiscoveredV1Beta2Reason))
+
 		_, err = registry.Get("first.ext1")
 		g.Expect(err).ToNot(HaveOccurred())
 		_, err = registry.Get("second.ext1")
@@ -159,7 +169,10 @@ func TestExtensionReconciler_Reconcile(t *testing.T) {
 			return nil
 		}, 30*time.Second, 100*time.Millisecond).Should(Succeed())
 
-		// Reconcile the extension and assert discovery has succeeded.
+		// Reconcile the extension and assert discovery has succeeded  (the first reconcile adds Paused).
+		_, err = r.Reconcile(ctx, ctrl.Request{NamespacedName: util.ObjectKey(extensionConfig)})
+		g.Expect(err).ToNot(HaveOccurred())
+
 		_, err = r.Reconcile(ctx, ctrl.Request{NamespacedName: util.ObjectKey(extensionConfig)})
 		g.Expect(err).ToNot(HaveOccurred())
 
@@ -176,6 +189,12 @@ func TestExtensionReconciler_Reconcile(t *testing.T) {
 		g.Expect(conditions[0].Status).To(Equal(corev1.ConditionTrue))
 		g.Expect(conditions[0].Type).To(Equal(runtimev1.RuntimeExtensionDiscoveredCondition))
 
+		v1beta2Conditions := config.GetV1Beta2Conditions()
+		g.Expect(v1beta2Conditions).To(HaveLen(2)) // Second condition is paused.
+		g.Expect(v1beta2Conditions[0].Type).To(Equal(runtimev1.ExtensionConfigDiscoveredV1Beta2Condition))
+		g.Expect(v1beta2Conditions[0].Status).To(Equal(metav1.ConditionTrue))
+		g.Expect(v1beta2Conditions[0].Reason).To(Equal(runtimev1.ExtensionConfigDiscoveredV1Beta2Reason))
+
 		_, err = registry.Get("first.ext1")
 		g.Expect(err).ToNot(HaveOccurred())
 		_, err = registry.Get("third.ext1")
@@ -236,6 +255,12 @@ func TestExtensionReconciler_discoverExtensionConfig(t *testing.T) {
 		g.Expect(conditions).To(HaveLen(1))
 		g.Expect(conditions[0].Status).To(Equal(corev1.ConditionTrue))
 		g.Expect(conditions[0].Type).To(Equal(runtimev1.RuntimeExtensionDiscoveredCondition))
+
+		v1beta2Conditions := discoveredExtensionConfig.GetV1Beta2Conditions()
+		g.Expect(v1beta2Conditions).To(HaveLen(1))
+		g.Expect(v1beta2Conditions[0].Type).To(Equal(runtimev1.ExtensionConfigDiscoveredV1Beta2Condition))
+		g.Expect(v1beta2Conditions[0].Status).To(Equal(metav1.ConditionTrue))
+		g.Expect(v1beta2Conditions[0].Reason).To(Equal(runtimev1.ExtensionConfigDiscoveredV1Beta2Reason))
 	})
 	t.Run("fail discovery for non-running extension", func(*testing.T) {
 		cat := runtimecatalog.New()
@@ -269,6 +294,12 @@ func TestExtensionReconciler_discoverExtensionConfig(t *testing.T) {
 		g.Expect(conditions).To(HaveLen(1))
 		g.Expect(conditions[0].Status).To(Equal(corev1.ConditionFalse))
 		g.Expect(conditions[0].Type).To(Equal(runtimev1.RuntimeExtensionDiscoveredCondition))
+
+		v1beta2Conditions := discoveredExtensionConfig.GetV1Beta2Conditions()
+		g.Expect(v1beta2Conditions).To(HaveLen(1))
+		g.Expect(v1beta2Conditions[0].Type).To(Equal(runtimev1.ExtensionConfigDiscoveredV1Beta2Condition))
+		g.Expect(v1beta2Conditions[0].Status).To(Equal(metav1.ConditionFalse))
+		g.Expect(v1beta2Conditions[0].Reason).To(Equal(runtimev1.ExtensionConfigNotDiscoveredV1Beta2Reason))
 	})
 }