Add support to customize HPA name (kedacore#768)

sbarnesthornton · Jun 20, 2022 · 8d748b9 · 8d748b9
1 parent de11b10
commit 8d748b9
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/content/docs/2.8/concepts/scaling-deployments.md b/content/docs/2.8/concepts/scaling-deployments.md
@@ -55,6 +55,7 @@ spec:
   advanced:                                          # Optional. Section to specify advanced options
     restoreToOriginalReplicaCount: true/false        # Optional. Default: false
     horizontalPodAutoscalerConfig:                   # Optional. Section to specify HPA related options
+      name: {name-of-hpa-resource}                   # Optional. Default: keda-hpa-{scaled-object-name}
       behavior:                                      # Optional. Use to modify HPA's scaling behavior
         scaleDown:
           stabilizationWindowSeconds: 300
@@ -175,6 +176,7 @@ For example a `Deployment` with `3 replicas` is created, then `ScaledObject` is
 ```yaml
 advanced:
   horizontalPodAutoscalerConfig:                   # Optional. Section to specify HPA related options
+    name: {name-of-hpa-resource}                   # Optional. Default: keda-hpa-{scaled-object-name}
     behavior:                                      # Optional. Use to modify HPA's scaling behavior
       scaleDown:
         stabilizationWindowSeconds: 300
@@ -186,6 +188,10 @@ advanced:
 
 **`horizontalPodAutoscalerConfig:`**
 
+**`horizontalPodAutoscalerConfig.name`:**
+
+The name of the HPA resource KEDA will create. By default it's `keda-hpa-{scaled-object-name}`
+
 **`horizontalPodAutoscalerConfig.behavior`:**
 
 Starting from Kubernetes v1.18 the autoscaling API allows scaling behavior to be configured through the HPA behavior field. This way one can directly affect scaling of 1<->N replicas, which is internally being handled by HPA. KEDA would feed values from this section directly to the HPA's `behavior` field. Please follow [Kubernetes documentation](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#configurable-scaling-behavior) for details.