Rebased to include upstream changes.

Update the PR to include HTTP2 settings as well. Signed-off-by: Lior Okman <lior.okman@sap.com>
envoyproxy · Aug 6, 2024 · 591ee2f · 591ee2f
1 parent 6aaaab9
commit 591ee2f
Show file tree

Hide file tree

Showing 19 changed files with 269 additions and 62 deletions.
diff --git a/api/v1alpha1/backendtrafficpolicy_types.go b/api/v1alpha1/backendtrafficpolicy_types.go
@@ -75,11 +75,6 @@ type BackendTrafficPolicySpec struct {
 	// +optional
 	// +notImplementedHide
 	Compression []*Compression `json:"compression,omitempty"`
-
-	// HTTP2 provides HTTP/2 configuration for backend connections.
-	//
-	// +optional
-	HTTP2 *HTTP2Settings `json:"http2,omitempty"`
 }
 
 // +kubebuilder:object:root=true
@@ -103,6 +98,8 @@ type BackendTrafficPolicyConnection struct {
 	BufferLimit *resource.Quantity `json:"bufferLimit,omitempty"`
 }
 
+// ClusterSettings provides the various knobs that can be set to control how traffic to a given
+// backend will be configured.
 type ClusterSettings struct {
 	// LoadBalancer policy to apply when routing traffic from the gateway to
 	// the backend endpoints
@@ -144,6 +141,11 @@ type ClusterSettings struct {
 	//
 	// +optional
 	DNS *DNS `json:"dns,omitempty"`
+
+	// HTTP2 provides HTTP/2 configuration for backend connections.
+	//
+	// +optional
+	HTTP2 *HTTP2Settings `json:"http2,omitempty"`
 }
 
 func init() {

diff --git a/api/v1alpha1/connection_types.go b/api/v1alpha1/connection_types.go
@@ -31,7 +31,8 @@ type ClientConnection struct {
 	// For example, 20Mi, 1Gi, 256Ki etc.
 	// Note that when the suffix is not provided, the value is interpreted as bytes.
 	//
-	// +kubebuilder:validation:XValidation:rule="type(self) == string ? self.matches(r\"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$\") : type(self) == int",message="socketBufferLimit must be of the format \"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$\""
+	// +kubebuilder:validation:XIntOrString
+	// +kubebuilder:vallidation:Pattern="^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$"
 	// +optional
 	// +notImplementedHide
 	SocketBufferLimit *resource.Quantity `json:"socketBufferLimit,omitempty"`
@@ -55,7 +56,8 @@ type BackendConnection struct {
 	// For example, 20Mi, 1Gi, 256Ki etc.
 	// Note that when the suffix is not provided, the value is interpreted as bytes.
 	//
-	// +kubebuilder:validation:XValidation:rule="type(self) == string ? self.matches(r\"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$\") : type(self) == int",message="socketBufferLimit must be of the format \"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$\""
+	// +kubebuilder:validation:XIntOrString
+	// +kubebuilder:validation:Pattern="^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$"
 	// +optional
 	// +notImplementedHide
 	SocketBufferLimit *resource.Quantity `json:"socketBufferLimit,omitempty"`

diff --git a/api/v1alpha1/shared_types.go b/api/v1alpha1/shared_types.go
@@ -475,6 +475,9 @@ type BackendRef struct {
 	gwapiv1.BackendObjectReference `json:",inline"`
 }
 
+// BackendCluster contains all the configuration required for configuring access
+// to a backend. This can include multiple endpoints, and settings that apply for
+// managing the connection to all these endpoints.
 type BackendCluster struct {
 	// BackendRef references a Kubernetes object that represents the
 	// backend server to which the authorization request will be sent.
@@ -513,14 +516,16 @@ 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:XValidation:rule="type(self) == string ? self.matches(r\"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$\") : type(self) == int",message="initialStreamWindowSize must be of the format \"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$\""
+	// +kubebuilder:validation:XIntOrString
+	// +kubebuilder:validation:Pattern="^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$"
 	// +optional
 	InitialStreamWindowSize *resource.Quantity `json:"initialStreamWindowSize,omitempty"`
 
 	// InitialConnectionWindowSize sets the initial window size for HTTP/2 connections.
 	// If not set, the default value is 1 MiB.
 	//
-	// +kubebuilder:validation:XValidation:rule="type(self) == string ? self.matches(r\"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$\") : type(self) == int",message="initialConnectionWindowSize must be of the format \"^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$\""
+	// +kubebuilder:validation:XIntOrString
+	// +kubebuilder:validation:Pattern="^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$"
 	// +optional
 	InitialConnectionWindowSize *resource.Quantity `json:"initialConnectionWindowSize,omitempty"`
 

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml
@@ -137,6 +137,9 @@ spec:
                       Note: that when the suffix is not provided, the value is interpreted as bytes.
                     x-kubernetes-int-or-string: true
                   socketBufferLimit:
+                    allOf:
+                    - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                    - pattern: ^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$
                     anyOf:
                     - type: integer
                     - type: string
@@ -146,12 +149,7 @@ spec:
                       SocketBufferLimit applies to socket streaming channel between TCP/IP stacks, it's in kernel space.
                       For example, 20Mi, 1Gi, 256Ki etc.
                       Note that when the suffix is not provided, the value is interpreted as bytes.
-                    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: socketBufferLimit 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
               dns:
                 description: DNS includes dns resolution settings.
@@ -455,31 +453,27 @@ spec:
                 description: HTTP2 provides HTTP/2 configuration for backend connections.
                 properties:
                   initialConnectionWindowSize:
+                    allOf:
+                    - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                    - pattern: ^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$
                     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.
-                    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: initialConnectionWindowSize 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:
+                    allOf:
+                    - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                    - pattern: ^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$
                     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).
-                    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: initialStreamWindowSize 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'
                   maxConcurrentStreams:
                     description: |-
                       MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection.

diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_clienttrafficpolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_clienttrafficpolicies.yaml
@@ -141,10 +141,6 @@ spec:
                       Note that when the suffix is not provided, the value is interpreted as bytes.
                     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: socketBufferLimit 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
               enableProxyProtocol:
                 description: |-
@@ -281,31 +277,27 @@ spec:
                 description: HTTP2 provides HTTP/2 configuration on the listener.
                 properties:
                   initialConnectionWindowSize:
+                    allOf:
+                    - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                    - pattern: ^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$
                     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.
-                    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: initialConnectionWindowSize 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:
+                    allOf:
+                    - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                    - pattern: ^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$
                     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).
-                    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: initialStreamWindowSize 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'
                   maxConcurrentStreams:
                     description: |-
                       MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection.

diff --git a/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyextensionpolicies.yaml b/charts/gateway-helm/crds/generated/gateway.envoyproxy.io_envoyextensionpolicies.yaml
@@ -285,10 +285,25 @@ spec:
                               - type: string
                               description: |-
                                 BufferLimit Soft limit on size of the cluster’s connections read and write buffers.
+                                BufferLimit applies to connection streaming (maybe non-streaming) channel between processes, it's in user space.
                                 If unspecified, an implementation defined default is applied (32768 bytes).
                                 For example, 20Mi, 1Gi, 256Ki etc.
                                 Note: that when the suffix is not provided, the value is interpreted as bytes.
                               x-kubernetes-int-or-string: true
+                            socketBufferLimit:
+                              allOf:
+                              - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                              - pattern: ^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$
+                              anyOf:
+                              - type: integer
+                              - type: string
+                              description: |-
+                                SocketBufferLimit provides configuration for the maximum buffer size in bytes for each socket
+                                to backend.
+                                SocketBufferLimit applies to socket streaming channel between TCP/IP stacks, it's in kernel space.
+                                For example, 20Mi, 1Gi, 256Ki etc.
+                                Note that when the suffix is not provided, the value is interpreted as bytes.
+                              x-kubernetes-int-or-string: true
                           type: object
                         dns:
                           description: DNS includes dns resolution settings.
@@ -547,6 +562,48 @@ spec:
                                   type: boolean
                               type: object
                           type: object
+                        http2:
+                          description: HTTP2 provides HTTP/2 configuration for backend
+                            connections.
+                          properties:
+                            initialConnectionWindowSize:
+                              allOf:
+                              - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                              - pattern: ^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$
+                              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.
+                              x-kubernetes-int-or-string: true
+                            initialStreamWindowSize:
+                              allOf:
+                              - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                              - pattern: ^[1-9]+[0-9]*([EPTGMK]i|[EPTGMk])?$
+                              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).
+                              x-kubernetes-int-or-string: true
+                            maxConcurrentStreams:
+                              description: |-
+                                MaxConcurrentStreams sets the maximum number of concurrent streams allowed per connection.
+                                If not set, the default value is 100.
+                              format: int32
+                              maximum: 2147483647
+                              minimum: 1
+                              type: integer
+                            onInvalidMessage:
+                              description: |-
+                                OnInvalidMessage determines if Envoy will terminate the connection or just the offending stream in the event of HTTP messaging error
+                                It's recommended for L2 Envoy deployments to set this value to TerminateStream.
+                                https://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/level_two
+                                Default: TerminateConnection
+                              type: string
+                          type: object
                         loadBalancer:
                           description: |-
                             LoadBalancer policy to apply when routing traffic from the gateway to