2022-04-15 13:44:08 +00:00
---
title: "Traefik ECS Documentation"
description: "AWS ECS is a provider for routing and load balancing in Traefik Proxy. Read the technical documentation to get started."
---
2020-07-15 14:28:04 +00:00
# Traefik & ECS
A Story of Labels & Elastic Containers
{: .subtitle }
Attach labels to your containers and let Traefik do the rest!
2024-07-11 12:40:07 +00:00
One of the best feature of Traefik is to delegate the routing configuration to the application level.
With ECS, Traefik can leverage labels attached to a container to generate routing rules.
!!! warning "Labels & sensitive data"
We recommend to *not* use labels to store sensitive data (certificates, credentials, etc).
Instead, we recommend to store sensitive data in a safer storage (secrets, file, etc).
2020-07-15 14:28:04 +00:00
## Routing Configuration
!!! info "labels"
- labels are case insensitive.
2020-11-03 16:40:04 +00:00
- The complete list of labels can be found in [the reference page ](../../reference/dynamic-configuration/ecs.md ).
2020-07-15 14:28:04 +00:00
### General
Traefik creates, for each elastic service, a corresponding [service ](../services/index.md ) and [router ](../routers/index.md ).
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`)```.
!!! warning "The character `@` is not authorized in the router name `<router_name>` ."
??? info "`traefik.http.routers.< router_name > .rule`"
See [rule ](../routers/index.md#rule ) for more information.
```yaml
traefik.http.routers.myrouter.rule=Host(`example.com`)
```
??? info "`traefik.http.routers.< router_name > .entrypoints`"
See [entry points ](../routers/index.md#entrypoints ) for more information.
```yaml
traefik.http.routers.myrouter.entrypoints=web,websecure
```
??? info "`traefik.http.routers.< router_name > .middlewares`"
See [middlewares ](../routers/index.md#middlewares ) and [middlewares overview ](../../middlewares/overview.md ) for more information.
```yaml
traefik.http.routers.myrouter.middlewares=auth,prefix,cb
```
??? info "`traefik.http.routers.< router_name > .service`"
See [rule ](../routers/index.md#service ) for more information.
```yaml
traefik.http.routers.myrouter.service=myservice
```
??? info "`traefik.http.routers.< router_name > .tls`"
See [tls ](../routers/index.md#tls ) for more information.
```yaml
traefik.http.routers.myrouter>.tls=true
```
??? info "`traefik.http.routers.< router_name > .tls.certresolver`"
See [certResolver ](../routers/index.md#certresolver ) for more information.
```yaml
traefik.http.routers.myrouter.tls.certresolver=myresolver
```
??? info "`traefik.http.routers.< router_name > .tls.domains[n].main`"
See [domains ](../routers/index.md#domains ) for more information.
```yaml
traefik.http.routers.myrouter.tls.domains[0].main=example.org
```
??? info "`traefik.http.routers.< router_name > .tls.domains[n].sans`"
See [domains ](../routers/index.md#domains ) for more information.
```yaml
traefik.http.routers.myrouter.tls.domains[0].sans=test.example.org,dev.example.org
```
??? info "`traefik.http.routers.< router_name > .tls.options`"
See [options ](../routers/index.md#options ) for more information.
```yaml
traefik.http.routers.myrouter.tls.options=foobar
```
??? info "`traefik.http.routers.< router_name > .priority`"
See [priority ](../routers/index.md#priority ) for more information.
```yaml
traefik.http.routers.myrouter.priority=42
```
### Services
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` .
!!! warning "The character `@` is not authorized in the service name `<service_name>` ."
??? info "`traefik.http.services.< service_name > .loadbalancer.server.port`"
Registers a port.
Useful when the service exposes multiples ports.
```yaml
traefik.http.services.myservice.loadbalancer.server.port=8080
```
??? info "`traefik.http.services.< service_name > .loadbalancer.server.scheme`"
Overrides the default scheme.
```yaml
traefik.http.services.myservice.loadbalancer.server.scheme=http
```
2021-02-15 11:04:04 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.serverstransport`"
2021-03-03 15:48:04 +00:00
Allows to reference a ServersTransport resource that is defined either with the File provider or the Kubernetes CRD one.
2021-02-15 11:04:04 +00:00
See [serverstransport ](../services/index.md#serverstransport ) for more information.
```yaml
2021-03-03 15:48:04 +00:00
traefik.http.services.< service_name > .loadbalancer.serverstransport=foobar@file
2021-02-15 11:04:04 +00:00
```
2020-07-15 14:28:04 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.passhostheader`"
See [pass Host header ](../services/index.md#pass-host-header ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.passhostheader=true
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.headers.< header_name > `"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.healthcheck.headers.X-Foo=foobar
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.hostname`"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.healthcheck.hostname=example.org
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.interval`"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.healthcheck.interval=10
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.path`"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.healthcheck.path=/foo
```
2022-08-08 13:22:07 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.method`"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.healthcheck.method=foobar
```
2022-11-24 10:40:05 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.status`"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.healthcheck.status=42
```
2020-07-15 14:28:04 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.port`"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.healthcheck.port=42
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.scheme`"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.healthcheck.scheme=http
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.timeout`"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.healthcheck.timeout=10
```
??? info "`traefik.http.services.< service_name > .loadbalancer.healthcheck.followredirects`"
See [health check ](../services/index.md#health-check ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.healthcheck.followredirects=true
```
2021-02-15 11:04:04 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie`"
2020-07-15 14:28:04 +00:00
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
```yaml
2021-02-15 11:04:04 +00:00
traefik.http.services.myservice.loadbalancer.sticky.cookie=true
2020-07-15 14:28:04 +00:00
```
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie.httponly`"
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.sticky.cookie.httponly=true
```
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie.name`"
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.sticky.cookie.name=foobar
```
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie.secure`"
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.sticky.cookie.secure=true
```
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie.samesite`"
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.sticky.cookie.samesite=none
```
2024-01-18 08:30:06 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.sticky.cookie.maxage`"
See [sticky sessions ](../services/index.md#sticky-sessions ) for more information.
```yaml
traefik.http.services.myservice.loadbalancer.sticky.cookie.maxage=42
```
2020-07-15 14:28:04 +00:00
??? info "`traefik.http.services.< service_name > .loadbalancer.responseforwarding.flushinterval`"
See [response forwarding ](../services/index.md#response-forwarding ) for more information.
FlushInterval specifies the flush interval to flush to the client while copying the response body.
```yaml
traefik.http.services.myservice.loadbalancer.responseforwarding.flushinterval=10
```
### Middleware
You can declare pieces of middleware using labels starting with `traefik.http.middlewares.{name-of-your-choice}.` , followed by the middleware type/options.
2021-06-11 13:30:05 +00:00
For example, to declare a middleware [`redirectscheme` ](../../middlewares/http/redirectscheme.md ) named `my-redirect` , you'd write `traefik.http.middlewares.my-redirect.redirectscheme.scheme: https` .
2020-07-15 14:28:04 +00:00
More information about available middlewares in the dedicated [middlewares section ](../../middlewares/overview.md ).
!!! warning "The character `@` is not authorized in the middleware name."
??? example "Declaring and Referencing a Middleware"
```yaml
# ...
# Declaring a middleware
traefik.http.middlewares.my-redirect.redirectscheme.scheme=https
# Referencing a middleware
traefik.http.routers.my-service.middlewares=my-redirect
```
!!! warning "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 labels.
??? example "Declaring TCP Routers and Services"
```yaml
traefik.tcp.routers.my-router.rule=HostSNI(`example.com`)
traefik.tcp.routers.my-router.tls=true
traefik.tcp.services.my-service.loadbalancer.server.port=4123
```
!!! warning "TCP 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
??? info "`traefik.tcp.routers.< router_name > .entrypoints`"
See [entry points ](../routers/index.md#entrypoints_1 ) for more information.
```yaml
traefik.tcp.routers.mytcprouter.entrypoints=ep1,ep2
```
??? info "`traefik.tcp.routers.< router_name > .rule`"
See [rule ](../routers/index.md#rule_1 ) for more information.
```yaml
traefik.tcp.routers.mytcprouter.rule=HostSNI(`example.com`)
```
??? info "`traefik.tcp.routers.< router_name > .service`"
See [service ](../routers/index.md#services ) for more information.
```yaml
traefik.tcp.routers.mytcprouter.service=myservice
```
??? info "`traefik.tcp.routers.< router_name > .tls`"
See [TLS ](../routers/index.md#tls_1 ) for more information.
```yaml
traefik.tcp.routers.mytcprouter.tls=true
```
??? info "`traefik.tcp.routers.< router_name > .tls.certresolver`"
See [certResolver ](../routers/index.md#certresolver_1 ) for more information.
```yaml
traefik.tcp.routers.mytcprouter.tls.certresolver=myresolver
```
??? info "`traefik.tcp.routers.< router_name > .tls.domains[n].main`"
See [domains ](../routers/index.md#domains_1 ) for more information.
```yaml
traefik.tcp.routers.mytcprouter.tls.domains[0].main=example.org
```
??? info "`traefik.tcp.routers.< router_name > .tls.domains[n].sans`"
See [domains ](../routers/index.md#domains_1 ) for more information.
```yaml
traefik.tcp.routers.mytcprouter.tls.domains[0].sans=test.example.org,dev.example.org
```
??? info "`traefik.tcp.routers.< router_name > .tls.options`"
See [options ](../routers/index.md#options_1 ) for more information.
```yaml
traefik.tcp.routers.mytcprouter.tls.options=mysoptions
```
??? info "`traefik.tcp.routers.< router_name > .tls.passthrough`"
See [TLS ](../routers/index.md#tls_1 ) for more information.
```yaml
traefik.tcp.routers.mytcprouter.tls.passthrough=true
```
2022-03-17 17:02:08 +00:00
??? info "`traefik.tcp.routers.< router_name > .priority`"
See [priority ](../routers/index.md#priority_1 ) for more information.
```yaml
traefik.tcp.routers.myrouter.priority=42
```
2020-07-15 14:28:04 +00:00
#### TCP Services
??? info "`traefik.tcp.services.< service_name > .loadbalancer.server.port`"
Registers a port of the application.
```yaml
traefik.tcp.services.mytcpservice.loadbalancer.server.port=423
```
2022-12-09 08:58:05 +00:00
??? info "`traefik.tcp.services.< service_name > .loadbalancer.server.tls`"
Determines whether to use TLS when dialing with the backend.
2020-07-15 14:28:04 +00:00
```yaml
2022-12-09 08:58:05 +00:00
traefik.tcp.services.mytcpservice.loadbalancer.server.tls=true
2020-07-15 14:28:04 +00:00
```
2020-11-17 12:04:04 +00:00
??? info "`traefik.tcp.services.< service_name > .loadbalancer.proxyprotocol.version`"
See [PROXY protocol ](../services/index.md#proxy-protocol ) for more information.
```yaml
traefik.tcp.services.mytcpservice.loadbalancer.proxyprotocol.version=1
```
2022-12-09 08:58:05 +00:00
??? info "`traefik.tcp.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 ](../services/index.md#serverstransport_2 ) for more information.
```yaml
traefik.tcp.services.< service_name > .loadbalancer.serverstransport=foobar@file
```
2020-07-15 14:28:04 +00:00
### UDP
You can declare UDP Routers and/or Services using tags.
??? example "Declaring UDP Routers and Services"
```yaml
traefik.udp.routers.my-router.entrypoints=udp
traefik.udp.services.my-service.loadbalancer.server.port=4123
```
!!! warning "UDP 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
??? info "`traefik.udp.routers.< router_name > .entrypoints`"
See [entry points ](../routers/index.md#entrypoints_2 ) for more information.
```yaml
traefik.udp.routers.myudprouter.entrypoints=ep1,ep2
```
??? info "`traefik.udp.routers.< router_name > .service`"
See [service ](../routers/index.md#services_1 ) for more information.
```yaml
traefik.udp.routers.myudprouter.service=myservice
```
#### UDP Services
??? info "`traefik.udp.services.< service_name > .loadbalancer.server.port`"
Registers a port of the application.
```yaml
traefik.udp.services.myudpservice.loadbalancer.server.port=423
```
### Specific Provider Options
#### `traefik.enable`
```yaml
traefik.enable=true
```
You 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` .