diff --git a/api/v1alpha1/shared_types.go b/api/v1alpha1/shared_types.go index 910f78cd3ff8..436f4001bd94 100644 --- a/api/v1alpha1/shared_types.go +++ b/api/v1alpha1/shared_types.go @@ -348,6 +348,8 @@ const ( ) // KubernetesHorizontalPodAutoscalerSpec defines Kubernetes Horizontal Pod Autoscaler settings of Envoy Proxy Deployment. +// When HPA is enabled, it is recommended that the value in `KubernetesDeploymentSpec.replicas` be removed, otherwise +// Envoy Gateway will revert back to this value everytime reconciliation occurs. // See k8s.io.autoscaling.v2.HorizontalPodAutoScalerSpec. // // +kubebuilder:validation:XValidation:message="maxReplicas cannot be less than minReplicas",rule="!has(self.minReplicas) || self.maxReplicas >= self.minReplicas" diff --git a/site/content/en/latest/api/extension_types.md b/site/content/en/latest/api/extension_types.md index 70573bdd10f1..9beaf86c9484 100644 --- a/site/content/en/latest/api/extension_types.md +++ b/site/content/en/latest/api/extension_types.md @@ -1434,7 +1434,7 @@ _Appears in:_ -KubernetesHorizontalPodAutoscalerSpec defines Kubernetes Horizontal Pod Autoscaler settings of Envoy Proxy Deployment. See k8s.io.autoscaling.v2.HorizontalPodAutoScalerSpec. +KubernetesHorizontalPodAutoscalerSpec defines Kubernetes Horizontal Pod Autoscaler settings of Envoy Proxy Deployment. When HPA is enabled, it is recommended that the value in `KubernetesDeploymentSpec.replicas` be removed, otherwise Envoy Gateway will revert back to this value everytime reconciliation occurs. See k8s.io.autoscaling.v2.HorizontalPodAutoScalerSpec. _Appears in:_ - [EnvoyProxyKubernetesProvider](#envoyproxykubernetesprovider)