Skip to content

Commit

Permalink
fix(policies): use GatewayAPI style header modifier in all policies (#…
Browse files Browse the repository at this point in the history 
…5757)

MeshHealthCheck and MeshRateLimit didn't adopt the same style of
headers.
Update MeshRetry to ensure Pascal case for Type value and add 
Present and Absent as types.

This is important for api coherency.

Fix #5712

Signed-off-by: Charly Molter <charly.molter@konghq.com>
  • Loading branch information
@lahabana
lahabana authored Jan 20, 2023
1 parent 9019ccc commit b092559
Show file tree
Hide file tree
Showing 42 changed files with 1,518 additions and 671 deletions.
8 changes: 8 additions & 0 deletions api/common/v1alpha1/header.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package v1alpha1

// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=256
// +kubebuilder:validation:Pattern=`^[a-z0-9!#$%&'*+\-.^_\x60|~]+$`
type HeaderName string

type HeaderValue string
16 changes: 0 additions & 16 deletions api/common/v1alpha1/headermatch.go
View file

This file was deleted.

179 changes: 134 additions & 45 deletions app/kumactl/cmd/install/testdata/install-control-plane.defaults.golden.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -885,24 +885,46 @@ spec:
requestHeadersToAdd:
description: The list of HTTP headers which should be
added to each health check request
items:
properties:
append:
default: true
description: If true (default) the header values
should be appended to already present ones
type: boolean
key:
description: Header name
type: string
value:
description: Header value
type: string
required:
- key
- value
type: object
type: array
properties:
add:
items:
properties:
name:
maxLength: 256
minLength: 1
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
value:
type: string
required:
- name
- value
type: object
maxItems: 16
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
set:
items:
properties:
name:
maxLength: 256
minLength: 1
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
value:
type: string
required:
- name
- value
type: object
maxItems: 16
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
type: object
type: object
initialJitter:
description: If specified, Envoy will start health checking
Expand Down Expand Up @@ -1146,7 +1168,7 @@ spec:
name:
maxLength: 256
minLength: 1
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
value:
type: string
Expand All @@ -1170,7 +1192,7 @@ spec:
name:
maxLength: 256
minLength: 1
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
value:
type: string
Expand Down Expand Up @@ -1240,7 +1262,7 @@ spec:
name:
maxLength: 256
minLength: 1
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
value:
type: string
Expand All @@ -1264,7 +1286,7 @@ spec:
name:
maxLength: 256
minLength: 1
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
value:
type: string
Expand Down Expand Up @@ -1872,23 +1894,46 @@ spec:
headers:
description: The Headers to be added to the
HTTP response on a rate limit event
items:
properties:
append:
default: true
description: Should the header be appended
type: boolean
key:
description: Header name
type: string
value:
description: Header value
type: string
required:
- key
- value
type: object
type: array
properties:
add:
items:
properties:
name:
maxLength: 256
minLength: 1
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
value:
type: string
required:
- name
- value
type: object
maxItems: 16
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
set:
items:
properties:
name:
maxLength: 256
minLength: 1
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
value:
type: string
required:
- name
- value
type: object
maxItems: 16
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
type: object
status:
description: The HTTP status code to be set
on a rate limit event
Expand Down Expand Up @@ -2147,6 +2192,9 @@ spec:
type: string
name:
description: The Name of the reset header.
maxLength: 256
minLength: 1
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
type: object
type: array
Expand Down Expand Up @@ -2219,6 +2267,9 @@ spec:
type: string
name:
description: The Name of the reset header.
maxLength: 256
minLength: 1
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
type: object
type: array
Expand All @@ -2228,17 +2279,36 @@ spec:
which must be present in the request for retries to
be attempted.
items:
description: HTTPHeaderMatch describes how to select
a HTTP route by matching HTTP request headers.
properties:
name:
description: Name is the name of the HTTP Header
to be matched. Name MUST be lower case as they
will be handled with case insensitivity (See
https://tools.ietf.org/html/rfc7230#section-3.2).
maxLength: 256
minLength: 1
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
type:
default: Exact
description: Type specifies how to match against
the value of the header.
enum:
- REGULAR_EXPRESSION
- EXACT
- PREFIX
- Exact
- Present
- RegularExpression
- Absent
- Prefix
type: string
value:
description: Value is the value of HTTP Header
to be matched.
type: string
required:
- name
- value
type: object
type: array
retriableResponseHeaders:
Expand All @@ -2247,17 +2317,36 @@ spec:
A retry will be triggered if any of the header matches
match the upstream response headers.
items:
description: HTTPHeaderMatch describes how to select
a HTTP route by matching HTTP request headers.
properties:
name:
description: Name is the name of the HTTP Header
to be matched. Name MUST be lower case as they
will be handled with case insensitivity (See
https://tools.ietf.org/html/rfc7230#section-3.2).
maxLength: 256
minLength: 1
pattern: ^[a-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
type:
default: Exact
description: Type specifies how to match against
the value of the header.
enum:
- REGULAR_EXPRESSION
- EXACT
- PREFIX
- Exact
- Present
- RegularExpression
- Absent
- Prefix
type: string
value:
description: Value is the value of HTTP Header
to be matched.
type: string
required:
- name
- value
type: object
type: array
retryOn:
Expand Down
Loading

0 comments on commit b092559

Please sign in to comment.