Skip to search

IngressRoute

traefik.io / v1alpha1

apiVersion: traefik.io/v1alpha1 kind: IngressRoute metadata: name: example
View raw schema
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
IngressRouteSpec defines the desired state of IngressRoute.
entryPoints []string
EntryPoints defines the list of entry point names to bind to. Entry points have to be configured in the static configuration. More info: https://doc.traefik.io/traefik/v3.0/routing/entrypoints/ Default: all.
routes []object required
Routes defines the list of routes.
kind string required
Kind defines the kind of the route. Rule is the only supported kind.
enum: Rule
match string required
Match defines the router's rule. More info: https://doc.traefik.io/traefik/v3.0/routing/routers/#rule
middlewares []object
Middlewares defines the list of references to Middleware resources. More info: https://doc.traefik.io/traefik/v3.0/routing/providers/kubernetes-crd/#kind-middleware
name string required
Name defines the name of the referenced Middleware resource.
namespace string
Namespace defines the namespace of the referenced Middleware resource.
priority integer
Priority defines the router's priority. More info: https://doc.traefik.io/traefik/v3.0/routing/routers/#priority
services []object
Services defines the list of Service. It can contain any combination of TraefikService and/or reference to a Kubernetes Service.
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).
syntax string
Syntax defines the router's rule syntax. More info: https://doc.traefik.io/traefik/v3.0/routing/routers/#rulesyntax
tls object
TLS defines the TLS configuration. More info: https://doc.traefik.io/traefik/v3.0/routing/routers/#tls
certResolver string
CertResolver defines the name of the certificate resolver to use. Cert resolvers have to be configured in the static configuration. More info: https://doc.traefik.io/traefik/v3.0/https/acme/#certificate-resolvers
domains []object
Domains defines the list of domains that will be used to issue certificates. More info: https://doc.traefik.io/traefik/v3.0/routing/routers/#domains
main string
Main defines the main domain name.
sans []string
SANs defines the subject alternative domain names.
options object
Options defines the reference to a TLSOption, that specifies the parameters of the TLS connection. If not defined, the `default` TLSOption is used. More info: https://doc.traefik.io/traefik/v3.0/https/tls/#tls-options
name string required
Name defines the name of the referenced TLSOption. More info: https://doc.traefik.io/traefik/v3.0/routing/providers/kubernetes-crd/#kind-tlsoption
namespace string
Namespace defines the namespace of the referenced TLSOption. More info: https://doc.traefik.io/traefik/v3.0/routing/providers/kubernetes-crd/#kind-tlsoption
secretName string
SecretName is the name of the referenced Kubernetes Secret to specify the certificate details.
store object
Store defines the reference to the TLSStore, that will be used to store certificates. Please note that only `default` TLSStore can be used.
name string required
Name defines the name of the referenced TLSStore. More info: https://doc.traefik.io/traefik/v3.0/routing/providers/kubernetes-crd/#kind-tlsstore
namespace string
Namespace defines the namespace of the referenced TLSStore. More info: https://doc.traefik.io/traefik/v3.0/routing/providers/kubernetes-crd/#kind-tlsstore

No matches. Try .spec.entryPoints for an exact path