2023-03-20 14:38:08 +00:00
---
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
2024-02-07 16:14:07 +00:00
controller-gen.kubebuilder.io/version : v0.14.0
2023-03-20 14:38:08 +00:00
name : middlewares.traefik.io
spec :
group : traefik.io
names :
kind : Middleware
listKind : MiddlewareList
plural : middlewares
singular : middleware
scope : Namespaced
versions :
- name : v1alpha1
schema :
openAPIV3Schema :
2024-02-07 16:14:07 +00:00
description : |-
Middleware is the CRD implementation of a Traefik Middleware.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/overview/
2023-03-20 14:38:08 +00:00
properties :
apiVersion :
2024-02-07 16:14:07 +00:00
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
2023-03-20 14:38:08 +00:00
type : string
kind :
2024-02-07 16:14:07 +00:00
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
2023-03-20 14:38:08 +00:00
type : string
metadata :
type : object
spec :
description : MiddlewareSpec defines the desired state of a Middleware.
properties :
addPrefix :
2024-02-07 16:14:07 +00:00
description : |-
AddPrefix holds the add prefix middleware configuration.
This middleware updates the path of a request before forwarding it.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/addprefix/
2023-03-20 14:38:08 +00:00
properties :
prefix :
2024-02-07 16:14:07 +00:00
description : |-
Prefix is the string to add before the current path in the requested URL.
It should include a leading slash (/).
2023-03-20 14:38:08 +00:00
type : string
type : object
basicAuth :
2024-02-07 16:14:07 +00:00
description : |-
BasicAuth holds the basic auth middleware configuration.
2023-03-20 14:38:08 +00:00
This middleware restricts access to your services to known users.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/basicauth/
2023-03-20 14:38:08 +00:00
properties :
headerField :
2024-02-07 16:14:07 +00:00
description : |-
HeaderField defines a header field to store the authenticated user.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/basicauth/#headerfield
2023-03-20 14:38:08 +00:00
type : string
realm :
2024-02-07 16:14:07 +00:00
description : |-
Realm allows the protected resources on a server to be partitioned into a set of protection spaces, each with its own authentication scheme.
Default : traefik.
2023-03-20 14:38:08 +00:00
type : string
removeHeader :
2024-02-07 16:14:07 +00:00
description : |-
RemoveHeader sets the removeHeader option to true to remove the authorization header before forwarding the request to your service.
Default : false .
2023-03-20 14:38:08 +00:00
type : boolean
secret :
description : Secret is the name of the referenced Kubernetes Secret
containing user credentials.
type : string
type : object
buffering :
2024-02-07 16:14:07 +00:00
description : |-
Buffering holds the buffering middleware configuration.
This middleware retries or limits the size of requests that can be forwarded to backends.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/buffering/#maxrequestbodybytes
2023-03-20 14:38:08 +00:00
properties :
maxRequestBodyBytes :
2024-02-07 16:14:07 +00:00
description : |-
MaxRequestBodyBytes defines the maximum allowed body size for the request (in bytes).
If the request exceeds the allowed size, it is not forwarded to the service, and the client gets a 413 (Request Entity Too Large) response.
Default : 0 (no maximum).
2023-03-20 14:38:08 +00:00
format : int64
type : integer
maxResponseBodyBytes :
2024-02-07 16:14:07 +00:00
description : |-
MaxResponseBodyBytes defines the maximum allowed response size from the service (in bytes).
If the response exceeds the allowed size, it is not forwarded to the client. The client gets a 500 (Internal Server Error) response instead.
Default : 0 (no maximum).
2023-03-20 14:38:08 +00:00
format : int64
type : integer
memRequestBodyBytes :
2024-02-07 16:14:07 +00:00
description : |-
MemRequestBodyBytes defines the threshold (in bytes) from which the request will be buffered on disk instead of in memory.
Default : 1048576 (1Mi).
2023-03-20 14:38:08 +00:00
format : int64
type : integer
memResponseBodyBytes :
2024-02-07 16:14:07 +00:00
description : |-
MemResponseBodyBytes defines the threshold (in bytes) from which the response will be buffered on disk instead of in memory.
Default : 1048576 (1Mi).
2023-03-20 14:38:08 +00:00
format : int64
type : integer
retryExpression :
2024-02-07 16:14:07 +00:00
description : |-
RetryExpression defines the retry conditions.
It is a logical combination of functions with operators AND (&&) and OR (||).
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/buffering/#retryexpression
2023-03-20 14:38:08 +00:00
type : string
type : object
chain :
2024-02-07 16:14:07 +00:00
description : |-
Chain holds the configuration of the chain middleware.
This middleware enables to define reusable combinations of other pieces of middleware.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/chain/
2023-03-20 14:38:08 +00:00
properties :
middlewares :
description : Middlewares is the list of MiddlewareRef which composes
the chain.
items :
description : MiddlewareRef is a reference to a Middleware resource.
properties :
name :
description : Name defines the name of the referenced Middleware
resource.
type : string
namespace :
description : Namespace defines the namespace of the referenced
Middleware resource.
type : string
required :
- name
type : object
type : array
type : object
circuitBreaker :
description : CircuitBreaker holds the circuit breaker configuration.
properties :
checkPeriod :
anyOf :
- type : integer
- type : string
description : CheckPeriod is the interval between successive checks
of the circuit breaker condition (when in standby state).
x-kubernetes-int-or-string : true
expression :
description : Expression is the condition that triggers the tripped
state.
type : string
fallbackDuration :
anyOf :
- type : integer
- type : string
description : FallbackDuration is the duration for which the circuit
breaker will wait before trying to recover (from a tripped state).
x-kubernetes-int-or-string : true
recoveryDuration :
anyOf :
- type : integer
- type : string
description : RecoveryDuration is the duration for which the circuit
breaker will try to recover (as soon as it is in recovering
state).
x-kubernetes-int-or-string : true
2024-04-19 09:26:05 +00:00
responseCode :
description : ResponseCode is the status code that the circuit
breaker will return while it is in the open state.
type : integer
2023-03-20 14:38:08 +00:00
type : object
compress :
2024-02-07 16:14:07 +00:00
description : |-
Compress holds the compress middleware configuration.
This middleware compresses responses before sending them to the client, using gzip compression.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/compress/
2023-03-20 14:38:08 +00:00
properties :
2024-06-06 14:42:04 +00:00
defaultEncoding :
description : DefaultEncoding specifies the default encoding if
the `Accept-Encoding` header is not in the request or contains
a wildcard (`*`).
type : string
2023-03-20 14:38:08 +00:00
excludedContentTypes :
2024-02-08 13:15:45 +00:00
description : |-
ExcludedContentTypes defines the list of content types to compare the Content-Type header of the incoming requests and responses before compressing.
`application/grpc` is always excluded.
2023-03-20 14:38:08 +00:00
items :
type : string
type : array
2024-01-17 10:32:06 +00:00
includedContentTypes :
description : IncludedContentTypes defines the list of content
types to compare the Content-Type header of the responses before
compressing.
items :
type : string
type : array
2023-03-20 14:38:08 +00:00
minResponseBodyBytes :
2024-02-07 16:14:07 +00:00
description : |-
MinResponseBodyBytes defines the minimum amount of bytes a response body must have to be compressed.
Default : 1024 .
2023-03-20 14:38:08 +00:00
type : integer
type : object
contentType :
2024-02-07 16:14:07 +00:00
description : |-
ContentType holds the content-type middleware configuration.
This middleware exists to enable the correct behavior until at least the default one can be changed in a future version.
2024-01-29 16:32:05 +00:00
properties :
autoDetect :
2024-02-07 16:14:07 +00:00
description : |-
AutoDetect specifies whether to let the `Content-Type` header, if it has not been set by the backend,
be automatically set to a value derived from the contents of the response.
2024-02-08 13:15:45 +00:00
Deprecated : AutoDetect option is deprecated, Content-Type middleware is only meant to be used to enable the content-type detection, please remove any usage of this option.
2024-01-29 16:32:05 +00:00
type : boolean
2023-03-20 14:38:08 +00:00
type : object
digestAuth :
2024-02-07 16:14:07 +00:00
description : |-
DigestAuth holds the digest auth middleware configuration.
2023-03-20 14:38:08 +00:00
This middleware restricts access to your services to known users.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/digestauth/
2023-03-20 14:38:08 +00:00
properties :
headerField :
2024-02-07 16:14:07 +00:00
description : |-
HeaderField defines a header field to store the authenticated user.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/basicauth/#headerfield
2023-03-20 14:38:08 +00:00
type : string
realm :
2024-02-07 16:14:07 +00:00
description : |-
Realm allows the protected resources on a server to be partitioned into a set of protection spaces, each with its own authentication scheme.
Default : traefik.
2023-03-20 14:38:08 +00:00
type : string
removeHeader :
description : RemoveHeader defines whether to remove the authorization
header before forwarding the request to the backend.
type : boolean
secret :
description : Secret is the name of the referenced Kubernetes Secret
containing user credentials.
type : string
type : object
errors :
2024-02-07 16:14:07 +00:00
description : |-
ErrorPage holds the custom error middleware configuration.
This middleware returns a custom page in lieu of the default, according to configured ranges of HTTP Status codes.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/errorpages/
2023-03-20 14:38:08 +00:00
properties :
query :
2024-02-07 16:14:07 +00:00
description : |-
Query defines the URL for the error page (hosted by service).
The {status} variable can be used in order to insert the status code in the URL.
2023-03-20 14:38:08 +00:00
type : string
service :
2024-02-07 16:14:07 +00:00
description : |-
Service defines the reference to a Kubernetes Service that will serve the error page.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/errorpages/#service
2023-03-20 14:38:08 +00:00
properties :
2024-05-30 15:18:05 +00:00
healthCheck :
2024-06-04 07:32:04 +00:00
description : Healthcheck defines health checks for ExternalName
services.
2024-05-30 15:18:05 +00:00
properties :
followRedirects :
2024-06-04 07:32:04 +00:00
description : |-
FollowRedirects defines whether redirects should be followed during the health check calls.
Default : true
2024-05-30 15:18:05 +00:00
type : boolean
headers :
additionalProperties :
type : string
2024-06-04 07:32:04 +00:00
description : Headers defines custom headers to be sent
to the health check endpoint.
2024-05-30 15:18:05 +00:00
type : object
hostname :
2024-06-04 07:32:04 +00:00
description : Hostname defines the value of hostname in
the Host header of the health check request.
2024-05-30 15:18:05 +00:00
type : string
interval :
2024-06-04 07:32:04 +00:00
anyOf :
- type : integer
- type : string
2024-05-30 15:18:05 +00:00
description : |-
2024-06-04 07:32:04 +00:00
Interval defines the frequency of the health check calls.
Default : 30s
x-kubernetes-int-or-string : true
2024-05-30 15:18:05 +00:00
method :
2024-06-04 07:32:04 +00:00
description : Method defines the healthcheck method.
2024-05-30 15:18:05 +00:00
type : string
mode :
2024-06-04 07:32:04 +00:00
description : |-
Mode defines the health check mode.
If defined to grpc, will use the gRPC health check protocol to probe the server.
Default : http
2024-05-30 15:18:05 +00:00
type : string
path :
2024-06-04 07:32:04 +00:00
description : Path defines the server URL path for the
health check endpoint.
2024-05-30 15:18:05 +00:00
type : string
port :
2024-06-04 07:32:04 +00:00
description : Port defines the server URL port for the
health check endpoint.
2024-05-30 15:18:05 +00:00
type : integer
scheme :
2024-06-04 07:32:04 +00:00
description : Scheme replaces the server URL scheme for
the health check endpoint.
2024-05-30 15:18:05 +00:00
type : string
status :
2024-06-04 07:32:04 +00:00
description : Status defines the expected HTTP status code
of the response to the health check request.
2024-05-30 15:18:05 +00:00
type : integer
timeout :
2024-06-04 07:32:04 +00:00
anyOf :
- type : integer
- type : string
2024-05-30 15:18:05 +00:00
description : |-
2024-06-04 07:32:04 +00:00
Timeout defines the maximum duration Traefik will wait for a health check request before considering the server unhealthy.
Default : 5s
x-kubernetes-int-or-string : true
2024-05-30 15:18:05 +00:00
type : object
2023-03-20 14:38:08 +00:00
kind :
description : Kind defines the kind of the Service.
enum :
- Service
- TraefikService
type : string
name :
2024-02-07 16:14:07 +00:00
description : |-
Name defines the name of the referenced Kubernetes Service or TraefikService.
The differentiation between the two is specified in the Kind field.
2023-03-20 14:38:08 +00:00
type : string
namespace :
description : Namespace defines the namespace of the referenced
Kubernetes Service or TraefikService.
type : string
2023-03-20 15:46:05 +00:00
nativeLB :
2024-02-07 16:14:07 +00:00
description : |-
NativeLB controls, when creating the load-balancer,
whether the LB's children are directly the pods IPs or if the only child is the Kubernetes Service clusterIP.
The Kubernetes Service itself does load-balance to the pods.
2023-03-20 15:46:05 +00:00
By default, NativeLB is false.
type : boolean
2024-02-27 09:54:04 +00:00
nodePortLB :
description : |-
NodePortLB controls, when creating the load-balancer,
whether the LB's children are directly the nodes internal IPs using the nodePort when the service type is NodePort.
It allows services to be reachable when Traefik runs externally from the Kubernetes cluster but within the same network of the nodes.
By default, NodePortLB is false.
type : boolean
2023-03-20 14:38:08 +00:00
passHostHeader :
2024-02-07 16:14:07 +00:00
description : |-
PassHostHeader defines whether the client Host header is forwarded to the upstream Kubernetes Service.
2023-03-20 14:38:08 +00:00
By default, passHostHeader is true.
type : boolean
port :
anyOf :
- type : integer
- type : string
2024-02-07 16:14:07 +00:00
description : |-
Port defines the port of a Kubernetes Service.
2023-03-20 14:38:08 +00:00
This can be a reference to a named port.
x-kubernetes-int-or-string : true
responseForwarding :
description : ResponseForwarding defines how Traefik forwards
the response from the upstream Kubernetes Service to the
client.
properties :
flushInterval :
2024-02-07 16:14:07 +00:00
description : |-
FlushInterval defines the interval, in milliseconds, in between flushes to the client while copying the response body.
A negative value means to flush immediately after each write to the client.
This configuration is ignored when ReverseProxy recognizes a response as a streaming response;
for such responses, writes are flushed to the client immediately.
Default : 100ms
2023-03-20 14:38:08 +00:00
type : string
type : object
scheme :
2024-02-07 16:14:07 +00:00
description : |-
Scheme defines the scheme to use for the request to the upstream Kubernetes Service.
It defaults to https when Kubernetes Service port is 443, http otherwise.
2023-03-20 14:38:08 +00:00
type : string
serversTransport :
2024-02-07 16:14:07 +00:00
description : |-
ServersTransport defines the name of ServersTransport resource to use.
It allows to configure the transport between Traefik and your servers.
Can only be used on a Kubernetes Service.
2023-03-20 14:38:08 +00:00
type : string
sticky :
2024-02-07 16:14:07 +00:00
description : |-
Sticky defines the sticky sessions configuration.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/routing/services/#sticky-sessions
2023-03-20 14:38:08 +00:00
properties :
cookie :
description : Cookie defines the sticky cookie configuration.
properties :
httpOnly :
description : HTTPOnly defines whether the cookie can
be accessed by client-side APIs, such as JavaScript.
type : boolean
2024-01-18 08:30:06 +00:00
maxAge :
2024-02-08 13:15:45 +00:00
description : |-
MaxAge indicates the number of seconds until the cookie expires.
When set to a negative number, the cookie expires immediately.
When set to zero, the cookie never expires.
2024-01-18 08:30:06 +00:00
type : integer
2023-03-20 14:38:08 +00:00
name :
description : Name defines the Cookie name.
type : string
sameSite :
2024-02-07 16:14:07 +00:00
description : |-
SameSite defines the same site policy.
More info : https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
2023-03-20 14:38:08 +00:00
type : string
secure :
description : Secure defines whether the cookie can
only be transmitted over an encrypted connection
(i.e. HTTPS).
type : boolean
type : object
type : object
strategy :
2024-02-07 16:14:07 +00:00
description : |-
Strategy defines the load balancing strategy between the servers.
RoundRobin is the only supported value at the moment.
2023-03-20 14:38:08 +00:00
type : string
weight :
2024-02-07 16:14:07 +00:00
description : |-
Weight defines the weight and should only be specified when Name references a TraefikService object
(and to be precise, one that embeds a Weighted Round Robin).
2023-03-20 14:38:08 +00:00
type : integer
required :
- name
type : object
status :
2024-02-07 16:14:07 +00:00
description : |-
Status defines which status or range of statuses should result in an error page.
It can be either a status code as a number (500),
as multiple comma-separated numbers (500,502),
as ranges by separating two codes with a dash (500-599),
or a combination of the two (404,418,500-599).
2023-03-20 14:38:08 +00:00
items :
type : string
type : array
type : object
forwardAuth :
2024-02-07 16:14:07 +00:00
description : |-
ForwardAuth holds the forward auth middleware configuration.
2023-03-20 14:38:08 +00:00
This middleware delegates the request authentication to a Service.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/forwardauth/
2023-03-20 14:38:08 +00:00
properties :
2024-01-15 15:14:05 +00:00
addAuthCookiesToResponse :
description : AddAuthCookiesToResponse defines the list of cookies
to copy from the authentication server response to the response.
items :
type : string
type : array
2023-03-20 14:38:08 +00:00
address :
description : Address defines the authentication server address.
type : string
authRequestHeaders :
2024-02-07 16:14:07 +00:00
description : |-
AuthRequestHeaders defines the list of the headers to copy from the request to the authentication server.
If not set or empty then all request headers are passed.
2023-03-20 14:38:08 +00:00
items :
type : string
type : array
authResponseHeaders :
description : AuthResponseHeaders defines the list of headers to
copy from the authentication server response and set on forwarded
request, replacing any existing conflicting headers.
items :
type : string
type : array
authResponseHeadersRegex :
2024-02-07 16:14:07 +00:00
description : |-
AuthResponseHeadersRegex defines the regex to match headers to copy from the authentication server response and set on forwarded request, after stripping all headers that match the regex.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/forwardauth/#authresponseheadersregex
2023-03-20 14:38:08 +00:00
type : string
tls :
description : TLS defines the configuration used to secure the
connection to the authentication server.
properties :
2024-01-29 16:32:05 +00:00
caOptional :
description: 'Deprecated : TLS client authentication is a server
side option (see https://github.com/golang/go/blob/740a490f71d026bb7d2d13cb8fa2d6d6e0572b70/src/crypto/tls/common.go#L634).'
type : boolean
2023-03-20 14:38:08 +00:00
caSecret :
2024-02-07 16:14:07 +00:00
description : |-
CASecret is the name of the referenced Kubernetes Secret containing the CA to validate the server certificate.
2023-03-20 14:38:08 +00:00
The CA certificate is extracted from key `tls.ca` or `ca.crt`.
type : string
certSecret :
2024-02-07 16:14:07 +00:00
description : |-
CertSecret is the name of the referenced Kubernetes Secret containing the client certificate.
The client certificate is extracted from the keys `tls.crt` and `tls.key`.
2023-03-20 14:38:08 +00:00
type : string
insecureSkipVerify :
description : InsecureSkipVerify defines whether the server
certificates should be validated.
type : boolean
type : object
trustForwardHeader :
description : 'TrustForwardHeader defines whether to trust (ie :
forward) all X-Forwarded-* headers.'
type : boolean
type : object
2023-03-21 11:00:46 +00:00
grpcWeb :
2024-02-08 13:15:45 +00:00
description : |-
GrpcWeb holds the gRPC web middleware configuration.
2023-03-21 11:00:46 +00:00
This middleware converts a gRPC web request to an HTTP/2 gRPC request.
properties :
allowOrigins :
2024-02-08 13:15:45 +00:00
description : |-
AllowOrigins is a list of allowable origins.
Can also be a wildcard origin "*".
2023-03-21 11:00:46 +00:00
items :
type : string
type : array
type : object
2023-03-20 14:38:08 +00:00
headers :
2024-02-07 16:14:07 +00:00
description : |-
Headers holds the headers middleware configuration.
This middleware manages the requests and responses headers.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/headers/#customrequestheaders
2023-03-20 14:38:08 +00:00
properties :
accessControlAllowCredentials :
description : AccessControlAllowCredentials defines whether the
request can include user credentials.
type : boolean
accessControlAllowHeaders :
description : AccessControlAllowHeaders defines the Access-Control-Request-Headers
values sent in preflight response.
items :
type : string
type : array
accessControlAllowMethods :
description : AccessControlAllowMethods defines the Access-Control-Request-Method
values sent in preflight response.
items :
type : string
type : array
accessControlAllowOriginList :
description : AccessControlAllowOriginList is a list of allowable
origins. Can also be a wildcard origin "*".
items :
type : string
type : array
accessControlAllowOriginListRegex :
description : AccessControlAllowOriginListRegex is a list of allowable
origins written following the Regular Expression syntax (https://golang.org/pkg/regexp/).
items :
type : string
type : array
accessControlExposeHeaders :
description : AccessControlExposeHeaders defines the Access-Control-Expose-Headers
values sent in preflight response.
items :
type : string
type : array
accessControlMaxAge :
description : AccessControlMaxAge defines the time that a preflight
request may be cached.
format : int64
type : integer
addVaryHeader :
description : AddVaryHeader defines whether the Vary header is
automatically added/updated when the AccessControlAllowOriginList
is set.
type : boolean
allowedHosts :
description : AllowedHosts defines the fully qualified list of
allowed domain names.
items :
type : string
type : array
browserXssFilter :
description : BrowserXSSFilter defines whether to add the X-XSS-Protection
header with the value 1; mode=block.
type : boolean
contentSecurityPolicy :
description : ContentSecurityPolicy defines the Content-Security-Policy
header value.
type : string
2024-06-07 07:24:04 +00:00
contentSecurityPolicyReportOnly :
description : ContentSecurityPolicyReportOnly defines the Content-Security-Policy-Report-Only
header value.
type : string
2023-03-20 14:38:08 +00:00
contentTypeNosniff :
description : ContentTypeNosniff defines whether to add the X-Content-Type-Options
header with the nosniff value.
type : boolean
customBrowserXSSValue :
2024-02-07 16:14:07 +00:00
description : |-
CustomBrowserXSSValue defines the X-XSS-Protection header value.
This overrides the BrowserXssFilter option.
2023-03-20 14:38:08 +00:00
type : string
customFrameOptionsValue :
2024-02-07 16:14:07 +00:00
description : |-
CustomFrameOptionsValue defines the X-Frame-Options header value.
This overrides the FrameDeny option.
2023-03-20 14:38:08 +00:00
type : string
customRequestHeaders :
additionalProperties :
type : string
description : CustomRequestHeaders defines the header names and
values to apply to the request.
type : object
customResponseHeaders :
additionalProperties :
type : string
description : CustomResponseHeaders defines the header names and
values to apply to the response.
type : object
2024-01-29 16:32:05 +00:00
featurePolicy :
description: 'Deprecated : FeaturePolicy option is deprecated,
please use PermissionsPolicy instead.'
type : string
2023-03-20 14:38:08 +00:00
forceSTSHeader :
description : ForceSTSHeader defines whether to add the STS header
even when the connection is HTTP.
type : boolean
frameDeny :
description : FrameDeny defines whether to add the X-Frame-Options
header with the DENY value.
type : boolean
hostsProxyHeaders :
description : HostsProxyHeaders defines the header keys that may
hold a proxied hostname value for the request.
items :
type : string
type : array
isDevelopment :
2024-02-07 16:14:07 +00:00
description : |-
IsDevelopment defines whether to mitigate the unwanted effects of the AllowedHosts, SSL, and STS options when developing.
Usually testing takes place using HTTP, not HTTPS, and on localhost, not your production domain.
If you would like your development environment to mimic production with complete Host blocking, SSL redirects,
and STS headers, leave this as false.
2023-03-20 14:38:08 +00:00
type : boolean
permissionsPolicy :
2024-02-07 16:14:07 +00:00
description : |-
PermissionsPolicy defines the Permissions-Policy header value.
This allows sites to control browser features.
2023-03-20 14:38:08 +00:00
type : string
publicKey :
description : PublicKey is the public key that implements HPKP
to prevent MITM attacks with forged certificates.
type : string
referrerPolicy :
2024-02-07 16:14:07 +00:00
description : |-
ReferrerPolicy defines the Referrer-Policy header value.
This allows sites to control whether browsers forward the Referer header to other sites.
2023-03-20 14:38:08 +00:00
type : string
2024-01-29 16:32:05 +00:00
sslForceHost :
description: 'Deprecated : SSLForceHost option is deprecated, please
use RedirectRegex instead.'
type : boolean
sslHost :
description: 'Deprecated : SSLHost option is deprecated, please
use RedirectRegex instead.'
type : string
2023-03-20 14:38:08 +00:00
sslProxyHeaders :
additionalProperties :
type : string
2024-02-07 16:14:07 +00:00
description : |-
SSLProxyHeaders defines the header keys with associated values that would indicate a valid HTTPS request.
It can be useful when using other proxies (example : "X-Forwarded-Proto": "https" ).
2023-03-20 14:38:08 +00:00
type : object
2024-01-29 16:32:05 +00:00
sslRedirect :
description: 'Deprecated : SSLRedirect option is deprecated, please
use EntryPoint redirection or RedirectScheme instead.'
type : boolean
sslTemporaryRedirect :
description: 'Deprecated : SSLTemporaryRedirect option is deprecated,
please use EntryPoint redirection or RedirectScheme instead.'
type : boolean
2023-03-20 14:38:08 +00:00
stsIncludeSubdomains :
description : STSIncludeSubdomains defines whether the includeSubDomains
directive is appended to the Strict-Transport-Security header.
type : boolean
stsPreload :
description : STSPreload defines whether the preload flag is appended
to the Strict-Transport-Security header.
type : boolean
stsSeconds :
2024-02-07 16:14:07 +00:00
description : |-
STSSeconds defines the max-age of the Strict-Transport-Security header.
If set to 0, the header is not set.
2023-03-20 14:38:08 +00:00
format : int64
type : integer
type : object
inFlightReq :
2024-02-07 16:14:07 +00:00
description : |-
InFlightReq holds the in-flight request middleware configuration.
This middleware limits the number of requests being processed and served concurrently.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/inflightreq/
2023-03-20 14:38:08 +00:00
properties :
amount :
2024-02-07 16:14:07 +00:00
description : |-
Amount defines the maximum amount of allowed simultaneous in-flight request.
The middleware responds with HTTP 429 Too Many Requests if there are already amount requests in progress (based on the same sourceCriterion strategy).
2023-03-20 14:38:08 +00:00
format : int64
type : integer
sourceCriterion :
2024-02-07 16:14:07 +00:00
description : |-
SourceCriterion defines what criterion is used to group requests as originating from a common source.
If several strategies are defined at the same time, an error will be raised.
If none are set, the default is to use the requestHost.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/inflightreq/#sourcecriterion
2023-03-20 14:38:08 +00:00
properties :
ipStrategy :
2024-02-07 16:14:07 +00:00
description : |-
IPStrategy holds the IP strategy configuration used by Traefik to determine the client IP.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/ipallowlist/#ipstrategy
2023-03-20 14:38:08 +00:00
properties :
depth :
description : Depth tells Traefik to use the X-Forwarded-For
header and take the IP located at the depth position
(starting from the right).
type : integer
excludedIPs :
description : ExcludedIPs configures Traefik to scan the
X-Forwarded-For header and select the first IP not in
the list.
items :
type : string
type : array
type : object
requestHeaderName :
description : RequestHeaderName defines the name of the header
used to group incoming requests.
type : string
requestHost :
description : RequestHost defines whether to consider the request
Host as the source.
type : boolean
type : object
type : object
2023-03-21 11:00:46 +00:00
ipAllowList :
2024-02-07 16:14:07 +00:00
description : |-
IPAllowList holds the IP allowlist middleware configuration.
2024-04-04 09:32:05 +00:00
This middleware limits allowed requests based on the client IP.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/ipallowlist/
2023-03-20 14:38:08 +00:00
properties :
ipStrategy :
2024-02-07 16:14:07 +00:00
description : |-
IPStrategy holds the IP strategy configuration used by Traefik to determine the client IP.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/ipallowlist/#ipstrategy
2023-03-20 14:38:08 +00:00
properties :
depth :
description : Depth tells Traefik to use the X-Forwarded-For
header and take the IP located at the depth position (starting
from the right).
type : integer
excludedIPs :
description : ExcludedIPs configures Traefik to scan the X-Forwarded-For
header and select the first IP not in the list.
items :
type : string
type : array
type : object
2024-01-09 19:26:05 +00:00
rejectStatusCode :
2024-02-08 13:15:45 +00:00
description : |-
RejectStatusCode defines the HTTP status code used for refused requests.
If not set, the default is 403 (Forbidden).
2024-01-09 19:26:05 +00:00
type : integer
2023-03-20 14:38:08 +00:00
sourceRange :
description : SourceRange defines the set of allowed IPs (or ranges
of allowed IPs by using CIDR notation).
items :
type : string
type : array
type : object
2024-01-11 09:40:06 +00:00
ipWhiteList :
description: 'Deprecated : please use IPAllowList instead.'
properties :
ipStrategy :
2024-02-07 16:14:07 +00:00
description : |-
IPStrategy holds the IP strategy configuration used by Traefik to determine the client IP.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/ipallowlist/#ipstrategy
2024-01-11 09:40:06 +00:00
properties :
depth :
description : Depth tells Traefik to use the X-Forwarded-For
header and take the IP located at the depth position (starting
from the right).
type : integer
excludedIPs :
description : ExcludedIPs configures Traefik to scan the X-Forwarded-For
header and select the first IP not in the list.
items :
type : string
type : array
type : object
sourceRange :
description : SourceRange defines the set of allowed IPs (or ranges
2024-04-04 09:32:05 +00:00
of allowed IPs by using CIDR notation). Required.
2024-01-11 09:40:06 +00:00
items :
type : string
type : array
type : object
2023-03-20 14:38:08 +00:00
passTLSClientCert :
2024-02-07 16:14:07 +00:00
description : |-
PassTLSClientCert holds the pass TLS client cert middleware configuration.
This middleware adds the selected data from the passed client TLS certificate to a header.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/passtlsclientcert/
2023-03-20 14:38:08 +00:00
properties :
info :
description : Info selects the specific client certificate details
you want to add to the X-Forwarded-Tls-Client-Cert-Info header.
properties :
issuer :
description : Issuer defines the client certificate issuer
details to add to the X-Forwarded-Tls-Client-Cert-Info header.
properties :
commonName :
description : CommonName defines whether to add the organizationalUnit
information into the issuer.
type : boolean
country :
description : Country defines whether to add the country
information into the issuer.
type : boolean
domainComponent :
description : DomainComponent defines whether to add the
domainComponent information into the issuer.
type : boolean
locality :
description : Locality defines whether to add the locality
information into the issuer.
type : boolean
organization :
description : Organization defines whether to add the organization
information into the issuer.
type : boolean
province :
description : Province defines whether to add the province
information into the issuer.
type : boolean
serialNumber :
description : SerialNumber defines whether to add the serialNumber
information into the issuer.
type : boolean
type : object
notAfter :
description : NotAfter defines whether to add the Not After
information from the Validity part.
type : boolean
notBefore :
description : NotBefore defines whether to add the Not Before
information from the Validity part.
type : boolean
sans :
description : Sans defines whether to add the Subject Alternative
Name information from the Subject Alternative Name part.
type : boolean
serialNumber :
description : SerialNumber defines whether to add the client
serialNumber information.
type : boolean
subject :
description : Subject defines the client certificate subject
details to add to the X-Forwarded-Tls-Client-Cert-Info header.
properties :
commonName :
description : CommonName defines whether to add the organizationalUnit
information into the subject.
type : boolean
country :
description : Country defines whether to add the country
information into the subject.
type : boolean
domainComponent :
description : DomainComponent defines whether to add the
domainComponent information into the subject.
type : boolean
locality :
description : Locality defines whether to add the locality
information into the subject.
type : boolean
organization :
description : Organization defines whether to add the organization
information into the subject.
type : boolean
organizationalUnit :
description : OrganizationalUnit defines whether to add
the organizationalUnit information into the subject.
type : boolean
province :
description : Province defines whether to add the province
information into the subject.
type : boolean
serialNumber :
description : SerialNumber defines whether to add the serialNumber
information into the subject.
type : boolean
type : object
type : object
pem :
description : PEM sets the X-Forwarded-Tls-Client-Cert header with
the certificate.
type : boolean
type : object
plugin :
additionalProperties :
x-kubernetes-preserve-unknown-fields : true
2024-02-07 16:14:07 +00:00
description : |-
Plugin defines the middleware plugin configuration.
More info : https://doc.traefik.io/traefik/plugins/
2023-03-20 14:38:08 +00:00
type : object
rateLimit :
2024-02-07 16:14:07 +00:00
description : |-
RateLimit holds the rate limit configuration.
This middleware ensures that services will receive a fair amount of requests, and allows one to define what fair is.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/ratelimit/
2023-03-20 14:38:08 +00:00
properties :
average :
2024-02-07 16:14:07 +00:00
description : |-
Average is the maximum rate, by default in requests/s, allowed for the given source.
It defaults to 0, which means no rate limiting.
The rate is actually defined by dividing Average by Period. So for a rate below 1req/s,
one needs to define a Period larger than a second.
2023-03-20 14:38:08 +00:00
format : int64
type : integer
burst :
2024-02-07 16:14:07 +00:00
description : |-
Burst is the maximum number of requests allowed to arrive in the same arbitrarily small period of time.
It defaults to 1.
2023-03-20 14:38:08 +00:00
format : int64
type : integer
period :
anyOf :
- type : integer
- type : string
2024-02-07 16:14:07 +00:00
description : |-
Period, in combination with Average, defines the actual maximum rate, such as :
r = Average / Period. It defaults to a second.
2023-03-20 14:38:08 +00:00
x-kubernetes-int-or-string : true
sourceCriterion :
2024-02-07 16:14:07 +00:00
description : |-
SourceCriterion defines what criterion is used to group requests as originating from a common source.
If several strategies are defined at the same time, an error will be raised.
If none are set, the default is to use the request's remote address field (as an ipStrategy).
2023-03-20 14:38:08 +00:00
properties :
ipStrategy :
2024-02-07 16:14:07 +00:00
description : |-
IPStrategy holds the IP strategy configuration used by Traefik to determine the client IP.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/ipallowlist/#ipstrategy
2023-03-20 14:38:08 +00:00
properties :
depth :
description : Depth tells Traefik to use the X-Forwarded-For
header and take the IP located at the depth position
(starting from the right).
type : integer
excludedIPs :
description : ExcludedIPs configures Traefik to scan the
X-Forwarded-For header and select the first IP not in
the list.
items :
type : string
type : array
type : object
requestHeaderName :
description : RequestHeaderName defines the name of the header
used to group incoming requests.
type : string
requestHost :
description : RequestHost defines whether to consider the request
Host as the source.
type : boolean
type : object
type : object
redirectRegex :
2024-02-07 16:14:07 +00:00
description : |-
RedirectRegex holds the redirect regex middleware configuration.
2023-03-20 14:38:08 +00:00
This middleware redirects a request using regex matching and replacement.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/redirectregex/#regex
2023-03-20 14:38:08 +00:00
properties :
permanent :
description : Permanent defines whether the redirection is permanent
(301).
type : boolean
regex :
description : Regex defines the regex used to match and capture
elements from the request URL.
type : string
replacement :
description : Replacement defines how to modify the URL to have
the new target URL.
type : string
type : object
redirectScheme :
2024-02-07 16:14:07 +00:00
description : |-
RedirectScheme holds the redirect scheme middleware configuration.
This middleware redirects requests from a scheme/port to another.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/redirectscheme/
2023-03-20 14:38:08 +00:00
properties :
permanent :
description : Permanent defines whether the redirection is permanent
(301).
type : boolean
port :
description : Port defines the port of the new URL.
type : string
scheme :
description : Scheme defines the scheme of the new URL.
type : string
type : object
replacePath :
2024-02-07 16:14:07 +00:00
description : |-
ReplacePath holds the replace path middleware configuration.
This middleware replaces the path of the request URL and store the original path in an X-Replaced-Path header.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/replacepath/
2023-03-20 14:38:08 +00:00
properties :
path :
description : Path defines the path to use as replacement in the
request URL.
type : string
type : object
replacePathRegex :
2024-02-07 16:14:07 +00:00
description : |-
ReplacePathRegex holds the replace path regex middleware configuration.
This middleware replaces the path of a URL using regex matching and replacement.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/replacepathregex/
2023-03-20 14:38:08 +00:00
properties :
regex :
description : Regex defines the regular expression used to match
and capture the path from the request URL.
type : string
replacement :
description : Replacement defines the replacement path format,
which can include captured variables.
type : string
type : object
retry :
2024-02-07 16:14:07 +00:00
description : |-
Retry holds the retry middleware configuration.
This middleware reissues requests a given number of times to a backend server if that server does not reply.
As soon as the server answers, the middleware stops retrying, regardless of the response status.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/retry/
2023-03-20 14:38:08 +00:00
properties :
attempts :
description : Attempts defines how many times the request should
be retried.
type : integer
initialInterval :
anyOf :
- type : integer
- type : string
2024-02-07 16:14:07 +00:00
description : |-
InitialInterval defines the first wait time in the exponential backoff series.
The maximum interval is calculated as twice the initialInterval.
If unspecified, requests will be retried immediately.
The value of initialInterval should be provided in seconds or as a valid duration format,
see https://pkg.go.dev/time#ParseDuration.
2023-03-20 14:38:08 +00:00
x-kubernetes-int-or-string : true
type : object
stripPrefix :
2024-02-07 16:14:07 +00:00
description : |-
StripPrefix holds the strip prefix middleware configuration.
2023-03-20 14:38:08 +00:00
This middleware removes the specified prefixes from the URL path.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/stripprefix/
2023-03-20 14:38:08 +00:00
properties :
2024-01-29 16:32:05 +00:00
forceSlash :
2024-02-07 16:14:07 +00:00
description : |-
2024-02-08 13:15:45 +00:00
Deprecated : ForceSlash option is deprecated, please remove any usage of this option.
2024-02-07 16:14:07 +00:00
ForceSlash ensures that the resulting stripped path is not the empty string, by replacing it with / when necessary.
Default : true .
2024-01-29 16:32:05 +00:00
type : boolean
2023-03-20 14:38:08 +00:00
prefixes :
description : Prefixes defines the prefixes to strip from the request
URL.
items :
type : string
type : array
type : object
stripPrefixRegex :
2024-02-07 16:14:07 +00:00
description : |-
StripPrefixRegex holds the strip prefix regex middleware configuration.
This middleware removes the matching prefixes from the URL path.
2024-02-08 13:15:45 +00:00
More info : https://doc.traefik.io/traefik/v3.0/middlewares/http/stripprefixregex/
2023-03-20 14:38:08 +00:00
properties :
regex :
description : Regex defines the regular expression to match the
path prefix from the request URL.
items :
type : string
type : array
type : object
type : object
required :
- metadata
- spec
type : object
served : true
storage : true
