Traefik & KV Stores

A Story of key & values

Routing Configuration

Keys

Routers

The character @ is not authorized in the router name <router_name>.

traefik/http/routers/<router_name>/rule

See rule for more information.

Key (Path)Value
traefik/http/routers/myrouter/ruleHost(example.com)

traefik/http/routers/<router_name>/entrypoints

See entry points for more information.

Key (Path)Value
traefik/http/routers/myrouter/entrypoints/0web
traefik/http/routers/myrouter/entrypoints/1websecure

traefik/http/routers/<router_name>/middlewares

See middlewares and middlewares overview for more information.

Key (Path)Value
traefik/http/routers/myrouter/middlewares/0auth
traefik/http/routers/myrouter/middlewares/1prefix
traefik/http/routers/myrouter/middlewares/2cb

traefik/http/routers/<router_name>/service

See rule for more information.

Key (Path)Value
traefik/http/routers/myrouter/servicemyservice

traefik/http/routers/<router_name>/tls

See tls for more information.

Key (Path)Value
traefik/http/routers/myrouter/tlstrue

traefik/http/routers/<router_name>/tls/certresolver

See certResolver for more information.

Key (Path)Value
traefik/http/routers/myrouter/tls/certresolvermyresolver

traefik/http/routers/<router_name>/tls/domains/<n>/main

See domains for more information.

Key (Path)Value
traefik/http/routers/myrouter/tls/domains/0/mainexample.org

traefik/http/routers/<router_name>/tls/domains/<n>/sans/<n>

See domains for more information.

Key (Path)Value
traefik/http/routers/myrouter/tls/domains/0/sans/0test.example.org
traefik/http/routers/myrouter/tls/domains/0/sans/1dev.example.org

traefik/http/routers/<router_name>/tls/options

See options for more information.

Key (Path)Value
traefik/http/routers/myrouter/tls/optionsfoobar

traefik/http/routers/<router_name>/priority

See priority for more information.

Key (Path)Value
traefik/http/routers/myrouter/priority42

Services

The character @ is not authorized in the service name <service_name>.

traefik/http/services/<service_name>/loadbalancer/servers/<n>/url

See servers for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/servers/0/urlhttp://<ip-server-1>:<port-server-1>/

traefik/http/services/<service_name>/loadbalancer/serverstransport

Allows to reference a ServersTransport resource that is defined either with the File provider or the Kubernetes CRD one. See serverstransport for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/serverstransportfoobar@file

traefik/http/services/<service_name>/loadbalancer/passhostheader

See pass Host header for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/passhostheadertrue

traefik/http/services/<service_name>/loadbalancer/healthcheck/headers/<header_name>

See health check for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/healthcheck/headers/X-Foofoobar

traefik/http/services/<service_name>/loadbalancer/healthcheck/hostname

See health check for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/healthcheck/hostnameexample.org

traefik/http/services/<service_name>/loadbalancer/healthcheck/interval

See health check for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/healthcheck/interval10

traefik/http/services/<service_name>/loadbalancer/healthcheck/path

See health check for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/healthcheck/path/foo

traefik/http/services/<service_name>/loadbalancer/healthcheck/port

See health check for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/healthcheck/port42

traefik/http/services/<service_name>/loadbalancer/healthcheck/scheme

See health check for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/healthcheck/schemehttp

traefik/http/services/<service_name>/loadbalancer/healthcheck/timeout

See health check for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/healthcheck/timeout10

traefik/http/services/<service_name>/loadbalancer/sticky

See sticky sessions for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/stickytrue

traefik/http/services/<service_name>/loadbalancer/sticky/cookie/httponly

See sticky sessions for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/sticky/cookie/httponlytrue

traefik/http/services/<service_name>/loadbalancer/sticky/cookie/name

See sticky sessions for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/sticky/cookie/namefoobar

traefik/http/services/<service_name>/loadbalancer/sticky/cookie/secure

See sticky sessions for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/sticky/cookie/securetrue

traefik/http/services/<service_name>/loadbalancer/sticky/cookie/samesite

See sticky sessions for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/sticky/cookie/samesitenone

traefik/http/services/<service_name>/loadbalancer/responseforwarding/flushinterval

See response forwarding for more information.

Key (Path)Value
traefik/http/services/myservice/loadbalancer/responseforwarding/flushinterval10

traefik/http/services/<service_name>/mirroring/service

Key (Path)Value
traefik/http/services/<service_name>/mirroring/servicefoobar

traefik/http/services/<service_name>/mirroring/mirrors/<n>/name

Key (Path)Value
traefik/http/services/<service_name>/mirroring/mirrors/<n>/namefoobar

traefik/http/services/<service_name>/mirroring/mirrors/<n>/percent

Key (Path)Value
traefik/http/services/<service_name>/mirroring/mirrors/<n>/percent42

traefik/http/services/<service_name>/weighted/services/<n>/name

Key (Path)Value
traefik/http/services/<service_name>/weighted/services/<n>/namefoobar

traefik/http/services/<service_name>/weighted/services/<n>/weight

Key (Path)Value
traefik/http/services/<service_name>/weighted/services/<n>/weight42

traefik/http/services/<service_name>/weighted/sticky/cookie/name

Key (Path)Value
traefik/http/services/<service_name>/weighted/sticky/cookie/namefoobar

traefik/http/services/<service_name>/weighted/sticky/cookie/secure

Key (Path)Value
traefik/http/services/<service_name>/weighted/sticky/cookie/securetrue

traefik/http/services/<service_name>/weighted/sticky/cookie/samesite

Key (Path)Value
traefik/http/services/<service_name>/weighted/sticky/cookie/samesitenone

traefik/http/services/<service_name>/weighted/sticky/cookie/httpOnly

Key (Path)Value
traefik/http/services/<service_name>/weighted/sticky/cookie/httpOnlytrue

Middleware

More information about available middlewares in the dedicated middlewares section.

The character @ is not authorized in the middleware name.

Conflicts in Declaration

If you declare multiple middleware with the same name but with different parameters, the middleware fails to be declared.

TCP

You can declare TCP Routers and/or Services using KV.

TCP Routers

traefik/tcp/routers/<router_name>/entrypoints

See entry points for more information.

Key (Path)Value
traefik/tcp/routers/mytcprouter/entrypoints/0ep1
traefik/tcp/routers/mytcprouter/entrypoints/1ep2

traefik/tcp/routers/<router_name>/rule

See rule for more information.

Key (Path)Value
traefik/tcp/routers/my-router/ruleHostSNI(example.com)

traefik/tcp/routers/<router_name>/service

See service for more information.

Key (Path)Value
traefik/tcp/routers/mytcprouter/servicemyservice

traefik/tcp/routers/<router_name>/tls

See TLS for more information.

Key (Path)Value
traefik/tcp/routers/mytcprouter/tlstrue

traefik/tcp/routers/<router_name>/tls/certresolver

See certResolver for more information.

Key (Path)Value
traefik/tcp/routers/mytcprouter/tls/certresolvermyresolver

traefik/tcp/routers/<router_name>/tls/domains/<n>/main

See domains for more information.

Key (Path)Value
traefik/tcp/routers/mytcprouter/tls/domains/0/mainexample.org

traefik/tcp/routers/<router_name>/tls/domains/<n>/sans

See domains for more information.

Key (Path)Value
traefik/tcp/routers/mytcprouter/tls/domains/0/sans/0test.example.org
traefik/tcp/routers/mytcprouter/tls/domains/0/sans/1dev.example.org

traefik/tcp/routers/<router_name>/tls/options

See options for more information.

Key (Path)Value
traefik/tcp/routers/mytcprouter/tls/optionsfoobar

traefik/tcp/routers/<router_name>/tls/passthrough

See TLS for more information.

Key (Path)Value
traefik/tcp/routers/mytcprouter/tls/passthroughtrue

traefik/tcp/routers/<router_name>/priority

See priority for more information.

Key (Path)Value
traefik/tcp/routers/myrouter/priority42

TCP Services

traefik/tcp/services/<service_name>/loadbalancer/servers/<n>/url

See servers for more information.

Key (Path)Value
traefik/tcp/services/mytcpservice/loadbalancer/servers/0/addressxx.xx.xx.xx:xx

traefik/tcp/services/<service_name>/loadbalancer/terminationdelay

See termination delay for more information.

Key (Path)Value
traefik/tcp/services/mytcpservice/loadbalancer/terminationdelay100

traefik/tcp/services/<service_name>/loadbalancer/proxyprotocol/version

See PROXY protocol for more information.

Key (Path)Value
traefik/tcp/services/mytcpservice/loadbalancer/proxyprotocol/version1

traefik/tcp/services/<service_name>/weighted/services/<n>/name

Key (Path)Value
traefik/tcp/services/<service_name>/weighted/services/0/namefoobar

traefik/tcp/services/<service_name>/weighted/services/<n>/weight

Key (Path)Value
traefik/tcp/services/<service_name>/weighted/services/0/weight42