Traefik & ECS¶
A Story of Labels & Elastic Containers
Attach labels to your containers and let Traefik do the rest!
Routing Configuration¶
labels
- labels are case insensitive.
- The complete list of labels can be found in the reference page.
General¶
Traefik creates, for each elastic service, a corresponding service and router.
The Service automatically gets a server per elastic container, and the router gets a default rule attached to it, based on the service name.
Routers¶
To update the configuration of the Router automatically attached to the service, add labels starting with traefik.routers.{name-of-your-choice}. and followed by the option you want to change.
For example, to change the rule, you could add the label traefik.http.routers.my-service.rule=Host(`example.com`).
The character @ is not authorized in the router name <router_name>.
traefik.http.routers.<router_name>.rule
See rule for more information.
traefik.http.routers.myrouter.rule=Host(`example.com`)traefik.http.routers.<router_name>.entrypoints
See entry points for more information.
traefik.http.routers.myrouter.entrypoints=web,websecuretraefik.http.routers.<router_name>.middlewares
See middlewares and middlewares overview for more information.
traefik.http.routers.myrouter.middlewares=auth,prefix,cbtraefik.http.routers.<router_name>.service
See rule for more information.
traefik.http.routers.myrouter.service=myservicetraefik.http.routers.<router_name>.tls
See tls for more information.
traefik.http.routers.myrouter>.tls=truetraefik.http.routers.<router_name>.tls.certresolver
See certResolver for more information.
traefik.http.routers.myrouter.tls.certresolver=myresolvertraefik.http.routers.<router_name>.tls.domains[n].main
See domains for more information.
traefik.http.routers.myrouter.tls.domains[0].main=example.orgtraefik.http.routers.<router_name>.tls.domains[n].sans
See domains for more information.
traefik.http.routers.myrouter.tls.domains[0].sans=test.example.org,dev.example.orgtraefik.http.routers.<router_name>.tls.options
See options for more information.
traefik.http.routers.myrouter.tls.options=foobartraefik.http.routers.<router_name>.priority
See priority for more information.
traefik.http.routers.myrouter.priority=42Services¶
To update the configuration of the Service automatically attached to the service,
add labels starting with traefik.http.services.{name-of-your-choice}., followed by the option you want to change.
For example, to change the passHostHeader behavior,
you'd add the label traefik.http.services.{name-of-your-choice}.loadbalancer.passhostheader=false.
The character @ is not authorized in the service name <service_name>.
traefik.http.services.<service_name>.loadbalancer.server.port
Registers a port. Useful when the service exposes multiples ports.
traefik.http.services.myservice.loadbalancer.server.port=8080traefik.http.services.<service_name>.loadbalancer.server.scheme
Overrides the default scheme.
traefik.http.services.myservice.loadbalancer.server.scheme=httptraefik.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.
traefik.http.services.<service_name>.loadbalancer.serverstransport=foobar@filetraefik.http.services.<service_name>.loadbalancer.passhostheader
See pass Host header for more information.
traefik.http.services.myservice.loadbalancer.passhostheader=truetraefik.http.services.<service_name>.loadbalancer.healthcheck.headers.<header_name>
See health check for more information.
traefik.http.services.myservice.loadbalancer.healthcheck.headers.X-Foo=foobartraefik.http.services.<service_name>.loadbalancer.healthcheck.hostname
See health check for more information.
traefik.http.services.myservice.loadbalancer.healthcheck.hostname=example.orgtraefik.http.services.<service_name>.loadbalancer.healthcheck.interval
See health check for more information.
traefik.http.services.myservice.loadbalancer.healthcheck.interval=10traefik.http.services.<service_name>.loadbalancer.healthcheck.path
See health check for more information.
traefik.http.services.myservice.loadbalancer.healthcheck.path=/footraefik.http.services.<service_name>.loadbalancer.healthcheck.method
See health check for more information.
traefik.http.services.myservice.loadbalancer.healthcheck.method=foobartraefik.http.services.<service_name>.loadbalancer.healthcheck.port
See health check for more information.
traefik.http.services.myservice.loadbalancer.healthcheck.port=42traefik.http.services.<service_name>.loadbalancer.healthcheck.scheme
See health check for more information.
traefik.http.services.myservice.loadbalancer.healthcheck.scheme=httptraefik.http.services.<service_name>.loadbalancer.healthcheck.timeout
See health check for more information.
traefik.http.services.myservice.loadbalancer.healthcheck.timeout=10traefik.http.services.<service_name>.loadbalancer.healthcheck.followredirects
See health check for more information.
traefik.http.services.myservice.loadbalancer.healthcheck.followredirects=truetraefik.http.services.<service_name>.loadbalancer.sticky.cookie
See sticky sessions for more information.
traefik.http.services.myservice.loadbalancer.sticky.cookie=truetraefik.http.services.<service_name>.loadbalancer.sticky.cookie.httponly
See sticky sessions for more information.
traefik.http.services.myservice.loadbalancer.sticky.cookie.httponly=truetraefik.http.services.<service_name>.loadbalancer.sticky.cookie.name
See sticky sessions for more information.
traefik.http.services.myservice.loadbalancer.sticky.cookie.name=foobartraefik.http.services.<service_name>.loadbalancer.sticky.cookie.secure
See sticky sessions for more information.
traefik.http.services.myservice.loadbalancer.sticky.cookie.secure=truetraefik.http.services.<service_name>.loadbalancer.sticky.cookie.samesite
See sticky sessions for more information.
traefik.http.services.myservice.loadbalancer.sticky.cookie.samesite=nonetraefik.http.services.<service_name>.loadbalancer.responseforwarding.flushinterval
See response forwarding for more information.
FlushInterval specifies the flush interval to flush to the client while copying the response body.
traefik.http.services.myservice.loadbalancer.responseforwarding.flushinterval=10Middleware¶
You can declare pieces of middleware using labels starting with traefik.http.middlewares.{name-of-your-choice}., followed by the middleware type/options.
For example, to declare a middleware redirectscheme named my-redirect, you'd write traefik.http.middlewares.my-redirect.redirectscheme.scheme: https.
More information about available middlewares in the dedicated middlewares section.
The character @ is not authorized in the middleware name.
Declaring and Referencing a Middleware
# ...
# Declaring a middleware
traefik.http.middlewares.my-redirect.redirectscheme.scheme=https
# Referencing a middleware
traefik.http.routers.my-service.middlewares=my-redirectConflicts 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 labels.
Declaring TCP Routers and Services
traefik.tcp.routers.my-router.rule=HostSNI(`example.com`)
traefik.tcp.routers.my-router.tls=true
traefik.tcp.services.my-service.loadbalancer.server.port=4123TCP and HTTP
If you declare a TCP Router/Service, it will prevent Traefik from automatically creating an HTTP Router/Service (like it does by default if no TCP Router/Service is defined). You can declare both a TCP Router/Service and an HTTP Router/Service for the same elastic service (but you have to do so manually).
TCP Routers¶
traefik.tcp.routers.<router_name>.entrypoints
See entry points for more information.
traefik.tcp.routers.mytcprouter.entrypoints=ep1,ep2traefik.tcp.routers.<router_name>.rule
See rule for more information.
traefik.tcp.routers.mytcprouter.rule=HostSNI(`example.com`)traefik.tcp.routers.<router_name>.service
See service for more information.
traefik.tcp.routers.mytcprouter.service=myservicetraefik.tcp.routers.<router_name>.tls
See TLS for more information.
traefik.tcp.routers.mytcprouter.tls=truetraefik.tcp.routers.<router_name>.tls.certresolver
See certResolver for more information.
traefik.tcp.routers.mytcprouter.tls.certresolver=myresolvertraefik.tcp.routers.<router_name>.tls.domains[n].main
See domains for more information.
traefik.tcp.routers.mytcprouter.tls.domains[0].main=example.orgtraefik.tcp.routers.<router_name>.tls.domains[n].sans
See domains for more information.
traefik.tcp.routers.mytcprouter.tls.domains[0].sans=test.example.org,dev.example.orgtraefik.tcp.routers.<router_name>.tls.options
See options for more information.
traefik.tcp.routers.mytcprouter.tls.options=mysoptionstraefik.tcp.routers.<router_name>.tls.passthrough
See TLS for more information.
traefik.tcp.routers.mytcprouter.tls.passthrough=truetraefik.tcp.routers.<router_name>.priority
See priority for more information.
traefik.tcp.routers.myrouter.priority=42TCP Services¶
traefik.tcp.services.<service_name>.loadbalancer.server.port
Registers a port of the application.
traefik.tcp.services.mytcpservice.loadbalancer.server.port=423traefik.tcp.services.<service_name>.loadbalancer.terminationdelay
See termination delay for more information.
traefik.tcp.services.mytcpservice.loadbalancer.terminationdelay=100traefik.tcp.services.<service_name>.loadbalancer.proxyprotocol.version
See PROXY protocol for more information.
traefik.tcp.services.mytcpservice.loadbalancer.proxyprotocol.version=1UDP¶
You can declare UDP Routers and/or Services using tags.
Declaring UDP Routers and Services
traefik.udp.routers.my-router.entrypoints=udp
traefik.udp.services.my-service.loadbalancer.server.port=4123UDP and HTTP
If you declare a UDP Router/Service, it will prevent Traefik from automatically creating an HTTP Router/Service (like it does by default if no UDP Router/Service is defined). You can declare both a UDP Router/Service and an HTTP Router/Service for the same elastic service (but you have to do so manually).
UDP Routers¶
traefik.udp.routers.<router_name>.entrypoints
See entry points for more information.
traefik.udp.routers.myudprouter.entrypoints=ep1,ep2traefik.udp.routers.<router_name>.service
See service for more information.
traefik.udp.routers.myudprouter.service=myserviceUDP Services¶
traefik.udp.services.<service_name>.loadbalancer.server.port
Registers a port of the application.
traefik.udp.services.myudpservice.loadbalancer.server.port=423Specific Provider Options¶
traefik.enable¶
traefik.enable=trueYou can tell Traefik to consider (or not) the ECS service by setting traefik.enable to true or false.
This option overrides the value of exposedByDefault.