TraefikService
traefik.io / v1alpha1
apiVersion: traefik.io/v1alpha1
kind: TraefikService
metadata:
name: example
apiVersion
string
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
kind
string
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
metadata
object required
spec object required
TraefikServiceSpec defines the desired state of a TraefikService.
mirroring object
Mirroring defines the Mirroring service configuration.
healthCheck object
Healthcheck defines health checks for ExternalName services.
followRedirects
boolean
FollowRedirects defines whether redirects should be followed during the health check calls.
Default: true
headers
object
Headers defines custom headers to be sent to the health check endpoint.
hostname
string
Hostname defines the value of hostname in the Host header of the health check request.
interval
string | integer
Interval defines the frequency of the health check calls.
Default: 30s
method
string
Method defines the healthcheck method.
mode
string
Mode defines the health check mode.
If defined to grpc, will use the gRPC health check protocol to probe the server.
Default: http
path
string
Path defines the server URL path for the health check endpoint.
port
integer
Port defines the server URL port for the health check endpoint.
scheme
string
Scheme replaces the server URL scheme for the health check endpoint.
status
integer
Status defines the expected HTTP status code of the response to the health check request.
timeout
string | integer
Timeout defines the maximum duration Traefik will wait for a health check request before considering the server unhealthy.
Default: 5s
kind
string
Kind defines the kind of the Service.
enum:
Service, TraefikService
maxBodySize
integer
MaxBodySize defines the maximum size allowed for the body of the request.
If the body is larger, the request is not mirrored.
Default value is -1, which means unlimited size.
format:
int64mirrors []object
Mirrors defines the list of mirrors where Traefik will duplicate the traffic.
healthCheck object
Healthcheck defines health checks for ExternalName services.
followRedirects
boolean
FollowRedirects defines whether redirects should be followed during the health check calls.
Default: true
headers
object
Headers defines custom headers to be sent to the health check endpoint.
hostname
string
Hostname defines the value of hostname in the Host header of the health check request.
interval
string | integer
Interval defines the frequency of the health check calls.
Default: 30s
method
string
Method defines the healthcheck method.
mode
string
Mode defines the health check mode.
If defined to grpc, will use the gRPC health check protocol to probe the server.
Default: http
path
string
Path defines the server URL path for the health check endpoint.
port
integer
Port defines the server URL port for the health check endpoint.
scheme
string
Scheme replaces the server URL scheme for the health check endpoint.
status
integer
Status defines the expected HTTP status code of the response to the health check request.
timeout
string | integer
Timeout defines the maximum duration Traefik will wait for a health check request before considering the server unhealthy.
Default: 5s
kind
string
Kind defines the kind of the Service.
enum:
Service, TraefikService
name
string required
Name defines the name of the referenced Kubernetes Service or TraefikService.
The differentiation between the two is specified in the Kind field.
namespace
string
Namespace defines the namespace of the referenced Kubernetes Service or TraefikService.
nativeLB
boolean
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.
By default, NativeLB is false.
nodePortLB
boolean
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.
passHostHeader
boolean
PassHostHeader defines whether the client Host header is forwarded to the upstream Kubernetes Service.
By default, passHostHeader is true.
percent
integer
Percent defines the part of the traffic to mirror.
Supported values: 0 to 100.
port
string | integer
Port defines the port of a Kubernetes Service.
This can be a reference to a named port.
responseForwarding object
ResponseForwarding defines how Traefik forwards the response from the upstream Kubernetes Service to the client.
flushInterval
string
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
scheme
string
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.
serversTransport
string
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.
sticky object
Sticky defines the sticky sessions configuration.
More info: https://doc.traefik.io/traefik/v3.0/routing/services/#sticky-sessions
cookie object
Cookie defines the sticky cookie configuration.
httpOnly
boolean
HTTPOnly defines whether the cookie can be accessed by client-side APIs, such as JavaScript.
maxAge
integer
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.
name
string
Name defines the Cookie name.
sameSite
string
SameSite defines the same site policy.
More info: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
secure
boolean
Secure defines whether the cookie can only be transmitted over an encrypted connection (i.e. HTTPS).
strategy
string
Strategy defines the load balancing strategy between the servers.
RoundRobin is the only supported value at the moment.
weight
integer
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).
name
string required
Name defines the name of the referenced Kubernetes Service or TraefikService.
The differentiation between the two is specified in the Kind field.
namespace
string
Namespace defines the namespace of the referenced Kubernetes Service or TraefikService.
nativeLB
boolean
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.
By default, NativeLB is false.
nodePortLB
boolean
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.
passHostHeader
boolean
PassHostHeader defines whether the client Host header is forwarded to the upstream Kubernetes Service.
By default, passHostHeader is true.
port
string | integer
Port defines the port of a Kubernetes Service.
This can be a reference to a named port.
responseForwarding object
ResponseForwarding defines how Traefik forwards the response from the upstream Kubernetes Service to the client.
flushInterval
string
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
scheme
string
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.
serversTransport
string
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.
sticky object
Sticky defines the sticky sessions configuration.
More info: https://doc.traefik.io/traefik/v3.0/routing/services/#sticky-sessions
cookie object
Cookie defines the sticky cookie configuration.
httpOnly
boolean
HTTPOnly defines whether the cookie can be accessed by client-side APIs, such as JavaScript.
maxAge
integer
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.
name
string
Name defines the Cookie name.
sameSite
string
SameSite defines the same site policy.
More info: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
secure
boolean
Secure defines whether the cookie can only be transmitted over an encrypted connection (i.e. HTTPS).
strategy
string
Strategy defines the load balancing strategy between the servers.
RoundRobin is the only supported value at the moment.
weight
integer
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).
weighted object
Weighted defines the Weighted Round Robin configuration.
services []object
Services defines the list of Kubernetes Service and/or TraefikService to load-balance, with weight.
healthCheck object
Healthcheck defines health checks for ExternalName services.
followRedirects
boolean
FollowRedirects defines whether redirects should be followed during the health check calls.
Default: true
headers
object
Headers defines custom headers to be sent to the health check endpoint.
hostname
string
Hostname defines the value of hostname in the Host header of the health check request.
interval
string | integer
Interval defines the frequency of the health check calls.
Default: 30s
method
string
Method defines the healthcheck method.
mode
string
Mode defines the health check mode.
If defined to grpc, will use the gRPC health check protocol to probe the server.
Default: http
path
string
Path defines the server URL path for the health check endpoint.
port
integer
Port defines the server URL port for the health check endpoint.
scheme
string
Scheme replaces the server URL scheme for the health check endpoint.
status
integer
Status defines the expected HTTP status code of the response to the health check request.
timeout
string | integer
Timeout defines the maximum duration Traefik will wait for a health check request before considering the server unhealthy.
Default: 5s
kind
string
Kind defines the kind of the Service.
enum:
Service, TraefikService
name
string required
Name defines the name of the referenced Kubernetes Service or TraefikService.
The differentiation between the two is specified in the Kind field.
namespace
string
Namespace defines the namespace of the referenced Kubernetes Service or TraefikService.
nativeLB
boolean
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.
By default, NativeLB is false.
nodePortLB
boolean
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.
passHostHeader
boolean
PassHostHeader defines whether the client Host header is forwarded to the upstream Kubernetes Service.
By default, passHostHeader is true.
port
string | integer
Port defines the port of a Kubernetes Service.
This can be a reference to a named port.
responseForwarding object
ResponseForwarding defines how Traefik forwards the response from the upstream Kubernetes Service to the client.
flushInterval
string
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
scheme
string
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.
serversTransport
string
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.
sticky object
Sticky defines the sticky sessions configuration.
More info: https://doc.traefik.io/traefik/v3.0/routing/services/#sticky-sessions
cookie object
Cookie defines the sticky cookie configuration.
httpOnly
boolean
HTTPOnly defines whether the cookie can be accessed by client-side APIs, such as JavaScript.
maxAge
integer
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.
name
string
Name defines the Cookie name.
sameSite
string
SameSite defines the same site policy.
More info: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
secure
boolean
Secure defines whether the cookie can only be transmitted over an encrypted connection (i.e. HTTPS).
strategy
string
Strategy defines the load balancing strategy between the servers.
RoundRobin is the only supported value at the moment.
weight
integer
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).
sticky object
Sticky defines whether sticky sessions are enabled.
More info: https://doc.traefik.io/traefik/v3.0/routing/providers/kubernetes-crd/#stickiness-and-load-balancing
cookie object
Cookie defines the sticky cookie configuration.
httpOnly
boolean
HTTPOnly defines whether the cookie can be accessed by client-side APIs, such as JavaScript.
maxAge
integer
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.
name
string
Name defines the Cookie name.
sameSite
string
SameSite defines the same site policy.
More info: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
secure
boolean
Secure defines whether the cookie can only be transmitted over an encrypted connection (i.e. HTTPS).
No matches. Try .spec.mirroring for an exact path