Merge pull request #8819 from muraee/controlplanecomponent-observergeneartion

CNTRLPLANE-3686: feat(api,cpo): add observedGeneration to ControlPlaneComponentStatus

Author: openshift-merge-bot[bot]

api/hypershift/v1beta1/controlplanecomponent_types.go

@@ -54,7 +54,7 @@ type ControlPlaneComponentStatus struct {
 	// conditions contains details for the current state of the ControlPlane Component.
 	// If there is an error, then the Available condition will be false.
 	//
-	// Current condition types are: "Available"
+	// Current condition types are: "Available", "RolloutComplete"
 	// +optional
 	// +listType=map
 	// +listMapKey=type
@@ -72,6 +72,12 @@ type ControlPlaneComponentStatus struct {
 	// +optional
 	// +kubebuilder:validation:MaxItems=100
 	Resources []ComponentResource `json:"resources,omitempty"`
+
+	// observedGeneration reports which generation of the HostedControlPlane spec has been reconciled by this component.
+	// +optional
+	// +kubebuilder:validation:Minimum=1
+	// +kubebuilder:validation:Maximum=9007199254740992
+	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 }
 
 // +kubebuilder:object:root=true
@@ -80,9 +86,9 @@ type ControlPlaneComponentStatus struct {
 // +kubebuilder:subresource:status
 // +kubebuilder:printcolumn:name="Version",type="string",JSONPath=".status.version",description="Version"
 // +kubebuilder:printcolumn:name="Available",type="string",JSONPath=".status.conditions[?(@.type==\"Available\")].status",description="Available"
-// +kubebuilder:printcolumn:name="Progressing",type="string",JSONPath=".status.conditions[?(@.type==\"Progressing\")].status",description="Progressing"
+// +kubebuilder:printcolumn:name="RolloutComplete",type="string",JSONPath=".status.conditions[?(@.type==\"RolloutComplete\")].status",description="RolloutComplete"
 // +kubebuilder:printcolumn:name="Message",type="string",JSONPath=".status.conditions[?(@.type==\"Available\")].message",description="Message"
-// +kubebuilder:printcolumn:name="ProgressingMessage",type="string",priority=1,JSONPath=".status.conditions[?(@.type==\"Progressing\")].message",description="ProgressingMessage"
+// +kubebuilder:printcolumn:name="RolloutCompleteMessage",type="string",priority=1,JSONPath=".status.conditions[?(@.type==\"RolloutComplete\")].message",description="RolloutCompleteMessage"
 // ControlPlaneComponent specifies the state of a ControlPlane Component
 type ControlPlaneComponent struct {
 	metav1.TypeMeta `json:",inline"`

api/hypershift/v1beta1/zz_generated.featuregated-crd-manifests.yaml

@@ -25,17 +25,17 @@ spec:
       jsonPath: .status.conditions[?(@.type=="Available")].status
       name: Available
       type: string
-    - description: Progressing
-      jsonPath: .status.conditions[?(@.type=="Progressing")].status
-      name: Progressing
+    - description: RolloutComplete
+      jsonPath: .status.conditions[?(@.type=="RolloutComplete")].status
+      name: RolloutComplete
       type: string
     - description: Message
       jsonPath: .status.conditions[?(@.type=="Available")].message
       name: Message
       type: string
-    - description: ProgressingMessage
-      jsonPath: .status.conditions[?(@.type=="Progressing")].message
-      name: ProgressingMessage
+    - description: RolloutCompleteMessage
+      jsonPath: .status.conditions[?(@.type=="RolloutComplete")].message
+      name: RolloutCompleteMessage
       priority: 1
       type: string
     name: v1beta1
@@ -71,7 +71,7 @@ spec:
                   conditions contains details for the current state of the ControlPlane Component.
                   If there is an error, then the Available condition will be false.
 
-                  Current condition types are: "Available"
+                  Current condition types are: "Available", "RolloutComplete"
                 items:
                   description: Condition contains details for one aspect of the current
                     state of this API Resource.
@@ -131,6 +131,13 @@ spec:
                 x-kubernetes-list-map-keys:
                 - type
                 x-kubernetes-list-type: map
+              observedGeneration:
+                description: observedGeneration reports which generation of the HostedControlPlane
+                  spec has been reconciled by this component.
+                format: int64
+                maximum: 9007199254740992
+                minimum: 1
+                type: integer
               resources:
                 description: resources is a list of the resources reconciled by this
                   component.

api/hypershift/v1beta1/zz_generated.featuregated-crd-manifests/controlplanecomponents.hypershift.openshift.io/AAA_ungated.yaml

@@ -134,6 +134,8 @@ func (c *controlPlaneWorkload[T]) reconcileComponentStatus(cpContext ControlPlan
 		component.Status.Version = cpContext.ReleaseImageProvider.Version()
 	}
 
+	component.Status.ObservedGeneration = cpContext.HCP.Generation
+
 	return nil
 }
 

cmd/install/assets/crds/hypershift-operator/zz_generated.crd-manifests/controlplanecomponents.crd.yaml

@@ -194,11 +194,13 @@ func TestReconcileComponentStatus(t *testing.T) {
 				WithObjects(tc.deployment).
 				Build()
 
+			var hcpGeneration int64 = 5
 			cpContext := ControlPlaneContext{
 				Client: client,
 				HCP: &hyperv1.HostedControlPlane{
 					ObjectMeta: metav1.ObjectMeta{
-						Namespace: namespace,
+						Namespace:  namespace,
+						Generation: hcpGeneration,
 					},
 				},
 				ReleaseImageProvider: testutil.FakeImageProvider(),
@@ -235,6 +237,9 @@ func TestReconcileComponentStatus(t *testing.T) {
 
 			// Check version
 			g.Expect(componentStatus.Status.Version).To(Equal(tc.expectedVersion))
+
+			// Check observedGeneration is always set to the HCP generation
+			g.Expect(componentStatus.Status.ObservedGeneration).To(Equal(hcpGeneration))
 		})
 	}
 }