feat: add observedgeneration to status object of all crds

Signed-off-by: sandert-k8s <sandert98@gmail.com>

Author: sandert-k8s

api/v1beta1/globalproxysettings_types.go

@@ -33,6 +33,13 @@ type GlobalSubject struct {
 	Name string `json:"name"`
 }
 
+// GlobalProxySettingsStatus defines the observed state of GlobalProxySettings.
+type GlobalProxySettingsStatus struct {
+	// ObservedGeneration is the most recent generation observed by the controller.
+	// +optional
+	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+}
+
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
 //+kubebuilder:resource:scope=Cluster
@@ -43,6 +50,8 @@ type GlobalProxySettings struct {
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	Spec GlobalProxySettingsSpec `json:"spec,omitempty"`
+	// +optional
+	Status GlobalProxySettingsStatus `json:"status,omitempty"`
 }
 
 //+kubebuilder:object:root=true

api/v1beta1/proxysettings_types.go

@@ -29,14 +29,24 @@ type ProxySettingSpec struct {
 	Subjects []OwnerSpec `json:"subjects"`
 }
 
+// ProxySettingStatus defines the observed state of ProxySetting.
+type ProxySettingStatus struct {
+	// ObservedGeneration is the most recent generation observed by the controller.
+	// +optional
+	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+}
+
 //+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
 
 // ProxySetting is the Schema for the proxysettings API.
 type ProxySetting struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	Spec ProxySettingSpec `json:"spec,omitempty"`
+	// +optional
+	Status ProxySettingStatus `json:"status,omitempty"`
 }
 
 //+kubebuilder:object:root=true

api/v1beta1/zz_generated.deepcopy.go

@@ -166,6 +166,15 @@ spec:
             required:
             - rules
             type: object
+          status:
+            description: GlobalProxySettingsStatus defines the observed state of GlobalProxySettings.
+            properties:
+              observedGeneration:
+                description: ObservedGeneration is the most recent generation observed
+                  by the controller.
+                format: int64
+                type: integer
+            type: object
         type: object
     served: true
     storage: true

capsule-proxy

@@ -182,6 +182,17 @@ spec:
             required:
             - subjects
             type: object
+          status:
+            description: ProxySettingStatus defines the observed state of ProxySetting.
+            properties:
+              observedGeneration:
+                description: ObservedGeneration is the most recent generation observed
+                  by the controller.
+                format: int64
+                type: integer
+            type: object
         type: object
     served: true
     storage: true
+    subresources:
+      status: {}

charts/capsule-proxy/crds/capsule.clastix.io_globalproxysettings.yaml

@@ -91,6 +91,13 @@ rules:
   - apiGroups: ["authorization.k8s.io"]
     resources: ["subjectaccessreviews"]
     verbs: ["create"]
+
+  # Allow updating status subresources for observedGeneration tracking
+  - apiGroups: ["capsule.clastix.io"]
+    resources:
+      - proxysettings/status
+      - globalproxysettings/status
+    verbs: ["update", "patch"]
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding

charts/capsule-proxy/crds/capsule.clastix.io_proxysettings.yaml

@@ -7,6 +7,7 @@ import (
 	. "github.com/onsi/gomega"
 	rbacv1 "k8s.io/api/rbac/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/kubernetes"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
@@ -68,14 +69,33 @@ var _ = Describe("GlobalProxySettings", func() {
 			},
 		}
 
-		for _, tran := range settings {
+		for _, setting := range settings {
+			s := setting
 			Eventually(func() error {
-				tran.ResourceVersion = ""
+				s.ResourceVersion = ""
 
-				return k8sClient.Create(context.TODO(), tran)
+				return k8sClient.Create(context.TODO(), s)
 			}).Should(Succeed())
 		}
 
+		// Verify observedGeneration is set after reconciliation for each created resource
+		for _, setting := range settings {
+			name := setting.GetName()
+
+			Eventually(func(g Gomega) {
+				current := &v1beta1.GlobalProxySettings{}
+				g.Expect(k8sClient.Get(context.TODO(), types.NamespacedName{Name: name}, current)).To(Succeed())
+
+				g.Expect(current.Status.ObservedGeneration).To(
+					Equal(current.GetGeneration()),
+					"expected GlobalProxySettings %q status.observedGeneration (%d) to equal metadata.generation (%d)",
+					name,
+					current.Status.ObservedGeneration,
+					current.GetGeneration(),
+				)
+			}, defaultTimeoutInterval, defaultPollInterval).Should(Succeed())
+		}
+
 		// Load Alice's kubeconfig
 		aliceClient, err = loadKubeConfig("alice")
 		Expect(err).NotTo(HaveOccurred())