Clean up and fix templates

Author: sjberman

apis/v1alpha2/nginxproxy_types.go

@@ -477,8 +477,7 @@ type DaemonSetSpec struct {
 
 // HPASpec is the configuration for the Horizontal Pod Autoscaling.
 //
-// +kubebuilder:validation:XValidation:message="at least one metric must be specified when autoscaling is enabled",rule="!self.enable || (has(self.targetCPUUtilizationPercentage) || has(self.targetMemoryUtilizationPercentage) || (has(self.autoscalingTemplate) && size(self.autoscalingTemplate) > 0))"
-// +kubebuilder:validation:XValidation:message="minReplicas must be less than or equal to maxReplicas",rule="self.minReplicas <= self.maxReplicas"
+// +kubebuilder:validation:XValidation:message="minReplicas must be less than or equal to maxReplicas",rule="(!has(self.minReplicas)) || (self.minReplicas <= self.maxReplicas)"
 //
 //nolint:lll
 type HPASpec struct {
@@ -509,10 +508,10 @@ type HPASpec struct {
 	// +kubebuilder:validation:Minimum=1
 	MinReplicas *int32 `json:"minReplicas,omitempty"`
 
-	// AutoscalingTemplate configures the additional scaling option.
+	// Templates configures additional metrics options.
 	//
 	// +optional
-	AutoscalingTemplate []autoscalingv2.MetricSpec `json:"autoscalingTemplate,omitempty"`
+	Templates []autoscalingv2.MetricSpec `json:"templates,omitempty"`
 
 	// Maximum number of replicas.
 	//

apis/v1alpha2/zz_generated.deepcopy.go

@@ -264,9 +264,9 @@ The following table lists the configurable parameters of the NGINX Gateway Fabri
 | `certGenerator.ttlSecondsAfterFinished` | How long to wait after the cert generator job has finished before it is removed by the job controller. | int | `30` |
 | `clusterDomain` | The DNS cluster domain of your Kubernetes cluster. | string | `"cluster.local"` |
 | `gateways` | A list of Gateway objects. View https://gateway-api.sigs.k8s.io/reference/spec/#gateway for full Gateway reference. | list | `[]` |
-| `nginx` | The nginx section contains the configuration for all NGINX data plane deployments installed by the NGINX Gateway Fabric control plane. | object | `{"autoscaling":{"enable":false},"config":{},"container":{"hostPorts":[],"lifecycle":{},"readinessProbe":{},"resources":{},"volumeMounts":[]},"debug":false,"image":{"pullPolicy":"Always","repository":"ghcr.io/nginx/nginx-gateway-fabric/nginx","tag":"edge"},"imagePullSecret":"","imagePullSecrets":[],"kind":"deployment","nginxOneConsole":{"dataplaneKeySecretName":"","endpointHost":"agent.connect.nginx.com","endpointPort":443,"skipVerify":false},"plus":false,"pod":{},"replicas":1,"service":{"externalTrafficPolicy":"Local","loadBalancerClass":"","loadBalancerIP":"","loadBalancerSourceRanges":[],"nodePorts":[],"type":"LoadBalancer"},"usage":{"caSecretName":"","clientSSLSecretName":"","endpoint":"","resolver":"","secretName":"nplus-license","skipVerify":false}}` |
-| `nginx.autoscaling` | Autoscaling configuration for the NGINX data plane. | object | `{"enable":false}` |
-| `nginx.autoscaling.enable` | Enable or disable Horizontal Pod Autoscaler for the NGINX data plane. | bool | `false` |
+| `nginx` | The nginx section contains the configuration for all NGINX data plane deployments installed by the NGINX Gateway Fabric control plane. | object | `{"autoscaling":{"enable":true,"maxReplicas":11},"config":{},"container":{"hostPorts":[],"lifecycle":{},"readinessProbe":{},"resources":{},"volumeMounts":[]},"debug":false,"image":{"pullPolicy":"Always","repository":"ghcr.io/nginx/nginx-gateway-fabric/nginx","tag":"edge"},"imagePullSecret":"","imagePullSecrets":[],"kind":"deployment","nginxOneConsole":{"dataplaneKeySecretName":"","endpointHost":"agent.connect.nginx.com","endpointPort":443,"skipVerify":false},"plus":false,"pod":{},"replicas":1,"service":{"externalTrafficPolicy":"Local","loadBalancerClass":"","loadBalancerIP":"","loadBalancerSourceRanges":[],"nodePorts":[],"type":"LoadBalancer"},"usage":{"caSecretName":"","clientSSLSecretName":"","endpoint":"","resolver":"","secretName":"nplus-license","skipVerify":false}}` |
+| `nginx.autoscaling` | Autoscaling configuration for the NGINX data plane. | object | `{"enable":true,"maxReplicas":11}` |
+| `nginx.autoscaling.enable` | Enable or disable Horizontal Pod Autoscaler for the NGINX data plane. | bool | `true` |
 | `nginx.config` | The configuration for the data plane that is contained in the NginxProxy resource. This is applied globally to all Gateways managed by this instance of NGINX Gateway Fabric. | object | `{}` |
 | `nginx.container` | The container configuration for the NGINX container. This is applied globally to all Gateways managed by this instance of NGINX Gateway Fabric. | object | `{"hostPorts":[],"lifecycle":{},"readinessProbe":{},"resources":{},"volumeMounts":[]}` |
 | `nginx.container.hostPorts` | A list of HostPorts to expose on the host. This configuration allows containers to bind to a specific port on the host node, enabling external network traffic to reach the container directly through the host's IP address and port. Use this option when you need to expose container ports on the host for direct access, such as for debugging, legacy integrations, or when NodePort/LoadBalancer services are not suitable. Note: Using hostPort may have security and scheduling implications, as it ties pods to specific nodes and ports. | list | `[]` |
@@ -299,10 +299,10 @@ The following table lists the configurable parameters of the NGINX Gateway Fabri
 | `nginx.usage.resolver` | The nameserver used to resolve the NGINX Plus usage reporting endpoint. Used with NGINX Instance Manager. | string | `""` |
 | `nginx.usage.secretName` | The name of the Secret containing the JWT for NGINX Plus usage reporting. Must exist in the same namespace that the NGINX Gateway Fabric control plane is running in (default namespace: nginx-gateway). | string | `"nplus-license"` |
 | `nginx.usage.skipVerify` | Disable client verification of the NGINX Plus usage reporting server certificate. | bool | `false` |
-| `nginxGateway` | The nginxGateway section contains configuration for the NGINX Gateway Fabric control plane deployment. | object | `{"affinity":{},"autoscaling":{"enable":false},"config":{"logging":{"level":"info"}},"configAnnotations":{},"extraVolumeMounts":[],"extraVolumes":[],"gatewayClassAnnotations":{},"gatewayClassName":"nginx","gatewayControllerName":"gateway.nginx.org/nginx-gateway-controller","gwAPIExperimentalFeatures":{"enable":false},"image":{"pullPolicy":"Always","repository":"ghcr.io/nginx/nginx-gateway-fabric","tag":"edge"},"kind":"deployment","labels":{},"leaderElection":{"enable":true,"lockName":""},"lifecycle":{},"metrics":{"enable":true,"port":9113,"secure":false},"name":"","nodeSelector":{},"podAnnotations":{},"productTelemetry":{"enable":true},"readinessProbe":{"enable":true,"initialDelaySeconds":3,"port":8081},"replicas":1,"resources":{},"service":{"annotations":{},"labels":{}},"serviceAccount":{"annotations":{},"imagePullSecret":"","imagePullSecrets":[],"name":""},"snippetsFilters":{"enable":false},"terminationGracePeriodSeconds":30,"tolerations":[],"topologySpreadConstraints":[]}` |
+| `nginxGateway` | The nginxGateway section contains configuration for the NGINX Gateway Fabric control plane deployment. | object | `{"affinity":{},"autoscaling":{"enable":true,"maxReplicas":11},"config":{"logging":{"level":"info"}},"configAnnotations":{},"extraVolumeMounts":[],"extraVolumes":[],"gatewayClassAnnotations":{},"gatewayClassName":"nginx","gatewayControllerName":"gateway.nginx.org/nginx-gateway-controller","gwAPIExperimentalFeatures":{"enable":false},"image":{"pullPolicy":"Always","repository":"ghcr.io/nginx/nginx-gateway-fabric","tag":"edge"},"kind":"deployment","labels":{},"leaderElection":{"enable":true,"lockName":""},"lifecycle":{},"metrics":{"enable":true,"port":9113,"secure":false},"name":"","nodeSelector":{},"podAnnotations":{},"productTelemetry":{"enable":true},"readinessProbe":{"enable":true,"initialDelaySeconds":3,"port":8081},"replicas":1,"resources":{},"service":{"annotations":{},"labels":{}},"serviceAccount":{"annotations":{},"imagePullSecret":"","imagePullSecrets":[],"name":""},"snippetsFilters":{"enable":false},"terminationGracePeriodSeconds":30,"tolerations":[],"topologySpreadConstraints":[]}` |
 | `nginxGateway.affinity` | The affinity of the NGINX Gateway Fabric control plane pod. | object | `{}` |
-| `nginxGateway.autoscaling` | Autoscaling configuration for the NGINX Gateway Fabric control plane. | object | `{"enable":false}` |
-| `nginxGateway.autoscaling.enable` | Enable or disable Horizontal Pod Autoscaler for the control plane. | bool | `false` |
+| `nginxGateway.autoscaling` | Autoscaling configuration for the NGINX Gateway Fabric control plane. | object | `{"enable":true,"maxReplicas":11}` |
+| `nginxGateway.autoscaling.enable` | Enable or disable Horizontal Pod Autoscaler for the control plane. | bool | `true` |
 | `nginxGateway.config.logging.level` | Log level. | string | `"info"` |
 | `nginxGateway.configAnnotations` | Set of custom annotations for NginxGateway objects. | object | `{}` |
 | `nginxGateway.extraVolumeMounts` | extraVolumeMounts are the additional volume mounts for the nginx-gateway container. | list | `[]` |

charts/nginx-gateway-fabric/README.md

@@ -38,7 +38,7 @@ spec:
         type: Utilization
         averageUtilization: {{ . }}
   {{- end }}
-  {{- with .Values.nginxGateway.autoscalingTemplate }}
+  {{- with .Values.nginxGateway.autoscaling.templates }}
   {{- toYaml . | nindent 2 }}
   {{- end }}
   {{- with .Values.nginxGateway.autoscaling.behavior }}

charts/nginx-gateway-fabric/templates/hpa.yaml

@@ -32,9 +32,9 @@ spec:
         behavior:
           {{- toYaml .Values.nginx.autoscaling.behavior | nindent 10 }}
         {{- end }}
-        {{- if .Values.nginx.autoscalingTemplate }}
-        autoscalingTemplate:
-          {{- toYaml .Values.nginx.autoscalingTemplate | nindent 8 }}
+        {{- if .Values.nginx.autoscaling.templates }}
+        templates:
+          {{- toYaml .Values.nginx.autoscaling.templates | nindent 8 }}
         {{- end }}
       {{- end }}
       {{- if .Values.nginx.pod }}

charts/nginx-gateway-fabric/templates/nginxproxy.yaml

@@ -102,11 +102,18 @@
           "description": "Autoscaling configuration for the NGINX data plane.",
           "properties": {
             "enable": {
-              "default": false,
+              "default": true,
               "description": "Enable or disable Horizontal Pod Autoscaler for the NGINX data plane.",
               "required": [],
               "title": "enable",
               "type": "boolean"
+            },
+            "maxReplicas": {
+              "default": 11,
+              "description": "minReplicas: 1",
+              "required": [],
+              "title": "maxReplicas",
+              "type": "integer"
             }
           },
           "required": [],
@@ -662,11 +669,18 @@
           "description": "Autoscaling configuration for the NGINX Gateway Fabric control plane.",
           "properties": {
             "enable": {
-              "default": false,
+              "default": true,
               "description": "Enable or disable Horizontal Pod Autoscaler for the control plane.",
               "required": [],
               "title": "enable",
               "type": "boolean"
+            },
+            "maxReplicas": {
+              "default": 11,
+              "description": "annotations: {}\nminReplicas: 1",
+              "required": [],
+              "title": "maxReplicas",
+              "type": "integer"
             }
           },
           "required": [],

charts/nginx-gateway-fabric/values.schema.json

@@ -160,10 +160,10 @@ nginxGateway:
   # -- Autoscaling configuration for the NGINX Gateway Fabric control plane.
   autoscaling:
     # -- Enable or disable Horizontal Pod Autoscaler for the control plane.
-    enable: false
+    enable: true
     # annotations: {}
     # minReplicas: 1
-    # maxReplicas: 11
+    maxReplicas: 11
     # targetCPUUtilizationPercentage: 50
     # targetMemoryUtilizationPercentage: 50
     # behavior: {}
@@ -179,16 +179,15 @@ nginxGateway:
       #   - type: Pods
       #     value: 2
       #     periodSeconds: 60
-    # Custom or additional autoscaling metrics
-    # autoscalingTemplate: []
-      # ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-custom-metrics
-      # - type: Pods
-      #   pods:
-      #     metric:
-      #       name: container_memory_usage_bytes
-      #     target:
-      #       type: AverageValue
-      #       averageValue: "400Mi"
+    # Custom or additional autoscaling metrics. https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-custom-metrics
+    # templates: []
+    # - type: Pods
+    #   pods:
+    #     metric:
+    #       name: container_memory_usage_bytes
+    #     target:
+    #       type: AverageValue
+    #       averageValue: "400Mi"
 
   metrics:
     # -- Enable exposing metrics in the Prometheus format.
@@ -233,9 +232,9 @@ nginx:
   # -- Autoscaling configuration for the NGINX data plane.
   autoscaling:
     # -- Enable or disable Horizontal Pod Autoscaler for the NGINX data plane.
-    enable: false
+    enable: true
     # minReplicas: 1
-    # maxReplicas: 11
+    maxReplicas: 11
     # targetCPUUtilizationPercentage: 50
     # targetMemoryUtilizationPercentage: 50
     # behavior: {}
@@ -251,16 +250,15 @@ nginx:
       #   - type: Pods
       #     value: 2
       #     periodSeconds: 60
-    # Custom or additional autoscaling metrics
-    # autoscalingTemplate: []
-      # ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-custom-metrics
-      # - type: Pods
-      #   pods:
-      #     metric:
-      #       name: nginx_gateway_fabric_nginx_process_requests_total
-      #     target:
-      #       type: nginx_http_requests_total
-      #       averageValue: 400
+    # Custom or additional autoscaling metrics. https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-custom-metrics
+    # templates: []
+    # - type: Pods
+    #   pods:
+    #     metric:
+    #       name: nginx_gateway_fabric_nginx_process_requests_total
+    #     target:
+    #       type: AverageValue
+    #       averageValue: 400
   image:
     # -- The NGINX image to use.
     repository: ghcr.io/nginx/nginx-gateway-fabric/nginx