Traefik & KV Stores

A Story of key & values

Routing Configuration

Keys

  • Keys are case insensitive.
  • The complete list of keys can be found in the reference page.

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/rule Host(`example.com`)
traefik/http/routers/<router_name>/entrypoints

See entry points for more information.

Key (Path) Value
traefik.http.routers.myrouter.entrypoints/0 web
traefik.http.routers.myrouter.entrypoints/1 websecure
traefik/http/routers/<router_name>/middlewares

See middlewares and middlewares overview for more information.

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

See rule for more information.

Key (Path) Value
traefik/http/routers/myrouter/service myservice
traefik/http/routers/<router_name>/tls

See tls for more information.

Key (Path) Value
traefik/http/routers/myrouter/tls true
traefik/http/routers/<router_name>/tls/certresolver

See certResolver for more information.

Key (Path) Value
traefik/http/routers/myrouter/tls/certresolver myresolver
traefik/http/routers/<router_name>/tls/domains/<n>/main

See domains for more information.

Key (Path) Value
traefik/http/routers/myrouter/tls/domains/0/main example.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/0 test.example.org
traefik/http/routers/myrouter/tls/domains/0/sans/1 dev.example.org
traefik/http/routers/<router_name>/tls/options

See options for more information.

Key (Path) Value
traefik/http/routers/myrouter/tls/options foobar
traefik/http/routers/<router_name>/priority

See priority for more information.

Key (Path) Value
traefik/http/routers/myrouter/priority 42

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/scheme http
traefik/http/services/<service_name>/loadbalancer/servers/<n>/scheme

Overrides the default scheme.

Key (Path) Value
traefik/http/services/myservice/loadbalancer/servers/0/scheme http
traefik/http/services/<service_name>/loadbalancer/passhostheader

See pass Host header for more information.

Key (Path) Value
traefik/http/services/myservice/loadbalancer/passhostheader true
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-Foo foobar
traefik/http/services/<service_name>/loadbalancer/healthcheck/hostname

See health check for more information.

Key (Path) Value
traefik/http/services/myservice/loadbalancer/healthcheck/hostname example.org
traefik/http/services/<service_name>/loadbalancer/healthcheck/interval

See health check for more information.

Key (Path) Value
traefik/http/services/myservice/loadbalancer/healthcheck/interval 10
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/port 42
traefik/http/services/<service_name>/loadbalancer/healthcheck/scheme

See health check for more information.

Key (Path) Value
traefik/http/services/myservice/loadbalancer/healthcheck/scheme http
traefik/http/services/<service_name>/loadbalancer/healthcheck/timeout

See health check for more information.

Key (Path) Value
traefik/http/services/myservice/loadbalancer/healthcheck/timeout 10
traefik/http/services/<service_name>/loadbalancer/sticky

See sticky sessions for more information.

Key (Path) Value
traefik/http/services/myservice/loadbalancer/sticky true
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/httponly true
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/name foobar
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/secure true
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/samesite none
traefik/http/services/<service_name>/loadbalancer/responseforwarding/flushinterval

See response forwarding for more information.

Key (Path) Value
traefik/http/services/myservice/loadbalancer/responseforwarding/flushinterval 10
traefik/http/services/<service_name>/mirroring/service
Key (Path) Value
traefik/http/services/<service_name>/mirroring/service foobar
traefik/http/services/<service_name>/mirroring/mirrors/<n>/name
Key (Path) Value
traefik/http/services/<service_name>/mirroring/mirrors/<n>/name foobar
traefik/http/services/<service_name>/mirroring/mirrors/<n>/percent
Key (Path) Value
traefik/http/services/<service_name>/mirroring/mirrors/<n>/percent 42
traefik/http/services/<service_name>/weighted/services/<n>/name
Key (Path) Value
traefik/http/services/<service_name>/weighted/services/<n>/name foobar
traefik/http/services/<service_name>/weighted/services/<n>/weight
Key (Path) Value
traefik/http/services/<service_name>/weighted/services/<n>/weight 42
traefik/http/services/<service_name>/weighted/sticky/cookie/name
Key (Path) Value
traefik/http/services/<service_name>/weighted/sticky/cookie/name foobar
traefik/http/services/<service_name>/weighted/sticky/cookie/secure
Key (Path) Value
traefik/http/services/<service_name>/weighted/sticky/cookie/secure true
traefik/http/services/<service_name>/weighted/sticky/cookie/samesite
Key (Path) Value
traefik/http/services/<service_name>/weighted/sticky/cookie/samesite none
traefik/http/services/<service_name>/weighted/sticky/cookie/httpOnly
Key (Path) Value
traefik/http/services/<service_name>/weighted/sticky/cookie/httpOnly true

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/0 ep1
traefik/tcp/routers/mytcprouter/entrypoints/1 ep2
traefik/tcp/routers/<router_name>/rule

See rule for more information.

Key (Path) Value
traefik/tcp/routers/my-router/rule HostSNI(`example.com`)
traefik/tcp/routers/<router_name>/service

See service for more information.

Key (Path) Value
traefik/tcp/routers/mytcprouter/service myservice
traefik/tcp/routers/<router_name>/tls

See TLS for more information.

Key (Path) Value
traefik/tcp/routers/mytcprouter/tls true
traefik/tcp/routers/<router_name>/tls/certresolver

See certResolver for more information.

Key (Path) Value
traefik/tcp/routers/mytcprouter/tls/certresolver myresolver
traefik/tcp/routers/<router_name>/tls/domains/<n>/main

See domains for more information.

Key (Path) Value
traefik/tcp/routers/mytcprouter/tls/domains/0/main example.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/0 test.example.org
traefik/tcp/routers/mytcprouter/tls/domains/0/sans/1 dev.example.org
traefik/tcp/routers/<router_name>/tls/options

See options for more information.

Key (Path) Value
traefik/tcp/routers/mytcprouter/tls/options foobar
traefik/tcp/routers/<router_name>/tls/passthrough

See TLS for more information.

Key (Path) Value
traefik/tcp/routers/mytcprouter/tls/passthrough true

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/scheme http
traefik/tcp/services/<service_name>/loadbalancer/terminationdelay

See termination delay for more information.

Key (Path) Value
traefik/tcp/services/mytcpservice/loadbalancer/terminationdelay 100
traefik/tcp/services/<service_name>/weighted/services/<n>/name
Key (Path) Value
traefik/tcp/services/<service_name>/weighted/services/0/name foobar
traefik/tcp/services/<service_name>/weighted/services/<n>/weight
Key (Path) Value
traefik/tcp/services/<service_name>/weighted/services/0/weight 42