Code Review

Author: nowjean

apis/v1alpha2/nginxproxy_types.go

@@ -468,10 +468,10 @@ type DaemonSetSpec struct {
 
 // HPASpec is the configuration for the Horizontal Pod Autoscaling.
 //
-// +kubebuilder:message="at least one metric must be specified when autoscaling is enabled",rule="!self.enabled || (has(self.targetCPUUtilizationPercentage) || has(self.targetMemoryUtilizationPercentage) || (has(self.autoscalingTemplate) && size(self.autoscalingTemplate) > 0))"
-// +kubebuilder:message="minReplicas must be less than or equal to maxReplicas",rule="self.minReplicas <= self.maxReplicas"
-// +kubebuilder:message="CPU utilization must be between 1 and 100",rule="!has(self.targetCPUUtilizationPercentage) || (self.targetCPUUtilizationPercentage >= 1 && self.targetCPUUtilizationPercentage <= 100)"
-// +kubebuilder:message="memory utilization must be between 1 and 100",rule="!has(self.targetMemoryUtilizationPercentage) || (self.targetMemoryUtilizationPercentage >= 1 && self.targetMemoryUtilizationPercentage <= 100)"
+// +kubebuilder:validation:XValidation:message="at least one metric must be specified when autoscaling is enabled",rule="!self.enabled || (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="CPU utilization must be between 1 and 100",rule="!has(self.targetCPUUtilizationPercentage) || (self.targetCPUUtilizationPercentage >= 1 && self.targetCPUUtilizationPercentage <= 100)"
+// +kubebuilder:validation:XValidation:message="memory utilization must be between 1 and 100",rule="!has(self.targetMemoryUtilizationPercentage) || (self.targetMemoryUtilizationPercentage >= 1 && self.targetMemoryUtilizationPercentage <= 100)"
 //
 //nolint:lll
 type HPASpec struct {

charts/nginx-gateway-fabric/README.md

@@ -269,7 +269,7 @@ The following table lists the configurable parameters of the NGINX Gateway Fabri
 | `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 | `[]` |
 | `nginx.container.lifecycle` | The lifecycle of the NGINX container. | object | `{}` |
-| `nginx.container.resources` | The resource requirements of the NGINX container. You should be set this value, If you want to use dataplane Autoscaling(HPA). | object | `{}` |
+| `nginx.container.resources` | The resource requirements of the NGINX container. You should set this value if you want to use dataplane Autoscaling(HPA). | object | `{}` |
 | `nginx.container.volumeMounts` | volumeMounts are the additional volume mounts for the NGINX container. | list | `[]` |
 | `nginx.debug` | Enable debugging for NGINX. Uses the nginx-debug binary. The NGINX error log level should be set to debug in the NginxProxy resource. | bool | `false` |
 | `nginx.image.repository` | The NGINX image to use. | string | `"ghcr.io/nginx/nginx-gateway-fabric/nginx"` |

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

@@ -380,7 +380,7 @@
               "type": "object"
             },
             "resources": {
-              "description": "The resource requirements of the NGINX container. You should be set this value, If you want to use dataplane Autoscaling(HPA).",
+              "description": "The resource requirements of the NGINX container. You should set this value if you want to use dataplane Autoscaling(HPA).",
               "required": [],
               "title": "resources",
               "type": "object"

charts/nginx-gateway-fabric/values.yaml

@@ -184,10 +184,10 @@ nginxGateway:
   # - type: Pods
   #   pods:
   #     metric:
-  #       name: nginx_gateway_fabric_nginx_process_requests_total
+  #       name: http_requests
   #     target:
   #       type: AverageValue
-  #       averageValue: 10000m
+  #       averageValue: "100"
 
   metrics:
     # -- Enable exposing metrics in the Prometheus format.
@@ -494,7 +494,7 @@ nginx:
     # - port: 80
     #   containerPort: 80
 
-    # -- The resource requirements of the NGINX container. You should be set this value, If you want to use dataplane Autoscaling(HPA).
+    # -- The resource requirements of the NGINX container. You should set this value if you want to use dataplane Autoscaling(HPA).
     resources: {}
 
     # -- The lifecycle of the NGINX container.

config/crd/bases/gateway.nginx.org_nginxproxies.yaml

@@ -4192,6 +4192,20 @@ spec:
                         - enabled
                         - maxReplicas
                         type: object
+                        x-kubernetes-validations:
+                        - message: at least one metric must be specified when autoscaling
+                            is enabled
+                          rule: '!self.enabled || (has(self.targetCPUUtilizationPercentage)
+                            || has(self.targetMemoryUtilizationPercentage) || (has(self.autoscalingTemplate)
+                            && size(self.autoscalingTemplate) > 0))'
+                        - message: minReplicas must be less than or equal to maxReplicas
+                          rule: self.minReplicas <= self.maxReplicas
+                        - message: CPU utilization must be between 1 and 100
+                          rule: '!has(self.targetCPUUtilizationPercentage) || (self.targetCPUUtilizationPercentage
+                            >= 1 && self.targetCPUUtilizationPercentage <= 100)'
+                        - message: memory utilization must be between 1 and 100
+                          rule: '!has(self.targetMemoryUtilizationPercentage) || (self.targetMemoryUtilizationPercentage
+                            >= 1 && self.targetMemoryUtilizationPercentage <= 100)'
                       container:
                         description: Container defines container fields for the NGINX
                           container.

deploy/crds.yaml

@@ -4777,6 +4777,20 @@ spec:
                         - enabled
                         - maxReplicas
                         type: object
+                        x-kubernetes-validations:
+                        - message: at least one metric must be specified when autoscaling
+                            is enabled
+                          rule: '!self.enabled || (has(self.targetCPUUtilizationPercentage)
+                            || has(self.targetMemoryUtilizationPercentage) || (has(self.autoscalingTemplate)
+                            && size(self.autoscalingTemplate) > 0))'
+                        - message: minReplicas must be less than or equal to maxReplicas
+                          rule: self.minReplicas <= self.maxReplicas
+                        - message: CPU utilization must be between 1 and 100
+                          rule: '!has(self.targetCPUUtilizationPercentage) || (self.targetCPUUtilizationPercentage
+                            >= 1 && self.targetCPUUtilizationPercentage <= 100)'
+                        - message: memory utilization must be between 1 and 100
+                          rule: '!has(self.targetMemoryUtilizationPercentage) || (self.targetMemoryUtilizationPercentage
+                            >= 1 && self.targetMemoryUtilizationPercentage <= 100)'
                       container:
                         description: Container defines container fields for the NGINX
                           container.