gitea_admin/Homelabv4
1
0
Fork 0
mirror of https://gitlab.kube.huskypup.net/Scooby/Homelabv4.git synced 2026-08-21 11:36:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
85c916285e84d773284cc8139b63b43f184c4f98
Homelabv4/charts/envoy-gateway/crds/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml
T
Scooby HuskyandClaude Opus 4.6 8bde33f4d1 Remove nessus app and fix envoy-gateway OCI chart bug 
- Delete nessus Application CRD, manifests, and bootstrap script
- Vendor envoy-gateway Helm chart (v1.6.3) locally to work around
  ArgoCD v3.3.3 Docker Hub OCI resolution bug
- Re-enable auto-sync for envoy-gateway

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-10 19:41:36 -05:00

2768 lines
152 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.18.0
name: backendtrafficpolicies.gateway.envoyproxy.io
spec:
group: gateway.envoyproxy.io
names:
categories:
- envoy-gateway
kind: BackendTrafficPolicy
listKind: BackendTrafficPolicyList
plural: backendtrafficpolicies
shortNames:
- btp
singular: backendtrafficpolicy
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1alpha1
schema:
openAPIV3Schema:
description: |-
BackendTrafficPolicy allows the user to configure the behavior of the connection
between the Envoy Proxy listener and the backend service.
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
type: string
metadata:
type: object
spec:
description: spec defines the desired state of BackendTrafficPolicy.
properties:
circuitBreaker:
description: |-
Circuit Breaker settings for the upstream connections and requests.
If not set, circuit breakers will be enabled with the default thresholds
properties:
maxConnections:
default: 1024
description: The maximum number of connections that Envoy will
establish to the referenced backend defined within a xRoute
rule.
format: int64
maximum: 4294967295
minimum: 0
type: integer
maxParallelRequests:
default: 1024
description: The maximum number of parallel requests that Envoy
will make to the referenced backend defined within a xRoute
rule.
format: int64
maximum: 4294967295
minimum: 0
type: integer
maxParallelRetries:
default: 1024
description: The maximum number of parallel retries that Envoy
will make to the referenced backend defined within a xRoute
rule.
format: int64
maximum: 4294967295
minimum: 0
type: integer
maxPendingRequests:
default: 1024
description: The maximum number of pending requests that Envoy
will queue to the referenced backend defined within a xRoute
rule.
format: int64
maximum: 4294967295
minimum: 0
type: integer
maxRequestsPerConnection:
description: |-
The maximum number of requests that Envoy will make over a single connection to the referenced backend defined within a xRoute rule.
Default: unlimited.
format: int64
maximum: 4294967295
minimum: 0
type: integer
perEndpoint:
description: PerEndpoint defines Circuit Breakers that will apply
per-endpoint for an upstream cluster
properties:
maxConnections:
default: 1024
description: MaxConnections configures the maximum number
of connections that Envoy will establish per-endpoint to
the referenced backend defined within a xRoute rule.
format: int64
maximum: 4294967295
minimum: 0
type: integer
type: object
type: object
compression:
description: |-
The compression config for the http streams.
Deprecated: Use Compressor instead.
items:
description: |-
Compression defines the config of enabling compression.
This can help reduce the bandwidth at the expense of higher CPU.
properties:
brotli:
description: The configuration for Brotli compressor.
type: object
gzip:
description: The configuration for GZIP compressor.
type: object
type:
description: CompressorType defines the compressor type to use
for compression.
enum:
- Gzip
- Brotli
- Zstd
type: string
zstd:
description: The configuration for Zstd compressor.
type: object
required:
- type
type: object
type: array
compressor:
description: |-
The compressor config for the http streams.
This provides more granular control over compression configuration.
items:
description: |-
Compression defines the config of enabling compression.
This can help reduce the bandwidth at the expense of higher CPU.
properties:
brotli:
description: The configuration for Brotli compressor.
type: object
gzip:
description: The configuration for GZIP compressor.
type: object
type:
description: CompressorType defines the compressor type to use
for compression.
enum:
- Gzip
- Brotli
- Zstd
type: string
zstd:
description: The configuration for Zstd compressor.
type: object
required:
- type
type: object
type: array
connection:
description: Connection includes backend connection settings.
properties:
bufferLimit:
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: |-
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
preconnect:
description: |-
Preconnect configures proactive upstream connections to reduce latency by establishing
connections before they’re needed and avoiding connection establishment overhead.
If unset, Envoy will fetch connections as needed to serve in-flight requests.
properties:
perEndpointPercent:
description: |-
PerEndpointPercent configures how many additional connections to maintain per
upstream endpoint, useful for high-QPS or latency sensitive services. Expressed as a
percentage of the connections required by active streams
(e.g. 100 = preconnect disabled, 105 = 1.05x connections per-endpoint, 200 = 2.00×).
Allowed value range is between 100-300. When both PerEndpointPercent and
PredictivePercent are set, Envoy ensures both are satisfied (max of the two).
format: int32
maximum: 300
minimum: 100
type: integer
predictivePercent:
description: |-
PredictivePercent configures how many additional connections to maintain
across the cluster by anticipating which upstream endpoint the load balancer
will select next, useful for low-QPS services. Relies on deterministic
loadbalancing and is only supported with Random or RoundRobin.
Expressed as a percentage of the connections required by active streams
(e.g. 100 = 1.0 (no preconnect), 105 = 1.05× connections across the cluster, 200 = 2.00×).
Minimum allowed value is 100. When both PerEndpointPercent and PredictivePercent are
set Envoy ensures both are satisfied per host (max of the two).
format: int32
minimum: 100
type: integer
type: object
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.
properties:
dnsRefreshRate:
description: |-
DNSRefreshRate specifies the rate at which DNS records should be refreshed.
Defaults to 30 seconds.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
lookupFamily:
description: |-
LookupFamily determines how Envoy would resolve DNS for Routes where the backend is specified as a fully qualified domain name (FQDN).
If set, this configuration overrides other defaults.
enum:
- IPv4
- IPv6
- IPv4Preferred
- IPv6Preferred
- IPv4AndIPv6
type: string
respectDnsTtl:
description: |-
RespectDNSTTL indicates whether the DNS Time-To-Live (TTL) should be respected.
If the value is set to true, the DNS refresh rate will be set to the resource record’s TTL.
Defaults to true.
type: boolean
type: object
faultInjection:
description: |-
FaultInjection defines the fault injection policy to be applied. This configuration can be used to
inject delays and abort requests to mimic failure scenarios such as service failures and overloads
properties:
abort:
description: If specified, the request will be aborted if it meets
the configuration criteria.
properties:
grpcStatus:
description: GrpcStatus specifies the GRPC status code to
be returned
format: int32
type: integer
httpStatus:
description: StatusCode specifies the HTTP status code to
be returned
format: int32
maximum: 600
minimum: 200
type: integer
percentage:
default: 100
description: Percentage specifies the percentage of requests
to be aborted. Default 100%, if set 0, no requests will
be aborted. Accuracy to 0.0001%.
type: number
type: object
x-kubernetes-validations:
- message: httpStatus and grpcStatus cannot be simultaneously
defined.
rule: ' !(has(self.httpStatus) && has(self.grpcStatus)) '
- message: httpStatus and grpcStatus are set at least one.
rule: ' has(self.httpStatus) || has(self.grpcStatus) '
delay:
description: If specified, a delay will be injected into the request.
properties:
fixedDelay:
description: FixedDelay specifies the fixed delay duration
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
percentage:
default: 100
description: Percentage specifies the percentage of requests
to be delayed. Default 100%, if set 0, no requests will
be delayed. Accuracy to 0.0001%.
type: number
required:
- fixedDelay
type: object
type: object
x-kubernetes-validations:
- message: Delay and abort faults are set at least one.
rule: ' has(self.delay) || has(self.abort) '
healthCheck:
description: HealthCheck allows gateway to perform active health checking
on backends.
properties:
active:
description: Active health check configuration
properties:
grpc:
description: |-
GRPC defines the configuration of the GRPC health checker.
It's optional, and can only be used if the specified type is GRPC.
properties:
service:
description: |-
Service to send in the health check request.
If this is not specified, then the health check request applies to the entire
server and not to a specific service.
type: string
type: object
healthyThreshold:
default: 1
description: HealthyThreshold defines the number of healthy
health checks required before a backend host is marked healthy.
format: int32
minimum: 1
type: integer
http:
description: |-
HTTP defines the configuration of http health checker.
It's required while the health checker type is HTTP.
properties:
expectedResponse:
description: ExpectedResponse defines a list of HTTP expected
responses to match.
properties:
binary:
description: Binary payload base64 encoded.
format: byte
type: string
text:
description: Text payload in plain text.
type: string
type:
allOf:
- enum:
- Text
- Binary
- enum:
- Text
- Binary
description: Type defines the type of the payload.
type: string
required:
- type
type: object
x-kubernetes-validations:
- message: If payload type is Text, text field needs to
be set.
rule: 'self.type == ''Text'' ? has(self.text) : !has(self.text)'
- message: If payload type is Binary, binary field needs
to be set.
rule: 'self.type == ''Binary'' ? has(self.binary) :
!has(self.binary)'
expectedStatuses:
description: |-
ExpectedStatuses defines a list of HTTP response statuses considered healthy.
Defaults to 200 only
items:
description: HTTPStatus defines the http status code.
maximum: 599
minimum: 100
type: integer
type: array
hostname:
description: |-
Hostname defines the HTTP host that will be requested during health checking.
Default: HTTPRoute or GRPCRoute hostname.
maxLength: 253
minLength: 1
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
method:
description: |-
Method defines the HTTP method used for health checking.
Defaults to GET
type: string
path:
description: Path defines the HTTP path that will be requested
during health checking.
maxLength: 1024
minLength: 1
type: string
required:
- path
type: object
initialJitter:
description: |-
InitialJitter defines the maximum time Envoy will wait before the first health check.
Envoy will randomly select a value between 0 and the initial jitter value.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
interval:
default: 3s
description: Interval defines the time between active health
checks.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
tcp:
description: |-
TCP defines the configuration of tcp health checker.
It's required while the health checker type is TCP.
properties:
receive:
description: Receive defines the expected response payload.
properties:
binary:
description: Binary payload base64 encoded.
format: byte
type: string
text:
description: Text payload in plain text.
type: string
type:
allOf:
- enum:
- Text
- Binary
- enum:
- Text
- Binary
description: Type defines the type of the payload.
type: string
required:
- type
type: object
x-kubernetes-validations:
- message: If payload type is Text, text field needs to
be set.
rule: 'self.type == ''Text'' ? has(self.text) : !has(self.text)'
- message: If payload type is Binary, binary field needs
to be set.
rule: 'self.type == ''Binary'' ? has(self.binary) :
!has(self.binary)'
send:
description: Send defines the request payload.
properties:
binary:
description: Binary payload base64 encoded.
format: byte
type: string
text:
description: Text payload in plain text.
type: string
type:
allOf:
- enum:
- Text
- Binary
- enum:
- Text
- Binary
description: Type defines the type of the payload.
type: string
required:
- type
type: object
x-kubernetes-validations:
- message: If payload type is Text, text field needs to
be set.
rule: 'self.type == ''Text'' ? has(self.text) : !has(self.text)'
- message: If payload type is Binary, binary field needs
to be set.
rule: 'self.type == ''Binary'' ? has(self.binary) :
!has(self.binary)'
type: object
timeout:
default: 1s
description: Timeout defines the time to wait for a health
check response.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
type:
allOf:
- enum:
- HTTP
- TCP
- GRPC
- enum:
- HTTP
- TCP
- GRPC
description: Type defines the type of health checker.
type: string
unhealthyThreshold:
default: 3
description: UnhealthyThreshold defines the number of unhealthy
health checks required before a backend host is marked unhealthy.
format: int32
minimum: 1
type: integer
required:
- type
type: object
x-kubernetes-validations:
- message: If Health Checker type is HTTP, http field needs to
be set.
rule: 'self.type == ''HTTP'' ? has(self.http) : !has(self.http)'
- message: If Health Checker type is TCP, tcp field needs to be
set.
rule: 'self.type == ''TCP'' ? has(self.tcp) : !has(self.tcp)'
- message: The grpc field can only be set if the Health Checker
type is GRPC.
rule: 'has(self.grpc) ? self.type == ''GRPC'' : true'
panicThreshold:
description: |-
When number of unhealthy endpoints for a backend reaches this threshold
Envoy will disregard health status and balance across all endpoints.
It's designed to prevent a situation in which host failures cascade throughout the cluster
as load increases. If not set, the default value is 50%. To disable panic mode, set value to `0`.
format: int32
maximum: 100
minimum: 0
type: integer
passive:
description: Passive passive check configuration
properties:
baseEjectionTime:
default: 30s
description: BaseEjectionTime defines the base duration for
which a host will be ejected on consecutive failures.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
consecutive5XxErrors:
default: 5
description: Consecutive5xxErrors sets the number of consecutive
5xx errors triggering ejection.
format: int32
type: integer
consecutiveGatewayErrors:
description: ConsecutiveGatewayErrors sets the number of consecutive
gateway errors triggering ejection.
format: int32
type: integer
consecutiveLocalOriginFailures:
default: 5
description: |-
ConsecutiveLocalOriginFailures sets the number of consecutive local origin failures triggering ejection.
Parameter takes effect only when split_external_local_origin_errors is set to true.
format: int32
type: integer
failurePercentageThreshold:
description: |-
FailurePercentageThreshold sets the failure percentage threshold for outlier detection.
If the failure percentage of a given host is greater than or equal to this value, it will be ejected.
Defaults to 85.
format: int32
maximum: 100
minimum: 0
type: integer
interval:
default: 3s
description: Interval defines the time between passive health
checks.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
maxEjectionPercent:
default: 10
description: MaxEjectionPercent sets the maximum percentage
of hosts in a cluster that can be ejected.
format: int32
type: integer
splitExternalLocalOriginErrors:
default: false
description: SplitExternalLocalOriginErrors enables splitting
of errors between external and local origin.
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
httpUpgrade:
description: |-
HTTPUpgrade defines the configuration for HTTP protocol upgrades.
If not specified, the default upgrade configuration(websocket) will be used.
items:
description: ProtocolUpgradeConfig specifies the configuration for
protocol upgrades.
properties:
connect:
description: |-
Connect specifies the configuration for the CONNECT config.
This is allowed only when type is CONNECT.
properties:
terminate:
description: Terminate the CONNECT request, and forwards
the payload as raw TCP data.
type: boolean
type: object
type:
description: |-
Type is the case-insensitive type of protocol upgrade.
e.g. `websocket`, `CONNECT`, `spdy/3.1` etc.
type: string
required:
- type
type: object
x-kubernetes-validations:
- message: The connect configuration is only allowed when the type
is CONNECT.
rule: '!has(self.connect) || self.type == ''CONNECT'''
type: array
loadBalancer:
description: |-
LoadBalancer policy to apply when routing traffic from the gateway to
the backend endpoints. Defaults to `LeastRequest`.
properties:
consistentHash:
description: |-
ConsistentHash defines the configuration when the load balancer type is
set to ConsistentHash
properties:
cookie:
description: Cookie configures the cookie hash policy when
the consistent hash type is set to Cookie.
properties:
attributes:
additionalProperties:
type: string
description: Additional Attributes to set for the generated
cookie.
type: object
name:
description: |-
Name of the cookie to hash.
If this cookie does not exist in the request, Envoy will generate a cookie and set
the TTL on the response back to the client based on Layer 4
attributes of the backend endpoint, to ensure that these future requests
go to the same backend endpoint. Make sure to set the TTL field for this case.
type: string
ttl:
description: |-
TTL of the generated cookie if the cookie is not present. This value sets the
Max-Age attribute value.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
required:
- name
type: object
header:
description: |-
Header configures the header hash policy when the consistent hash type is set to Header.
Deprecated: use Headers instead
properties:
name:
description: Name of the header to hash.
type: string
required:
- name
type: object
headers:
description: Headers configures the header hash policy for
each header, when the consistent hash type is set to Headers.
items:
description: |-
Header defines the header hashing configuration for consistent hash based
load balancing.
properties:
name:
description: Name of the header to hash.
type: string
required:
- name
type: object
type: array
tableSize:
default: 65537
description: The table size for consistent hashing, must be
prime number limited to 5000011.
format: int64
maximum: 5000011
minimum: 2
type: integer
type:
description: |-
ConsistentHashType defines the type of input to hash on. Valid Type values are
"SourceIP",
"Header",
"Headers",
"Cookie".
enum:
- SourceIP
- Header
- Headers
- Cookie
type: string
required:
- type
type: object
x-kubernetes-validations:
- message: If consistent hash type is header, the header field
must be set.
rule: 'self.type == ''Header'' ? has(self.header) : !has(self.header)'
- message: If consistent hash type is headers, the headers field
must be set.
rule: 'self.type == ''Headers'' ? has(self.headers) : !has(self.headers)'
- message: If consistent hash type is cookie, the cookie field
must be set.
rule: 'self.type == ''Cookie'' ? has(self.cookie) : !has(self.cookie)'
endpointOverride:
description: |-
EndpointOverride defines the configuration for endpoint override.
When specified, the load balancer will attempt to route requests to endpoints
based on the override information extracted from request headers or metadata.
If the override endpoints are not available, the configured load balancer policy will be used as fallback.
properties:
extractFrom:
description: ExtractFrom defines the sources to extract endpoint
override information from.
items:
description: EndpointOverrideExtractFrom defines a source
to extract endpoint override information from.
properties:
header:
description: |-
Header defines the header to get the override endpoint addresses.
The header value must specify at least one endpoint in `IP:Port` format or multiple endpoints in `IP:Port,IP:Port,...` format.
For example `10.0.0.5:8080` or `[2600:4040:5204::1574:24ae]:80`.
The IPv6 address is enclosed in square brackets.
type: string
type: object
maxItems: 10
minItems: 1
type: array
required:
- extractFrom
type: object
slowStart:
description: |-
SlowStart defines the configuration related to the slow start load balancer policy.
If set, during slow start window, traffic sent to the newly added hosts will gradually increase.
Currently this is only supported for RoundRobin and LeastRequest load balancers
properties:
window:
description: |-
Window defines the duration of the warm up period for newly added host.
During slow start window, traffic sent to the newly added hosts will gradually increase.
Currently only supports linear growth of traffic. For additional details,
see https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#config-cluster-v3-cluster-slowstartconfig
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
required:
- window
type: object
type:
description: |-
Type decides the type of Load Balancer policy.
Valid LoadBalancerType values are
"ConsistentHash",
"LeastRequest",
"Random",
"RoundRobin".
enum:
- ConsistentHash
- LeastRequest
- Random
- RoundRobin
type: string
zoneAware:
description: ZoneAware defines the configuration related to the
distribution of requests between locality zones.
properties:
preferLocal:
description: PreferLocalZone configures zone-aware routing
to prefer sending traffic to the local locality zone.
properties:
force:
description: |-
ForceLocalZone defines override configuration for forcing all traffic to stay within the local zone instead of the default behavior
which maintains equal distribution among upstream endpoints while sending as much traffic as possible locally.
properties:
minEndpointsInZoneThreshold:
description: |-
MinEndpointsInZoneThreshold is the minimum number of upstream endpoints in the local zone required to honor the forceLocalZone
override. This is useful for protecting zones with fewer endpoints.
format: int32
type: integer
type: object
minEndpointsThreshold:
description: MinEndpointsThreshold is the minimum number
of total upstream endpoints across all zones required
to enable zone-aware routing.
format: int64
type: integer
percentageEnabled:
description: Configures percentage of requests that will
be considered for zone aware routing if zone aware routing
is configured. If not specified, Envoy defaults to 100%.
format: int32
maximum: 100
minimum: 0
type: integer
type: object
type: object
required:
- type
type: object
x-kubernetes-validations:
- message: If LoadBalancer type is consistentHash, consistentHash
field needs to be set.
rule: 'self.type == ''ConsistentHash'' ? has(self.consistentHash)
: !has(self.consistentHash)'
- message: Currently SlowStart is only supported for RoundRobin and
LeastRequest load balancers.
rule: 'self.type in [''Random'', ''ConsistentHash''] ? !has(self.slowStart)
: true '
- message: Currently ZoneAware is only supported for LeastRequest,
Random, and RoundRobin load balancers.
rule: 'self.type == ''ConsistentHash'' ? !has(self.zoneAware) :
true '
mergeType:
description: |-
MergeType determines how this configuration is merged with existing BackendTrafficPolicy
configurations targeting a parent resource. When set, this configuration will be merged
into a parent BackendTrafficPolicy (i.e. the one targeting a Gateway or Listener).
This field cannot be set when targeting a parent resource (Gateway).
If unset, no merging occurs, and only the most specific configuration takes effect.
type: string
proxyProtocol:
description: ProxyProtocol enables the Proxy Protocol when communicating
with the backend.
properties:
version:
description: |-
Version of ProxyProtol
Valid ProxyProtocolVersion values are
"V1"
"V2"
enum:
- V1
- V2
type: string
required:
- version
type: object
rateLimit:
description: |-
RateLimit allows the user to limit the number of incoming requests
to a predefined value based on attributes within the traffic flow.
properties:
global:
description: Global defines global rate limit configuration.
properties:
rules:
description: |-
Rules are a list of RateLimit selectors and limits. Each rule and its
associated limit is applied in a mutually exclusive way. If a request
matches multiple rules, each of their associated limits get applied, so a
single request might increase the rate limit counters for multiple rules
if selected. The rate limit service will return a logical OR of the individual
rate limit decisions of all matching rules. For example, if a request
matches two rules, one rate limited and one not, the final decision will be
to rate limit the request.
items:
description: |-
RateLimitRule defines the semantics for matching attributes
from the incoming requests, and setting limits for them.
properties:
clientSelectors:
description: |-
ClientSelectors holds the list of select conditions to select
specific clients using attributes from the traffic flow.
All individual select conditions must hold True for this rule
and its limit to be applied.
If no client selectors are specified, the rule applies to all traffic of
the targeted Route.
If the policy targets a Gateway, the rule applies to each Route of the Gateway.
Please note that each Route has its own rate limit counters. For example,
if a Gateway has two Routes, and the policy has a rule with limit 10rps,
each Route will have its own 10rps limit.
items:
description: |-
RateLimitSelectCondition specifies the attributes within the traffic flow that can
be used to select a subset of clients to be ratelimited.
All the individual conditions must hold True for the overall condition to hold True.
And, at least one of headers or methods or path or sourceCIDR condition must be specified.
properties:
headers:
description: |-
Headers is a list of request headers to match. Multiple header values are ANDed together,
meaning, a request MUST match all the specified headers.
items:
description: HeaderMatch defines the match attributes
within the HTTP Headers of the request.
properties:
invert:
default: false
description: |-
Invert specifies whether the value match result will be inverted.
Do not set this field when Type="Distinct", implying matching on any/all unique
values within the header.
type: boolean
name:
description: |-
Name of the HTTP header.
The header name is case-insensitive unless PreserveHeaderCase is set to true.
For example, "Foo" and "foo" are considered the same header.
maxLength: 256
minLength: 1
type: string
type:
default: Exact
description: Type specifies how to match
against the value of the header.
enum:
- Exact
- RegularExpression
- Distinct
type: string
value:
description: |-
Value within the HTTP header.
Do not set this field when Type="Distinct", implying matching on any/all unique
values within the header.
maxLength: 1024
type: string
required:
- name
type: object
maxItems: 16
type: array
methods:
description: |-
Methods is a list of request methods to match. Multiple method values are ORed together,
meaning, a request can match any one of the specified methods. If not specified, it matches all methods.
items:
description: MethodMatch defines the matching
criteria for the HTTP method of a request.
properties:
invert:
default: false
description: Invert specifies whether the
value match result will be inverted.
type: boolean
value:
description: Value specifies the HTTP method.
enum:
- GET
- HEAD
- POST
- PUT
- DELETE
- CONNECT
- OPTIONS
- TRACE
- PATCH
type: string
required:
- value
type: object
type: array
path:
description: |-
Path is the request path to match.
Support Exact, PathPrefix and RegularExpression match types.
properties:
invert:
default: false
description: Invert specifies whether the
value match result will be inverted.
type: boolean
type:
default: PathPrefix
description: Type specifies how to match against
the value of the path.
enum:
- Exact
- PathPrefix
- RegularExpression
type: string
value:
default: /
description: Value specifies the HTTP path.
maxLength: 1024
type: string
required:
- value
type: object
sourceCIDR:
description: SourceCIDR is the client IP Address
range to match on.
properties:
type:
default: Exact
enum:
- Exact
- Distinct
type: string
value:
description: |-
Value is the IP CIDR that represents the range of Source IP Addresses of the client.
These could also be the intermediate addresses through which the request has flown through and is part of the `X-Forwarded-For` header.
For example, `192.168.0.1/32`, `192.168.0.0/24`, `001:db8::/64`.
maxLength: 256
minLength: 1
type: string
required:
- value
type: object
type: object
x-kubernetes-validations:
- message: at least one of headers, methods, path
or sourceCIDR must be specified
rule: has(self.headers) || has(self.methods) ||
has(self.path) || has(self.sourceCIDR)
maxItems: 8
type: array
cost:
description: |-
Cost specifies the cost of requests and responses for the rule.
This is optional and if not specified, the default behavior is to reduce the rate limit counters by 1 on
the request path and do not reduce the rate limit counters on the response path.
properties:
request:
description: |-
Request specifies the number to reduce the rate limit counters
on the request path. If this is not specified, the default behavior
is to reduce the rate limit counters by 1.
When Envoy receives a request that matches the rule, it tries to reduce the
rate limit counters by the specified number. If the counter doesn't have
enough capacity, the request is rate limited.
properties:
from:
description: From specifies where to get the
rate limit cost. Currently, only "Number"
and "Metadata" are supported.
enum:
- Number
- Metadata
type: string
metadata:
description: Metadata specifies the per-request
metadata to retrieve the usage number from.
properties:
key:
description: Key is the key to retrieve
the usage number from the filter metadata.
type: string
namespace:
description: Namespace is the namespace
of the dynamic metadata.
type: string
required:
- key
- namespace
type: object
number:
description: |-
Number specifies the fixed usage number to reduce the rate limit counters.
Using zero can be used to only check the rate limit counters without reducing them.
format: int64
type: integer
required:
- from
type: object
x-kubernetes-validations:
- message: only one of number or metadata can be
specified
rule: '!(has(self.number) && has(self.metadata))'
response:
description: |-
Response specifies the number to reduce the rate limit counters
after the response is sent back to the client or the request stream is closed.
The cost is used to reduce the rate limit counters for the matching requests.
Since the reduction happens after the request stream is complete, the rate limit
won't be enforced for the current request, but for the subsequent matching requests.
This is optional and if not specified, the rate limit counters are not reduced
on the response path.
Currently, this is only supported for HTTP Global Rate Limits.
properties:
from:
description: From specifies where to get the
rate limit cost. Currently, only "Number"
and "Metadata" are supported.
enum:
- Number
- Metadata
type: string
metadata:
description: Metadata specifies the per-request
metadata to retrieve the usage number from.
properties:
key:
description: Key is the key to retrieve
the usage number from the filter metadata.
type: string
namespace:
description: Namespace is the namespace
of the dynamic metadata.
type: string
required:
- key
- namespace
type: object
number:
description: |-
Number specifies the fixed usage number to reduce the rate limit counters.
Using zero can be used to only check the rate limit counters without reducing them.
format: int64
type: integer
required:
- from
type: object
x-kubernetes-validations:
- message: only one of number or metadata can be
specified
rule: '!(has(self.number) && has(self.metadata))'
type: object
limit:
description: |-
Limit holds the rate limit values.
This limit is applied for traffic flows when the selectors
compute to True, causing the request to be counted towards the limit.
The limit is enforced and the request is ratelimited, i.e. a response with
429 HTTP status code is sent back to the client when
the selected requests have reached the limit.
properties:
requests:
type: integer
unit:
description: |-
RateLimitUnit specifies the intervals for setting rate limits.
Valid RateLimitUnit values are "Second", "Minute", "Hour", "Day", "Month" and "Year".
enum:
- Second
- Minute
- Hour
- Day
- Month
- Year
type: string
required:
- requests
- unit
type: object
shared:
description: |-
Shared determines whether this rate limit rule applies across all the policy targets.
If set to true, the rule is treated as a common bucket and is shared across all policy targets (xRoutes).
Default: false.
type: boolean
required:
- limit
type: object
maxItems: 128
type: array
required:
- rules
type: object
local:
description: Local defines local rate limit configuration.
properties:
rules:
description: |-
Rules are a list of RateLimit selectors and limits. If a request matches
multiple rules, the strictest limit is applied. For example, if a request
matches two rules, one with 10rps and one with 20rps, the final limit will
be based on the rule with 10rps.
items:
description: |-
RateLimitRule defines the semantics for matching attributes
from the incoming requests, and setting limits for them.
properties:
clientSelectors:
description: |-
ClientSelectors holds the list of select conditions to select
specific clients using attributes from the traffic flow.
All individual select conditions must hold True for this rule
and its limit to be applied.
If no client selectors are specified, the rule applies to all traffic of
the targeted Route.
If the policy targets a Gateway, the rule applies to each Route of the Gateway.
Please note that each Route has its own rate limit counters. For example,
if a Gateway has two Routes, and the policy has a rule with limit 10rps,
each Route will have its own 10rps limit.
items:
description: |-
RateLimitSelectCondition specifies the attributes within the traffic flow that can
be used to select a subset of clients to be ratelimited.
All the individual conditions must hold True for the overall condition to hold True.
And, at least one of headers or methods or path or sourceCIDR condition must be specified.
properties:
headers:
description: |-
Headers is a list of request headers to match. Multiple header values are ANDed together,
meaning, a request MUST match all the specified headers.
items:
description: HeaderMatch defines the match attributes
within the HTTP Headers of the request.
properties:
invert:
default: false
description: |-
Invert specifies whether the value match result will be inverted.
Do not set this field when Type="Distinct", implying matching on any/all unique
values within the header.
type: boolean
name:
description: |-
Name of the HTTP header.
The header name is case-insensitive unless PreserveHeaderCase is set to true.
For example, "Foo" and "foo" are considered the same header.
maxLength: 256
minLength: 1
type: string
type:
default: Exact
description: Type specifies how to match
against the value of the header.
enum:
- Exact
- RegularExpression
- Distinct
type: string
value:
description: |-
Value within the HTTP header.
Do not set this field when Type="Distinct", implying matching on any/all unique
values within the header.
maxLength: 1024
type: string
required:
- name
type: object
maxItems: 16
type: array
methods:
description: |-
Methods is a list of request methods to match. Multiple method values are ORed together,
meaning, a request can match any one of the specified methods. If not specified, it matches all methods.
items:
description: MethodMatch defines the matching
criteria for the HTTP method of a request.
properties:
invert:
default: false
description: Invert specifies whether the
value match result will be inverted.
type: boolean
value:
description: Value specifies the HTTP method.
enum:
- GET
- HEAD
- POST
- PUT
- DELETE
- CONNECT
- OPTIONS
- TRACE
- PATCH
type: string
required:
- value
type: object
type: array
path:
description: |-
Path is the request path to match.
Support Exact, PathPrefix and RegularExpression match types.
properties:
invert:
default: false
description: Invert specifies whether the
value match result will be inverted.
type: boolean
type:
default: PathPrefix
description: Type specifies how to match against
the value of the path.
enum:
- Exact
- PathPrefix
- RegularExpression
type: string
value:
default: /
description: Value specifies the HTTP path.
maxLength: 1024
type: string
required:
- value
type: object
sourceCIDR:
description: SourceCIDR is the client IP Address
range to match on.
properties:
type:
default: Exact
enum:
- Exact
- Distinct
type: string
value:
description: |-
Value is the IP CIDR that represents the range of Source IP Addresses of the client.
These could also be the intermediate addresses through which the request has flown through and is part of the `X-Forwarded-For` header.
For example, `192.168.0.1/32`, `192.168.0.0/24`, `001:db8::/64`.
maxLength: 256
minLength: 1
type: string
required:
- value
type: object
type: object
x-kubernetes-validations:
- message: at least one of headers, methods, path
or sourceCIDR must be specified
rule: has(self.headers) || has(self.methods) ||
has(self.path) || has(self.sourceCIDR)
maxItems: 8
type: array
cost:
description: |-
Cost specifies the cost of requests and responses for the rule.
This is optional and if not specified, the default behavior is to reduce the rate limit counters by 1 on
the request path and do not reduce the rate limit counters on the response path.
properties:
request:
description: |-
Request specifies the number to reduce the rate limit counters
on the request path. If this is not specified, the default behavior
is to reduce the rate limit counters by 1.
When Envoy receives a request that matches the rule, it tries to reduce the
rate limit counters by the specified number. If the counter doesn't have
enough capacity, the request is rate limited.
properties:
from:
description: From specifies where to get the
rate limit cost. Currently, only "Number"
and "Metadata" are supported.
enum:
- Number
- Metadata
type: string
metadata:
description: Metadata specifies the per-request
metadata to retrieve the usage number from.
properties:
key:
description: Key is the key to retrieve
the usage number from the filter metadata.
type: string
namespace:
description: Namespace is the namespace
of the dynamic metadata.
type: string
required:
- key
- namespace
type: object
number:
description: |-
Number specifies the fixed usage number to reduce the rate limit counters.
Using zero can be used to only check the rate limit counters without reducing them.
format: int64
type: integer
required:
- from
type: object
x-kubernetes-validations:
- message: only one of number or metadata can be
specified
rule: '!(has(self.number) && has(self.metadata))'
response:
description: |-
Response specifies the number to reduce the rate limit counters
after the response is sent back to the client or the request stream is closed.
The cost is used to reduce the rate limit counters for the matching requests.
Since the reduction happens after the request stream is complete, the rate limit
won't be enforced for the current request, but for the subsequent matching requests.
This is optional and if not specified, the rate limit counters are not reduced
on the response path.
Currently, this is only supported for HTTP Global Rate Limits.
properties:
from:
description: From specifies where to get the
rate limit cost. Currently, only "Number"
and "Metadata" are supported.
enum:
- Number
- Metadata
type: string
metadata:
description: Metadata specifies the per-request
metadata to retrieve the usage number from.
properties:
key:
description: Key is the key to retrieve
the usage number from the filter metadata.
type: string
namespace:
description: Namespace is the namespace
of the dynamic metadata.
type: string
required:
- key
- namespace
type: object
number:
description: |-
Number specifies the fixed usage number to reduce the rate limit counters.
Using zero can be used to only check the rate limit counters without reducing them.
format: int64
type: integer
required:
- from
type: object
x-kubernetes-validations:
- message: only one of number or metadata can be
specified
rule: '!(has(self.number) && has(self.metadata))'
type: object
limit:
description: |-
Limit holds the rate limit values.
This limit is applied for traffic flows when the selectors
compute to True, causing the request to be counted towards the limit.
The limit is enforced and the request is ratelimited, i.e. a response with
429 HTTP status code is sent back to the client when
the selected requests have reached the limit.
properties:
requests:
type: integer
unit:
description: |-
RateLimitUnit specifies the intervals for setting rate limits.
Valid RateLimitUnit values are "Second", "Minute", "Hour", "Day", "Month" and "Year".
enum:
- Second
- Minute
- Hour
- Day
- Month
- Year
type: string
required:
- requests
- unit
type: object
shared:
description: |-
Shared determines whether this rate limit rule applies across all the policy targets.
If set to true, the rule is treated as a common bucket and is shared across all policy targets (xRoutes).
Default: false.
type: boolean
required:
- limit
type: object
maxItems: 16
type: array
x-kubernetes-validations:
- message: response cost is not supported for Local Rate Limits
rule: self.all(foo, !has(foo.cost) || !has(foo.cost.response))
type: object
type:
description: |-
Type decides the scope for the RateLimits.
Valid RateLimitType values are "Global" or "Local".
Deprecated: Use Global and/or Local fields directly instead. Both can be specified simultaneously for combined rate limiting.
enum:
- Global
- Local
type: string
type: object
requestBuffer:
description: |-
RequestBuffer allows the gateway to buffer and fully receive each request from a client before continuing to send the request
upstream to the backends. This can be helpful to shield your backend servers from slow clients, and also to enforce a maximum size per request
as any requests larger than the buffer size will be rejected.
This can have a negative performance impact so should only be enabled when necessary.
When enabling this option, you should also configure your connection buffer size to account for these request buffers. There will also be an
increase in memory usage for Envoy that should be accounted for in your deployment settings.
properties:
limit:
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: |-
Limit specifies the maximum allowed size in bytes for each incoming request buffer.
If exceeded, the request will be rejected with HTTP 413 Content Too Large.
Accepts values in resource.Quantity format (e.g., "10Mi", "500Ki").
x-kubernetes-int-or-string: true
type: object
responseOverride:
description: |-
ResponseOverride defines the configuration to override specific responses with a custom one.
If multiple configurations are specified, the first one to match wins.
items:
description: ResponseOverride defines the configuration to override
specific responses with a custom one.
properties:
match:
description: Match configuration.
properties:
statusCodes:
description: Status code to match on. The match evaluates
to true if any of the matches are successful.
items:
description: StatusCodeMatch defines the configuration
for matching a status code.
properties:
range:
description: Range contains the range of status codes.
properties:
end:
description: End of the range, including the end
value.
type: integer
start:
description: Start of the range, including the
start value.
type: integer
required:
- end
- start
type: object
x-kubernetes-validations:
- message: end must be greater than start
rule: self.end > self.start
type:
allOf:
- enum:
- Value
- Range
- enum:
- Value
- Range
default: Value
description: |-
Type is the type of value.
Valid values are Value and Range, default is Value.
type: string
value:
description: Value contains the value of the status
code.
type: integer
required:
- type
type: object
x-kubernetes-validations:
- message: value must be set for type Value
rule: '(!has(self.type) || self.type == ''Value'')?
has(self.value) : true'
- message: range must be set for type Range
rule: '(has(self.type) && self.type == ''Range'')? has(self.range)
: true'
maxItems: 50
minItems: 1
type: array
required:
- statusCodes
type: object
redirect:
description: Redirect configuration
properties:
hostname:
description: |-
Hostname is the hostname to be used in the value of the `Location`
header in the response.
When empty, the hostname in the `Host` header of the request is used.
maxLength: 253
minLength: 1
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
path:
description: |-
Path defines parameters used to modify the path of the incoming request.
The modified path is then used to construct the `Location` header. When
empty, the request path is used as-is.
Only ReplaceFullPath path modifier is supported currently.
properties:
replaceFullPath:
description: |-
ReplaceFullPath specifies the value with which to replace the full path
of a request during a rewrite or redirect.
maxLength: 1024
type: string
replacePrefixMatch:
description: |-
ReplacePrefixMatch specifies the value with which to replace the prefix
match of a request during a rewrite or redirect. For example, a request
to "/foo/bar" with a prefix match of "/foo" and a ReplacePrefixMatch
of "/xyz" would be modified to "/xyz/bar".
Note that this matches the behavior of the PathPrefix match type. This
matches full path elements. A path element refers to the list of labels
in the path split by the `/` separator. When specified, a trailing `/` is
ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all
match the prefix `/abc`, but the path `/abcd` would not.
ReplacePrefixMatch is only compatible with a `PathPrefix` HTTPRouteMatch.
Using any other HTTPRouteMatch type on the same HTTPRouteRule will result in
the implementation setting the Accepted Condition for the Route to `status: False`.
Request Path | Prefix Match | Replace Prefix | Modified Path
maxLength: 1024
type: string
type:
description: |-
Type defines the type of path modifier. Additional types may be
added in a future release of the API.
Note that values may be added to this enum, implementations
must ensure that unknown values will not cause a crash.
Unknown values here must result in the implementation setting the
Accepted Condition for the Route to `status: False`, with a
Reason of `UnsupportedValue`.
enum:
- ReplaceFullPath
- ReplacePrefixMatch
type: string
required:
- type
type: object
x-kubernetes-validations:
- message: only ReplaceFullPath is supported for path.type
rule: self.type == 'ReplaceFullPath'
- message: replaceFullPath must be specified when type is
set to 'ReplaceFullPath'
rule: 'self.type == ''ReplaceFullPath'' ? has(self.replaceFullPath)
: true'
- message: type must be 'ReplaceFullPath' when replaceFullPath
is set
rule: 'has(self.replaceFullPath) ? self.type == ''ReplaceFullPath''
: true'
- message: replacePrefixMatch must be specified when type
is set to 'ReplacePrefixMatch'
rule: 'self.type == ''ReplacePrefixMatch'' ? has(self.replacePrefixMatch)
: true'
- message: type must be 'ReplacePrefixMatch' when replacePrefixMatch
is set
rule: 'has(self.replacePrefixMatch) ? self.type == ''ReplacePrefixMatch''
: true'
port:
description: |-
Port is the port to be used in the value of the `Location`
header in the response.
If redirect scheme is not-empty, the well-known port associated with the redirect scheme will be used.
Specifically "http" to port 80 and "https" to port 443. If the redirect scheme does not have a
well-known port or redirect scheme is empty, the listener port of the Gateway will be used.
Port will not be added in the 'Location' header if scheme is HTTP and port is 80
or scheme is HTTPS and port is 443.
format: int32
type: integer
scheme:
description: |-
Scheme is the scheme to be used in the value of the `Location` header in
the response. When empty, the scheme of the request is used.
enum:
- http
- https
type: string
statusCode:
default: 302
description: StatusCode is the HTTP status code to be used
in response.
enum:
- 301
- 302
type: integer
type: object
response:
description: Response configuration.
properties:
body:
description: |-
Body of the Custom Response
Supports Envoy command operators for dynamic content (see https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#command-operators).
properties:
inline:
description: Inline contains the value as an inline
string.
type: string
type:
allOf:
- enum:
- Inline
- ValueRef
- enum:
- Inline
- ValueRef
default: Inline
description: |-
Type is the type of method to use to read the body value.
Valid values are Inline and ValueRef, default is Inline.
type: string
valueRef:
description: |-
ValueRef contains the contents of the body
specified as a local object reference.
Only a reference to ConfigMap is supported.
The value of key `response.body` in the ConfigMap will be used as the response body.
If the key is not found, the first value in the ConfigMap will be used.
properties:
group:
description: |-
Group is the group of the referent. For example, "gateway.networking.k8s.io".
When unspecified or empty string, core API group is inferred.
maxLength: 253
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
kind:
description: Kind is kind of the referent. For example
"HTTPRoute" or "Service".
maxLength: 63
minLength: 1
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
type: string
name:
description: Name is the name of the referent.
maxLength: 253
minLength: 1
type: string
required:
- group
- kind
- name
type: object
required:
- type
type: object
x-kubernetes-validations:
- message: inline must be set for type Inline
rule: '(!has(self.type) || self.type == ''Inline'')? has(self.inline)
: true'
- message: valueRef must be set for type ValueRef
rule: '(has(self.type) && self.type == ''ValueRef'')?
has(self.valueRef) : true'
- message: only ConfigMap is supported for ValueRef
rule: 'has(self.valueRef) ? self.valueRef.kind == ''ConfigMap''
: true'
contentType:
description: Content Type of the response. This will be
set in the Content-Type header.
type: string
header:
description: |-
Header defines headers to add, set or remove from the response.
This allows the response policy to append, add or override headers
of the final response before it is sent to a downstream client.
Note: Header removal is not supported for responseOverride.
properties:
add:
description: |-
Add adds the given header(s) (name, value) to the request
before the action. It appends to any existing values associated
with the header name.
Input:
GET /foo HTTP/1.1
my-header: foo
Config:
add:
- name: "my-header"
value: "bar,baz"
Output:
GET /foo HTTP/1.1
my-header: foo,bar,baz
items:
description: HTTPHeader represents an HTTP Header
name and value as defined by RFC 7230.
properties:
name:
description: |-
Name is the name of the HTTP Header to be matched. Name matching MUST be
case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with
an equivalent name MUST be considered for a match. Subsequent entries
with an equivalent header name MUST be ignored. Due to the
case-insensitivity of header names, "foo" and "Foo" are considered
equivalent.
maxLength: 256
minLength: 1
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
value:
description: Value is the value of HTTP Header
to be matched.
maxLength: 4096
minLength: 1
type: string
required:
- name
- value
type: object
maxItems: 16
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
remove:
description: |-
Remove the given header(s) from the HTTP request before the action. The
value of Remove is a list of HTTP header names. Note that the header
names are case-insensitive (see
https://datatracker.ietf.org/doc/html/rfc2616#section-4.2).
Input:
GET /foo HTTP/1.1
my-header1: foo
my-header2: bar
my-header3: baz
Config:
remove: ["my-header1", "my-header3"]
Output:
GET /foo HTTP/1.1
my-header2: bar
items:
type: string
maxItems: 16
type: array
x-kubernetes-list-type: set
set:
description: |-
Set overwrites the request with the given header (name, value)
before the action.
Input:
GET /foo HTTP/1.1
my-header: foo
Config:
set:
- name: "my-header"
value: "bar"
Output:
GET /foo HTTP/1.1
my-header: bar
items:
description: HTTPHeader represents an HTTP Header
name and value as defined by RFC 7230.
properties:
name:
description: |-
Name is the name of the HTTP Header to be matched. Name matching MUST be
case-insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
If multiple entries specify equivalent header names, the first entry with
an equivalent name MUST be considered for a match. Subsequent entries
with an equivalent header name MUST be ignored. Due to the
case-insensitivity of header names, "foo" and "Foo" are considered
equivalent.
maxLength: 256
minLength: 1
pattern: ^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$
type: string
value:
description: Value is the value of HTTP Header
to be matched.
maxLength: 4096
minLength: 1
type: string
required:
- name
- value
type: object
maxItems: 16
type: array
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
type: object
x-kubernetes-validations:
- message: Remove is not supported for header in CustomResponse
rule: '!has(self.remove) || size(self.remove) == 0'
statusCode:
description: |-
Status Code of the Custom Response
If unset, does not override the status of response.
type: integer
type: object
required:
- match
type: object
x-kubernetes-validations:
- message: exactly one of response or redirect must be specified
rule: (has(self.response) && !has(self.redirect)) || (!has(self.response)
&& has(self.redirect))
type: array
retry:
description: |-
Retry provides more advanced usage, allowing users to customize the number of retries, retry fallback strategy, and retry triggering conditions.
If not set, retry will be disabled.
properties:
numAttemptsPerPriority:
description: |-
NumAttemptsPerPriority defines the number of requests (initial attempt + retries)
that should be sent to the same priority before switching to a different one.
If not specified or set to 0, all requests are sent to the highest priority that is healthy.
format: int32
type: integer
numRetries:
default: 2
description: NumRetries is the number of retries to be attempted.
Defaults to 2.
format: int32
minimum: 0
type: integer
perRetry:
description: PerRetry is the retry policy to be applied per retry
attempt.
properties:
backOff:
description: |-
Backoff is the backoff policy to be applied per retry attempt. gateway uses a fully jittered exponential
back-off algorithm for retries. For additional details,
see https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#config-http-filters-router-x-envoy-max-retries
properties:
baseInterval:
description: BaseInterval is the base interval between
retries.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
maxInterval:
description: |-
MaxInterval is the maximum interval between retries. This parameter is optional, but must be greater than or equal to the base_interval if set.
The default is 10 times the base_interval
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
type: object
timeout:
description: Timeout is the timeout per retry attempt.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
type: object
retryOn:
description: |-
RetryOn specifies the retry trigger condition.
If not specified, the default is to retry on connect-failure,refused-stream,unavailable,cancelled,retriable-status-codes(503).
properties:
httpStatusCodes:
description: |-
HttpStatusCodes specifies the http status codes to be retried.
The retriable-status-codes trigger must also be configured for these status codes to trigger a retry.
items:
description: HTTPStatus defines the http status code.
maximum: 599
minimum: 100
type: integer
type: array
triggers:
description: Triggers specifies the retry trigger condition(Http/Grpc).
items:
description: TriggerEnum specifies the conditions that trigger
retries.
enum:
- 5xx
- gateway-error
- reset
- reset-before-request
- connect-failure
- retriable-4xx
- refused-stream
- retriable-status-codes
- cancelled
- deadline-exceeded
- internal
- resource-exhausted
- unavailable
type: string
type: array
type: object
type: object
targetRef:
description: |-
TargetRef is the name of the resource this policy is being attached to.
This policy and the TargetRef MUST be in the same namespace for this
Policy to have effect
Deprecated: use targetRefs/targetSelectors instead
properties:
group:
description: Group is the group of the target resource.
maxLength: 253
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
kind:
description: Kind is kind of the target resource.
maxLength: 63
minLength: 1
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
type: string
name:
description: Name is the name of the target resource.
maxLength: 253
minLength: 1
type: string
sectionName:
description: |-
SectionName is the name of a section within the target resource. When
unspecified, this targetRef targets the entire resource. In the following
resources, SectionName is interpreted as the following:
* Gateway: Listener name
* HTTPRoute: HTTPRouteRule name
* Service: Port name
If a SectionName is specified, but does not exist on the targeted object,
the Policy must fail to attach, and the policy implementation should record
a `ResolvedRefs` or similar Condition in the Policy's status.
maxLength: 253
minLength: 1
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
required:
- group
- kind
- name
type: object
targetRefs:
description: |-
TargetRefs are the names of the Gateway resources this policy
is being attached to.
items:
description: |-
LocalPolicyTargetReferenceWithSectionName identifies an API object to apply a
direct policy to. This should be used as part of Policy resources that can
target single resources. For more information on how this policy attachment
mode works, and a sample Policy resource, refer to the policy attachment
documentation for Gateway API.
Note: This should only be used for direct policy attachment when references
to SectionName are actually needed. In all other cases,
LocalPolicyTargetReference should be used.
properties:
group:
description: Group is the group of the target resource.
maxLength: 253
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
kind:
description: Kind is kind of the target resource.
maxLength: 63
minLength: 1
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
type: string
name:
description: Name is the name of the target resource.
maxLength: 253
minLength: 1
type: string
sectionName:
description: |-
SectionName is the name of a section within the target resource. When
unspecified, this targetRef targets the entire resource. In the following
resources, SectionName is interpreted as the following:
* Gateway: Listener name
* HTTPRoute: HTTPRouteRule name
* Service: Port name
If a SectionName is specified, but does not exist on the targeted object,
the Policy must fail to attach, and the policy implementation should record
a `ResolvedRefs` or similar Condition in the Policy's status.
maxLength: 253
minLength: 1
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
required:
- group
- kind
- name
type: object
type: array
targetSelectors:
description: TargetSelectors allow targeting resources for this policy
based on labels
items:
properties:
group:
default: gateway.networking.k8s.io
description: Group is the group that this selector targets.
Defaults to gateway.networking.k8s.io
maxLength: 253
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
kind:
description: Kind is the resource kind that this selector targets.
maxLength: 63
minLength: 1
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
type: string
matchExpressions:
description: MatchExpressions is a list of label selector requirements.
The requirements are ANDed.
items:
description: |-
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
properties:
key:
description: key is the label key that the selector applies
to.
type: string
operator:
description: |-
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
type: string
values:
description: |-
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
items:
type: string
type: array
x-kubernetes-list-type: atomic
required:
- key
- operator
type: object
type: array
x-kubernetes-list-type: atomic
matchLabels:
additionalProperties:
type: string
description: MatchLabels are the set of label selectors for
identifying the targeted resource
type: object
required:
- kind
type: object
x-kubernetes-validations:
- message: group must be gateway.networking.k8s.io
rule: 'has(self.group) ? self.group == ''gateway.networking.k8s.io''
: true '
type: array
tcpKeepalive:
description: |-
TcpKeepalive settings associated with the upstream client connection.
Disabled by default.
properties:
idleTime:
description: |-
The duration a connection needs to be idle before keep-alive
probes start being sent.
The duration format is
Defaults to `7200s`.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
interval:
description: |-
The duration between keep-alive probes.
Defaults to `75s`.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
probes:
description: |-
The total number of unacknowledged probes to send before deciding
the connection is dead.
Defaults to 9.
format: int32
type: integer
type: object
telemetry:
description: |-
Telemetry configures the telemetry settings for the policy target (Gateway or xRoute).
This will override the telemetry settings in the EnvoyProxy resource.
properties:
tracing:
description: Tracing configures the tracing settings for the backend
or HTTPRoute.
properties:
customTags:
additionalProperties:
properties:
environment:
description: |-
Environment adds value from environment variable to each span.
It's required when the type is "Environment".
properties:
defaultValue:
description: DefaultValue defines the default value
to use if the environment variable is not set.
type: string
name:
description: Name defines the name of the environment
variable which to extract the value from.
type: string
required:
- name
type: object
literal:
description: |-
Literal adds hard-coded value to each span.
It's required when the type is "Literal".
properties:
value:
description: Value defines the hard-coded value
to add to each span.
type: string
required:
- value
type: object
requestHeader:
description: |-
RequestHeader adds value from request header to each span.
It's required when the type is "RequestHeader".
properties:
defaultValue:
description: DefaultValue defines the default value
to use if the request header is not set.
type: string
name:
description: Name defines the name of the request
header which to extract the value from.
type: string
required:
- name
type: object
type:
default: Literal
description: Type defines the type of custom tag.
enum:
- Literal
- Environment
- RequestHeader
type: string
required:
- type
type: object
description: |-
CustomTags defines the custom tags to add to each span.
If provider is kubernetes, pod name and namespace are added by default.
type: object
samplingFraction:
description: |-
SamplingFraction represents the fraction of requests that should be
selected for tracing if no prior sampling decision has been made.
This will take precedence over sampling fraction on EnvoyProxy if set.
properties:
denominator:
default: 100
format: int32
minimum: 1
type: integer
numerator:
format: int32
minimum: 0
type: integer
required:
- numerator
type: object
x-kubernetes-validations:
- message: numerator must be less than or equal to denominator
rule: self.numerator <= self.denominator
type: object
type: object
timeout:
description: Timeout settings for the backend connections.
properties:
http:
description: Timeout settings for HTTP.
properties:
connectionIdleTimeout:
description: |-
The idle timeout for an HTTP connection. Idle time is defined as a period in which there are no active requests in the connection.
Default: 1 hour.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
maxConnectionDuration:
description: |-
The maximum duration of an HTTP connection.
Default: unlimited.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
maxStreamDuration:
description: |-
MaxStreamDuration is the maximum duration for a stream to complete. This timeout measures the time
from when the request is sent until the response stream is fully consumed and does not apply to
non-streaming requests.
When set to "0s", no max duration is applied and streams can run indefinitely.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
requestTimeout:
description: RequestTimeout is the time until which entire
response is received from the upstream.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
type: object
tcp:
description: Timeout settings for TCP.
properties:
connectTimeout:
description: |-
The timeout for network connection establishment, including TCP and TLS handshakes.
Default: 10 seconds.
pattern: ^([0-9]{1,5}(h|m|s|ms)){1,4}$
type: string
type: object
type: object
useClientProtocol:
description: |-
UseClientProtocol configures Envoy to prefer sending requests to backends using
the same HTTP protocol that the incoming request used. Defaults to false, which means
that Envoy will use the protocol indicated by the attached BackendRef.
type: boolean
type: object
x-kubernetes-validations:
- message: either targetRef or targetRefs must be used
rule: '(has(self.targetRef) && !has(self.targetRefs)) || (!has(self.targetRef)
&& has(self.targetRefs)) || (has(self.targetSelectors) && self.targetSelectors.size()
> 0) '
- message: this policy can only have a targetRef.group of gateway.networking.k8s.io
rule: 'has(self.targetRef) ? self.targetRef.group == ''gateway.networking.k8s.io''
: true '
- message: this policy can only have a targetRef.kind of Gateway/HTTPRoute/GRPCRoute/TCPRoute/UDPRoute/TLSRoute
rule: 'has(self.targetRef) ? self.targetRef.kind in [''Gateway'', ''HTTPRoute'',
''GRPCRoute'', ''UDPRoute'', ''TCPRoute'', ''TLSRoute''] : true'
- message: this policy can only have a targetRefs[*].group of gateway.networking.k8s.io
rule: 'has(self.targetRefs) ? self.targetRefs.all(ref, ref.group ==
''gateway.networking.k8s.io'') : true '
- message: this policy can only have a targetRefs[*].kind of Gateway/HTTPRoute/GRPCRoute/TCPRoute/UDPRoute/TLSRoute
rule: 'has(self.targetRefs) ? self.targetRefs.all(ref, ref.kind in [''Gateway'',
''HTTPRoute'', ''GRPCRoute'', ''UDPRoute'', ''TCPRoute'', ''TLSRoute''])
: true '
- message: either compression or compressor can be set, not both
rule: '!has(self.compression) || !has(self.compressor)'
- message: predictivePercent in preconnect policy only works with RoundRobin
or Random load balancers
rule: '!((has(self.connection) && has(self.connection.preconnect) &&
has(self.connection.preconnect.predictivePercent)) && !(has(self.loadBalancer)
&& has(self.loadBalancer.type) && self.loadBalancer.type in [''Random'',
''RoundRobin'']))'
status:
description: status defines the current status of BackendTrafficPolicy.
properties:
ancestors:
description: |-
Ancestors is a list of ancestor resources (usually Gateways) that are
associated with the policy, and the status of the policy with respect to
each ancestor. When this policy attaches to a parent, the controller that
manages the parent and the ancestors MUST add an entry to this list when
the controller first sees the policy and SHOULD update the entry as
appropriate when the relevant ancestor is modified.
Note that choosing the relevant ancestor is left to the Policy designers;
an important part of Policy design is designing the right object level at
which to namespace this status.
Note also that implementations MUST ONLY populate ancestor status for
the Ancestor resources they are responsible for. Implementations MUST
use the ControllerName field to uniquely identify the entries in this list
that they are responsible for.
Note that to achieve this, the list of PolicyAncestorStatus structs
MUST be treated as a map with a composite key, made up of the AncestorRef
and ControllerName fields combined.
A maximum of 16 ancestors will be represented in this list. An empty list
means the Policy is not relevant for any ancestors.
If this slice is full, implementations MUST NOT add further entries.
Instead they MUST consider the policy unimplementable and signal that
on any related resources such as the ancestor that would be referenced
here. For example, if this list was full on BackendTLSPolicy, no
additional Gateways would be able to reference the Service targeted by
the BackendTLSPolicy.
items:
description: |-
PolicyAncestorStatus describes the status of a route with respect to an
associated Ancestor.
Ancestors refer to objects that are either the Target of a policy or above it
in terms of object hierarchy. For example, if a policy targets a Service, the
Policy's Ancestors are, in order, the Service, the HTTPRoute, the Gateway, and
the GatewayClass. Almost always, in this hierarchy, the Gateway will be the most
useful object to place Policy status on, so we recommend that implementations
SHOULD use Gateway as the PolicyAncestorStatus object unless the designers
have a _very_ good reason otherwise.
In the context of policy attachment, the Ancestor is used to distinguish which
resource results in a distinct application of this policy. For example, if a policy
targets a Service, it may have a distinct result per attached Gateway.
Policies targeting the same resource may have different effects depending on the
ancestors of those resources. For example, different Gateways targeting the same
Service may have different capabilities, especially if they have different underlying
implementations.
For example, in BackendTLSPolicy, the Policy attaches to a Service that is
used as a backend in a HTTPRoute that is itself attached to a Gateway.
In this case, the relevant object for status is the Gateway, and that is the
ancestor object referred to in this status.
Note that a parent is also an ancestor, so for objects where the parent is the
relevant object for status, this struct SHOULD still be used.
This struct is intended to be used in a slice that's effectively a map,
with a composite key made up of the AncestorRef and the ControllerName.
properties:
ancestorRef:
description: |-
AncestorRef corresponds with a ParentRef in the spec that this
PolicyAncestorStatus struct describes the status of.
properties:
group:
default: gateway.networking.k8s.io
description: |-
Group is the group of the referent.
When unspecified, "gateway.networking.k8s.io" is inferred.
To set the core API group (such as for a "Service" kind referent),
Group must be explicitly set to "" (empty string).
Support: Core
maxLength: 253
pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
kind:
default: Gateway
description: |-
Kind is kind of the referent.
There are two kinds of parent resources with "Core" support:
* Gateway (Gateway conformance profile)
* Service (Mesh conformance profile, ClusterIP Services only)
Support for other resources is Implementation-Specific.
maxLength: 63
minLength: 1
pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
type: string
name:
description: |-
Name is the name of the referent.
Support: Core
maxLength: 253
minLength: 1
type: string
namespace:
description: |-
Namespace is the namespace of the referent. When unspecified, this refers
to the local namespace of the Route.
Note that there are specific rules for ParentRefs which cross namespace
boundaries. Cross-namespace references are only valid if they are explicitly
allowed by something in the namespace they are referring to. For example:
Gateway has the AllowedRoutes field, and ReferenceGrant provides a
generic way to enable any other kind of cross-namespace reference.
<gateway:experimental:description>
ParentRefs from a Route to a Service in the same namespace are "producer"
routes, which apply default routing rules to inbound connections from
any namespace to the Service.
ParentRefs from a Route to a Service in a different namespace are
"consumer" routes, and these routing rules are only applied to outbound
connections originating from the same namespace as the Route, for which
the intended destination of the connections are a Service targeted as a
ParentRef of the Route.
</gateway:experimental:description>
Support: Core
maxLength: 63
minLength: 1
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
port:
description: |-
Port is the network port this Route targets. It can be interpreted
differently based on the type of parent resource.
When the parent resource is a Gateway, this targets all listeners
listening on the specified port that also support this kind of Route(and
select this Route). It's not recommended to set `Port` unless the
networking behaviors specified in a Route must apply to a specific port
as opposed to a listener(s) whose port(s) may be changed. When both Port
and SectionName are specified, the name and port of the selected listener
must match both specified values.
<gateway:experimental:description>
When the parent resource is a Service, this targets a specific port in the
Service spec. When both Port (experimental) and SectionName are specified,
the name and port of the selected port must match both specified values.
</gateway:experimental:description>
Implementations MAY choose to support other parent resources.
Implementations supporting other types of parent resources MUST clearly
document how/if Port is interpreted.
For the purpose of status, an attachment is considered successful as
long as the parent resource accepts it partially. For example, Gateway
listeners can restrict which Routes can attach to them by Route kind,
namespace, or hostname. If 1 of 2 Gateway listeners accept attachment
from the referencing Route, the Route MUST be considered successfully
attached. If no Gateway listeners accept attachment from this Route,
the Route MUST be considered detached from the Gateway.
Support: Extended
format: int32
maximum: 65535
minimum: 1
type: integer
sectionName:
description: |-
SectionName is the name of a section within the target resource. In the
following resources, SectionName is interpreted as the following:
* Gateway: Listener name. When both Port (experimental) and SectionName
are specified, the name and port of the selected listener must match
both specified values.
* Service: Port name. When both Port (experimental) and SectionName
are specified, the name and port of the selected listener must match
both specified values.
Implementations MAY choose to support attaching Routes to other resources.
If that is the case, they MUST clearly document how SectionName is
interpreted.
When unspecified (empty string), this will reference the entire resource.
For the purpose of status, an attachment is considered successful if at
least one section in the parent resource accepts it. For example, Gateway
listeners can restrict which Routes can attach to them by Route kind,
namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from
the referencing Route, the Route MUST be considered successfully
attached. If no Gateway listeners accept attachment from this Route, the
Route MUST be considered detached from the Gateway.
Support: Core
maxLength: 253
minLength: 1
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
type: string
required:
- name
type: object
conditions:
description: |-
Conditions describes the status of the Policy with respect to the given Ancestor.
<gateway:util:excludeFromCRD>
Notes for implementors:
Conditions are a listType `map`, which means that they function like a
map with a key of the `type` field _in the k8s apiserver_.
This means that implementations must obey some rules when updating this
section.
* Implementations MUST perform a read-modify-write cycle on this field
before modifying it. That is, when modifying this field, implementations
must be confident they have fetched the most recent version of this field,
and ensure that changes they make are on that recent version.
* Implementations MUST NOT remove or reorder Conditions that they are not
directly responsible for. For example, if an implementation sees a Condition
with type `special.io/SomeField`, it MUST NOT remove, change or update that
Condition.
* Implementations MUST always _merge_ changes into Conditions of the same Type,
rather than creating more than one Condition of the same Type.
* Implementations MUST always update the `observedGeneration` field of the
Condition to the `metadata.generation` of the Gateway at the time of update creation.
* If the `observedGeneration` of a Condition is _greater than_ the value the
implementation knows about, then it MUST NOT perform the update on that Condition,
but must wait for a future reconciliation and status update. (The assumption is that
the implementation's copy of the object is stale and an update will be re-triggered
if relevant.)
</gateway:util:excludeFromCRD>
items:
description: Condition contains details for one aspect of
the current state of this API Resource.
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: |-
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False,
Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase.
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
maxItems: 8
minItems: 1
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
controllerName:
description: |-
ControllerName is a domain/path string that indicates the name of the
controller that wrote this status. This corresponds with the
controllerName field on GatewayClass.
Example: "example.net/gateway-controller".
The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are
valid Kubernetes names
(https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names).
Controllers MUST populate this field when writing status. Controllers should ensure that
entries to status populated with their ControllerName are cleaned up when they are no
longer necessary.
maxLength: 253
minLength: 1
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$
type: string
required:
- ancestorRef
- conditions
- controllerName
type: object
maxItems: 16
type: array
x-kubernetes-list-type: atomic
required:
- ancestors
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}
Reference in New Issue View Git Blame Copy Permalink