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 .

traefik/http/routers//rule

See rule for more information.

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

traefik/http/routers//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//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//service

See rule for more information.

Key (Path) Value
traefik/http/routers/myrouter/service myservice

traefik/http/routers//tls

See tls for more information.

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

traefik/http/routers//tls/certresolver

See certResolver for more information.

Key (Path) Value
traefik/http/routers/myrouter/tls/certresolver myresolver

traefik/http/routers//tls/domains//main

See domains for more information.

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

traefik/http/routers//tls/domains//sans/

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//tls/options

See options for more information.

Key (Path) Value
traefik/http/routers/myrouter/tls/options foobar

traefik/http/routers//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 .

traefik/http/services//loadbalancer/servers//url

See servers for more information.

Key (Path) Value
traefik/http/services/myservice/loadbalancer/servers/0/scheme http

traefik/http/services//loadbalancer/servers//scheme

Overrides the default scheme.

Key (Path) Value
traefik/http/services/myservice/loadbalancer/servers/0/scheme http

traefik/http/services//loadbalancer/passhostheader

See pass Host header for more information.

Key (Path) Value
traefik/http/services/myservice/loadbalancer/passhostheader true

traefik/http/services//loadbalancer/healthcheck/headers/

See health check for more information.

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

traefik/http/services//loadbalancer/healthcheck/hostname

See health check for more information.

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

traefik/http/services//loadbalancer/healthcheck/interval

See health check for more information.

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

traefik/http/services//loadbalancer/healthcheck/path

See health check for more information.

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

traefik/http/services//loadbalancer/healthcheck/port

See health check for more information.

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

traefik/http/services//loadbalancer/healthcheck/scheme

See health check for more information.

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

traefik/http/services//loadbalancer/healthcheck/timeout

See health check for more information.

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

traefik/http/services//loadbalancer/sticky

See sticky sessions for more information.

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

traefik/http/services//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//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//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//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//loadbalancer/responseforwarding/flushinterval

See response forwarding for more information.

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

traefik/http/services//mirroring/service

Key (Path) Value
traefik/http/services//mirroring/service foobar

traefik/http/services//mirroring/mirrors//name

Key (Path) Value
traefik/http/services//mirroring/mirrors//name foobar

traefik/http/services//mirroring/mirrors//percent

Key (Path) Value
traefik/http/services//mirroring/mirrors//percent 42

traefik/http/services//weighted/services//name

Key (Path) Value
traefik/http/services//weighted/services//name foobar

traefik/http/services//weighted/services//weight

Key (Path) Value
traefik/http/services//weighted/services//weight 42

traefik/http/services//weighted/sticky/cookie/name

Key (Path) Value
traefik/http/services//weighted/sticky/cookie/name foobar

traefik/http/services//weighted/sticky/cookie/secure

Key (Path) Value
traefik/http/services//weighted/sticky/cookie/secure true

traefik/http/services//weighted/sticky/cookie/samesite

Key (Path) Value
traefik/http/services//weighted/sticky/cookie/samesite none

traefik/http/services//weighted/sticky/cookie/httpOnly

Key (Path) Value
traefik/http/services//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//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//rule

See rule for more information.

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

traefik/tcp/routers//service

See service for more information.

Key (Path) Value
traefik/tcp/routers/mytcprouter/service myservice

traefik/tcp/routers//tls

See TLS for more information.

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

traefik/tcp/routers//tls/certresolver

See certResolver for more information.

Key (Path) Value
traefik/tcp/routers/mytcprouter/tls/certresolver myresolver

traefik/tcp/routers//tls/domains//main

See domains for more information.

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

traefik/tcp/routers//tls/domains//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//tls/options

See options for more information.

Key (Path) Value
traefik/tcp/routers/mytcprouter/tls/options foobar

traefik/tcp/routers//tls/passthrough

See TLS for more information.

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

TCP Services

traefik/tcp/services//loadbalancer/servers//url

See servers for more information.

Key (Path) Value
traefik/tcp/services/mytcpservice/loadbalancer/servers/0/scheme http

traefik/tcp/services//loadbalancer/terminationdelay

See termination delay for more information.

Key (Path) Value
traefik/tcp/services/mytcpservice/loadbalancer/terminationdelay 100

traefik/tcp/services//weighted/services//name

Key (Path) Value
traefik/tcp/services//weighted/services/0/name foobar

traefik/tcp/services//weighted/services//weight

Key (Path) Value
traefik/tcp/services//weighted/services/0/weight 42