api for http2 settings

Signed-off-by: huabing zhao <zhaohuabing@gmail.com>

api/v1alpha1/clienttrafficpolicy_types.go

@@ -208,17 +208,13 @@ type HTTP10Settings struct {
 type HTTP2Settings struct {
 	// InitialStreamWindowSize sets the initial window size for HTTP/2 streams.
 	// If not set, the default value is 64 KiB(64*1024).
-	// +kubebuilder:validation:Minimum=65535
-	// +kubebuilder:validation:Maximum=2147483647
 	// +optional
-	InitialStreamWindowSize *uint32 `json:"initialStreamWindowSize,omitempty"`
+	InitialStreamWindowSize *Size `json:"initialStreamWindowSize,omitempty"`
 
 	// InitialConnectionWindowSize sets the initial window size for HTTP/2 connections.
 	// If not set, the default value is 1 MiB(1024*1024).
-	// +kubebuilder:validation:Minimum=65535
-	// +kubebuilder:validation:Maximum=2147483647
 	// +optional
-	InitialConnectionWindowSize *uint32 `json:"initialConnectionWindowSize,omitempty"`
+	InitialConnectionWindowSize *Size `json:"initialConnectionWindowSize,omitempty"`
 }
 
 const (

api/v1alpha1/connection_types.go

@@ -6,7 +6,6 @@
 package v1alpha1
 
 import (
-	"k8s.io/apimachinery/pkg/api/resource"
 	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
 )
 
@@ -21,9 +20,8 @@ type Connection struct {
 	// Note that when the suffix is not provided, the value is interpreted as bytes.
 	// Default: 32768 bytes.
 	//
-	// +kubebuilder:validation:XValidation:rule="type(self) == string ? self.matches(r\"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$\") : type(self) == int",message="bufferLimit must be of the format \"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$\""
 	// +optional
-	BufferLimit *resource.Quantity `json:"bufferLimit,omitempty"`
+	BufferLimit *Size `json:"bufferLimit,omitempty"`
 }
 
 type ConnectionLimit struct {

api/v1alpha1/shared_types.go

@@ -10,6 +10,7 @@ import (
 	autoscalingv2 "k8s.io/api/autoscaling/v2"
 	corev1 "k8s.io/api/core/v1"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
 	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
 )
 
@@ -424,3 +425,7 @@ type BackendRef struct {
 	// Only service Kind is supported for now.
 	gwapiv1.BackendObjectReference `json:",inline"`
 }
+
+// Size is a wrapper around resource.Quantity to provide a more descriptive name and validation.
+// +kubebuilder:validation:XValidation:rule="type(self) == string ? self.matches(r\"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$\") : type(self) == int",message="bufferLimit must be of the format \"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$\""
+type Size resource.Quantity

charts/gateway-helm/crds/generated/gateway.envoyproxy.io_clienttrafficpolicies.yaml

@@ -190,21 +190,31 @@ spec:
                 description: HTTP2 provides HTTP/2 configuration on the listener.
                 properties:
                   initialConnectionWindowSize:
+                    anyOf:
+                    - type: integer
+                    - type: string
                     description: |-
                       InitialConnectionWindowSize sets the initial window size for HTTP/2 connections.
                       If not set, the default value is 1 MiB(1024*1024).
-                    format: int32
-                    maximum: 2147483647
-                    minimum: 65535
-                    type: integer
+                    pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                    x-kubernetes-int-or-string: true
+                    x-kubernetes-validations:
+                    - message: bufferLimit must be of the format "^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$"
+                      rule: 'type(self) == string ? self.matches(r"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$")
+                        : type(self) == int'
                   initialStreamWindowSize:
+                    anyOf:
+                    - type: integer
+                    - type: string
                     description: |-
                       InitialStreamWindowSize sets the initial window size for HTTP/2 streams.
                       If not set, the default value is 64 KiB(64*1024).
-                    format: int32
-                    maximum: 2147483647
-                    minimum: 65535
-                    type: integer
+                    pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                    x-kubernetes-int-or-string: true
+                    x-kubernetes-validations:
+                    - message: bufferLimit must be of the format "^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$"
+                      rule: 'type(self) == string ? self.matches(r"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$")
+                        : type(self) == int'
                 type: object
               http3:
                 description: HTTP3 provides HTTP/3 configuration on the listener.

site/content/en/latest/api/extension_types.md

@@ -489,7 +489,7 @@ _Appears in:_
 | Field | Type | Required | Description |
 | ---   | ---  | ---      | ---         |
 | `connectionLimit` | _[ConnectionLimit](#connectionlimit)_ |  false  | ConnectionLimit defines limits related to connections |
-| `bufferLimit` | _[Quantity](#quantity)_ |  false  | BufferLimit provides configuration for the maximum buffer size in bytes for each incoming connection.<br />For example, 20Mi, 1Gi, 256Ki etc.<br />Note that when the suffix is not provided, the value is interpreted as bytes.<br />Default: 32768 bytes. |
+| `bufferLimit` | _[Size](#size)_ |  false  | BufferLimit provides configuration for the maximum buffer size in bytes for each incoming connection.<br />For example, 20Mi, 1Gi, 256Ki etc.<br />Note that when the suffix is not provided, the value is interpreted as bytes.<br />Default: 32768 bytes. |
 
 
 #### ConnectionLimit
@@ -1494,8 +1494,8 @@ _Appears in:_
 
 | Field | Type | Required | Description |
 | ---   | ---  | ---      | ---         |
-| `initialStreamWindowSize` | _integer_ |  false  | InitialStreamWindowSize sets the initial window size for HTTP/2 streams.<br />If not set, the default value is 64 KiB(64*1024). |
-| `initialConnectionWindowSize` | _integer_ |  false  | InitialConnectionWindowSize sets the initial window size for HTTP/2 connections.<br />If not set, the default value is 1 MiB(1024*1024). |
+| `initialStreamWindowSize` | _[Size](#size)_ |  false  | InitialStreamWindowSize sets the initial window size for HTTP/2 streams.<br />If not set, the default value is 64 KiB(64*1024). |
+| `initialConnectionWindowSize` | _[Size](#size)_ |  false  | InitialConnectionWindowSize sets the initial window size for HTTP/2 connections.<br />If not set, the default value is 1 MiB(1024*1024). |
 
 
 #### HTTP3Settings
@@ -2922,6 +2922,18 @@ _Appears in:_
 | `minDrainDuration` | _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#duration-v1-meta)_ |  false  | MinDrainDuration defines the minimum drain duration allowing time for endpoint deprogramming to complete.<br />If unspecified, defaults to 5 seconds. |
 
 
+#### Size
+
+_Underlying type:_ _Quantity_
+
+Size is a wrapper around resource.Quantity to provide a more descriptive name and validation.
+
+_Appears in:_
+- [Connection](#connection)
+- [HTTP2Settings](#http2settings)
+
+
+
 #### SlowStart