feat(hpa): add hpa dedicated labels and annotations

Signed-off-by: Grégory Sanchez <gregory.sanchez@icloud.com> Signed-off-by: Grégory SANCHEZ <gregory.sanchez@icloud.com>
kedacore · Jun 14, 2024 · 87c70da · 87c70da
1 parent 21e17d8
commit 87c70da
Show file tree

Hide file tree

Showing 6 changed files with 65 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -76,9 +76,9 @@ Here is an overview of all new **experimental** features:
 
 ### Fixes
 
+- **General**: Fix reconcile HPA when ScaledObject annotations or labels is updated ([#5468](https://github.com/kedacore/keda/issues/5468))
 - **General**: Scalers are properly closed after being refreshed ([#5806](https://github.com/kedacore/keda/issues/5806))
 - **MongoDB Scaler**:  MongoDB url parses correctly `+srv` scheme ([#5760](https://github.com/kedacore/keda/issues/5760))
-- **General**: Fix reconcile HPA when ScaledObject annotations or labels is updated ([#5468](https://github.com/kedacore/keda/issues/5468))
 
 ### Deprecations
 

diff --git a/apis/keda/v1alpha1/scaledobject_types.go b/apis/keda/v1alpha1/scaledobject_types.go
@@ -137,6 +137,14 @@ type HorizontalPodAutoscalerConfig struct {
 	Behavior *autoscalingv2.HorizontalPodAutoscalerBehavior `json:"behavior,omitempty"`
 	// +optional
 	Name string `json:"name,omitempty"`
+	// Those labels are added to the HorizontalPodAutoscaler created by KEDA
+	// and reconciled by KEDA on change
+	// +optional
+	Labels map[string]string `json:"labels,omitempty"`
+	// Those annotations are added to the HorizontalPodAutoscaler created by KEDA
+	// and reconciled by KEDA on change
+	// +optional
+	Annotations map[string]string `json:"annotations,omitempty"`
 }
 
 // ScaleTarget holds the reference to the scale target Object

diff --git a/config/crd/bases/keda.sh_scaledobjects.yaml b/config/crd/bases/keda.sh_scaledobjects.yaml
@@ -82,6 +82,13 @@ spec:
                     description: HorizontalPodAutoscalerConfig specifies horizontal
                       scale config
                     properties:
+                      annotations:
+                        additionalProperties:
+                          type: string
+                        description: |-
+                          Those annotations are added to the HorizontalPodAutoscaler created by KEDA
+                          and reconciled by KEDA on change
+                        type: object
                       behavior:
                         description: |-
                           HorizontalPodAutoscalerBehavior configures the scaling behavior of the target
@@ -197,6 +204,13 @@ spec:
                                 type: integer
                             type: object
                         type: object
+                      labels:
+                        additionalProperties:
+                          type: string
+                        description: |-
+                          Those labels are added to the HorizontalPodAutoscaler created by KEDA
+                          and reconciled by KEDA on change
+                        type: object
                       name:
                         type: string
                     type: object

diff --git a/controllers/keda/hpa.go b/controllers/keda/hpa.go
@@ -35,7 +35,7 @@ import (
 	kedacontrollerutil "github.com/kedacore/keda/v2/controllers/keda/util"
 	"github.com/kedacore/keda/v2/pkg/scaling/executor"
 	kedastatus "github.com/kedacore/keda/v2/pkg/status"
-	version "github.com/kedacore/keda/v2/version"
+	"github.com/kedacore/keda/v2/version"
 )
 
 // createAndDeployNewHPA creates and deploy HPA in the cluster for specified ScaledObject
@@ -95,9 +95,24 @@ func (r *ScaledObjectReconciler) newHPAForScaledObject(ctx context.Context, logg
 		"app.kubernetes.io/part-of":    scaledObject.Name,
 		"app.kubernetes.io/managed-by": "keda-operator",
 	}
-	for key, value := range scaledObject.ObjectMeta.Labels {
+	for key, value := range scaledObject.Labels {
 		labels[key] = value
 	}
+	if scaledObject.Spec.Advanced.HorizontalPodAutoscalerConfig.Labels != nil {
+		for key, value := range scaledObject.Spec.Advanced.HorizontalPodAutoscalerConfig.Labels {
+			labels[key] = value
+		}
+	}
+
+	annotations := map[string]string{}
+	for key, value := range scaledObject.Annotations {
+		annotations[key] = value
+	}
+	if scaledObject.Spec.Advanced.HorizontalPodAutoscalerConfig.Annotations != nil {
+		for key, value := range scaledObject.Spec.Advanced.HorizontalPodAutoscalerConfig.Annotations {
+			annotations[key] = value
+		}
+	}
 
 	minReplicas := scaledObject.GetHPAMinReplicas()
 	maxReplicas := scaledObject.GetHPAMaxReplicas()
@@ -130,7 +145,7 @@ func (r *ScaledObjectReconciler) newHPAForScaledObject(ctx context.Context, logg
 			Name:        getHPAName(scaledObject),
 			Namespace:   scaledObject.Namespace,
 			Labels:      labels,
-			Annotations: scaledObject.Annotations,
+			Annotations: annotations,
 		},
 		TypeMeta: metav1.TypeMeta{
 			APIVersion: "v2",

diff --git a/controllers/keda/scaledobject_controller.go b/controllers/keda/scaledobject_controller.go
@@ -134,8 +134,6 @@ func (r *ScaledObjectReconciler) SetupWithManager(mgr ctrl.Manager, options cont
 				kedacontrollerutil.PausedReplicasPredicate{},
 				kedacontrollerutil.ScaleObjectReadyConditionPredicate{},
 				predicate.GenerationChangedPredicate{},
-				predicate.LabelChangedPredicate{},
-				predicate.AnnotationChangedPredicate{},
 			),
 		)).
 		WithEventFilter(util.IgnoreOtherNamespaces()).

diff --git a/controllers/keda/scaledobject_controller_test.go b/controllers/keda/scaledobject_controller_test.go
@@ -1454,19 +1454,24 @@ var _ = Describe("ScaledObjectController", func() {
 		// Create the ScaledObject without specifying name.
 		so := &kedav1alpha1.ScaledObject{
 			ObjectMeta: metav1.ObjectMeta{
-				Name:      soName,
-				Namespace: "default",
-				Annotations: map[string]string{
-					"annotation-email": "email@example.com",
-					"annotation-url":   "https://example.com",
-				},
+				Name:        soName,
+				Namespace:   "default",
+				Annotations: map[string]string{},
 			},
 			Spec: kedav1alpha1.ScaledObjectSpec{
 				ScaleTargetRef: &kedav1alpha1.ScaleTarget{
 					Name: deploymentName,
 				},
 				Advanced: &kedav1alpha1.AdvancedConfig{
-					HorizontalPodAutoscalerConfig: &kedav1alpha1.HorizontalPodAutoscalerConfig{},
+					HorizontalPodAutoscalerConfig: &kedav1alpha1.HorizontalPodAutoscalerConfig{
+						Annotations: map[string]string{
+							"annotation-email": "email@example.com",
+							"annotation-url":   "https://example.com",
+						},
+						Labels: map[string]string{
+							"label-key": "label-value",
+						},
+					},
 				},
 				Triggers: []kedav1alpha1.ScaleTriggers{
 					{
@@ -1494,8 +1499,19 @@ var _ = Describe("ScaledObjectController", func() {
 			err = k8sClient.Get(context.Background(), types.NamespacedName{Name: soName, Namespace: "default"}, so)
 			Expect(err).ToNot(HaveOccurred())
 			annotations := make(map[string]string)
+			labels := make(map[string]string)
 			annotations["new-annotation"] = "new-annotation-value"
-			so.SetAnnotations(annotations)
+			labels["new-label"] = "new-label-value"
+			so := &kedav1alpha1.ScaledObject{
+				Spec: kedav1alpha1.ScaledObjectSpec{
+					Advanced: &kedav1alpha1.AdvancedConfig{
+						HorizontalPodAutoscalerConfig: &kedav1alpha1.HorizontalPodAutoscalerConfig{
+							Annotations: annotations,
+							Labels:      labels,
+						},
+					},
+				},
+			}
 			return k8sClient.Update(context.Background(), so)
 		}).WithTimeout(1 * time.Minute).WithPolling(10 * time.Second).ShouldNot(HaveOccurred())
 		testLogger.Info("annotation is set")