feat add query parameter to lb hash policy (#7428)

rename queryParam to queryParams

Signed-off-by: i.makarychev <[email protected]>
Co-authored-by: i.makarychev <[email protected]>

Author: Inode1

api/v1alpha1/loadbalancer_types.go

@@ -72,12 +72,14 @@ const (
 // +kubebuilder:validation:XValidation:rule="self.type == 'Header' ? has(self.header) : !has(self.header)",message="If consistent hash type is header, the header field must be set."
 // +kubebuilder:validation:XValidation:rule="self.type == 'Headers' ? has(self.headers) : !has(self.headers)",message="If consistent hash type is headers, the headers field must be set."
 // +kubebuilder:validation:XValidation:rule="self.type == 'Cookie' ? has(self.cookie) : !has(self.cookie)",message="If consistent hash type is cookie, the cookie field must be set."
+// +kubebuilder:validation:XValidation:rule="self.type == 'QueryParams' ? has(self.queryParams) : !has(self.queryParams)",message="If consistent hash type is queryParams, the queryParams field must be set."
 type ConsistentHash struct {
 	// ConsistentHashType defines the type of input to hash on. Valid Type values are
 	// "SourceIP",
 	// "Header",
 	// "Headers",
 	// "Cookie".
+	// "QueryParams".
 	//
 	// +unionDiscriminator
 	Type ConsistentHashType `json:"type"`
@@ -98,6 +100,11 @@ type ConsistentHash struct {
 	// +optional
 	Cookie *Cookie `json:"cookie,omitempty"`
 
+	// QueryParams configures the query parameter hash policy when the consistent hash type is set to QueryParams.
+	//
+	// +optional
+	QueryParams []*QueryParam `json:"queryParams,omitempty"`
+
 	// The table size for consistent hashing, must be prime number limited to 5000011.
 	//
 	// +kubebuilder:validation:Minimum=2
@@ -114,6 +121,13 @@ type Header struct {
 	Name string `json:"name"`
 }
 
+// QueryParam defines the query parameter name hashing configuration for consistent hash based
+// load balancing.
+type QueryParam struct {
+	// Name of the query param to hash.
+	Name string `json:"name"`
+}
+
 // Cookie defines the cookie hashing configuration for consistent hash based
 // load balancing.
 type Cookie struct {
@@ -135,7 +149,7 @@ type Cookie struct {
 }
 
 // ConsistentHashType defines the type of input to hash on.
-// +kubebuilder:validation:Enum=SourceIP;Header;Headers;Cookie
+// +kubebuilder:validation:Enum=SourceIP;Header;Headers;Cookie;QueryParams
 type ConsistentHashType string
 
 const (
@@ -149,6 +163,8 @@ const (
 	HeadersConsistentHashType ConsistentHashType = "Headers"
 	// CookieConsistentHashType hashes based on a cookie.
 	CookieConsistentHashType ConsistentHashType = "Cookie"
+	// QueryParamsConsistentHashType hashes based on a multiple query parameter.
+	QueryParamsConsistentHashType ConsistentHashType = "QueryParams"
 )
 
 // SlowStart defines the configuration related to the slow start load balancer policy.

api/v1alpha1/zz_generated.deepcopy.go

@@ -737,6 +737,21 @@ spec:
                           - name
                           type: object
                         type: array
+                      queryParams:
+                        description: QueryParams configures the query parameter hash
+                          policy when the consistent hash type is set to QueryParams.
+                        items:
+                          description: |-
+                            QueryParam defines the query parameter name hashing configuration for consistent hash based
+                            load balancing.
+                          properties:
+                            name:
+                              description: Name of the query param to hash.
+                              type: string
+                          required:
+                          - name
+                          type: object
+                        type: array
                       tableSize:
                         default: 65537
                         description: The table size for consistent hashing, must be
@@ -752,11 +767,13 @@ spec:
                           "Header",
                           "Headers",
                           "Cookie".
+                          "QueryParams".
                         enum:
                         - SourceIP
                         - Header
                         - Headers
                         - Cookie
+                        - QueryParams
                         type: string
                     required:
                     - type
@@ -771,6 +788,10 @@ spec:
                     - message: If consistent hash type is cookie, the cookie field
                         must be set.
                       rule: 'self.type == ''Cookie'' ? has(self.cookie) : !has(self.cookie)'
+                    - message: If consistent hash type is queryParams, the queryParams
+                        field must be set.
+                      rule: 'self.type == ''QueryParams'' ? has(self.queryParams)
+                        : !has(self.queryParams)'
                   endpointOverride:
                     description: |-
                       EndpointOverride defines the configuration for endpoint override.

charts/gateway-crds-helm/templates/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml

@@ -796,6 +796,22 @@ spec:
                                     - name
                                     type: object
                                   type: array
+                                queryParams:
+                                  description: QueryParams configures the query parameter
+                                    hash policy when the consistent hash type is set
+                                    to QueryParams.
+                                  items:
+                                    description: |-
+                                      QueryParam defines the query parameter name hashing configuration for consistent hash based
+                                      load balancing.
+                                    properties:
+                                      name:
+                                        description: Name of the query param to hash.
+                                        type: string
+                                    required:
+                                    - name
+                                    type: object
+                                  type: array
                                 tableSize:
                                   default: 65537
                                   description: The table size for consistent hashing,
@@ -811,11 +827,13 @@ spec:
                                     "Header",
                                     "Headers",
                                     "Cookie".
+                                    "QueryParams".
                                   enum:
                                   - SourceIP
                                   - Header
                                   - Headers
                                   - Cookie
+                                  - QueryParams
                                   type: string
                               required:
                               - type
@@ -833,6 +851,10 @@ spec:
                                   field must be set.
                                 rule: 'self.type == ''Cookie'' ? has(self.cookie)
                                   : !has(self.cookie)'
+                              - message: If consistent hash type is queryParams, the
+                                  queryParams field must be set.
+                                rule: 'self.type == ''QueryParams'' ? has(self.queryParams)
+                                  : !has(self.queryParams)'
                             endpointOverride:
                               description: |-
                                 EndpointOverride defines the configuration for endpoint override.