baalajimaestro/traefik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions
traefik/docs/content/routing/providers/marathon.md

507 lines
15 KiB
Markdown
Raw Normal View History

Improve routing documentation
2019-09-23 12:32:04 +00:00
# Traefik & Marathon
Traefik can be configured to use Marathon as a provider.
{: .subtitle }
See also [Marathon user guide](../../user-guides/marathon.md).
## Routing Configuration
!!! info "Labels"
- Labels are case insensitive.
clarify automatic service creation/assignment with labels
2019-09-26 10:48:05 +00:00
- The complete list of labels can be found in [the reference page](../../reference/dynamic-configuration/marathon.md).
Improve routing documentation
2019-09-23 12:32:04 +00:00
### General
Traefik creates, for each Marathon application, a corresponding [service](../services/index.md) and [router](../routers/index.md).
The Service automatically gets a server per instance of the application,
and the router automatically gets a rule defined by defaultRule (if no rule for it was defined in labels).
clarify automatic service creation/assignment with labels
2019-09-26 10:48:05 +00:00
#### Service definition
--8<-- "content/routing/providers/service-by-label.md"
??? example "Automatic service assignment with labels"
Service myservice gets automatically assigned to router myproxy.
```json
labels: {
doc: Use neutral domains.
2020-03-13 21:50:05 +00:00
"traefik.http.routers.myproxy.rule": "Host(`example.net`)",
clarify automatic service creation/assignment with labels
2019-09-26 10:48:05 +00:00
"traefik.http.services.myservice.loadbalancer.server.port": "80"
}
```
??? example "Automatic service creation and assignment with labels"
No service specified or defined, and yet one gets automatically created.
and assigned to router myproxy.
```json
labels: {
doc: Use neutral domains.
2020-03-13 21:50:05 +00:00
"traefik.http.routers.myproxy.rule": "Host(`example.net`)"
clarify automatic service creation/assignment with labels
2019-09-26 10:48:05 +00:00
}
```
Improve routing documentation
2019-09-23 12:32:04 +00:00
### Routers
To update the configuration of the Router automatically attached to the application,
add labels starting with `traefik.http.routers.{router-name-of-your-choice}.` and followed by the option you want to change.
doc: Use neutral domains.
2020-03-13 21:50:05 +00:00
For example, to change the routing rule, you could add the label ```"traefik.http.routers.routername.rule": "Host(`example.com`)"```.
Improve routing documentation
2019-09-23 12:32:04 +00:00
doc: @ is not authorized in names definition.
2019-10-28 10:04:05 +00:00
!!! warning "The character `@` is not authorized in the router name `<router_name>`."
Improve routing documentation
2019-09-23 12:32:04 +00:00
??? info "`traefik.http.routers.<router_name>.rule`"
See [rule](../routers/index.md#rule) for more information.
```json
doc: Use neutral domains.
2020-03-13 21:50:05 +00:00
"traefik.http.routers.myrouter.rule": "Host(`example.com`)"
Improve routing documentation
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.routers.<router_name>.entrypoints`"
See [entry points](../routers/index.md#entrypoints) for more information.
```json
Update router entrypoint example
2019-11-27 19:08:03 +00:00
"traefik.http.routers.myrouter.entrypoints": "ep1,ep2"
Improve routing documentation
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.routers.<router_name>.middlewares`"
See [middlewares](../routers/index.md#middlewares) and [middlewares overview](../../middlewares/overview.md) for more information.
```json
"traefik.http.routers.myrouter.middlewares": "auth,prefix,cb"
```
??? info "`traefik.http.routers.<router_name>.service`"
See [rule](../routers/index.md#service) for more information.
```json
"traefik.http.routers.myrouter.service": "myservice"
```
??? info "`traefik.http.routers.<router_name>.tls`"
See [tls](../routers/index.md#tls) for more information.
```json
Improve documentation for ACME/Let's Encrypt
2019-12-09 17:08:04 +00:00
"traefik.http.routers.myrouter.tls": "true"
Improve routing documentation
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.routers.<router_name>.tls.certresolver`"
See [certResolver](../routers/index.md#certresolver) for more information.
```json
"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.
```json
doc: Use neutral domains.
2020-03-13 21:50:05 +00:00
"traefik.http.routers.myrouter.tls.domains[0].main": "example.org"
Improve routing documentation
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.routers.<router_name>.tls.domains[n].sans`"
See [domains](../routers/index.md#domains) for more information.
```json
doc: Use neutral domains.
2020-03-13 21:50:05 +00:00
"traefik.http.routers.myrouter.tls.domains[0].sans": "test.example.org,dev.example.org"
Improve routing documentation
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.routers.<router_name>.tls.options`"
See [options](../routers/index.md#options) for more information.
```json
"traefik.http.routers.myrouter.tls.options": "foobar"
```
??? info "`traefik.http.routers.<router_name>.priority`"
Add the router priority documentation
2019-09-26 13:16:05 +00:00
Fix error in link description for priority
2019-10-28 22:20:03 +00:00
See [priority](../routers/index.md#priority) for more information.
Improve routing documentation
2019-09-23 12:32:04 +00:00
```json
"traefik.http.routers.myrouter.priority": "42"
```
### Services
To update the configuration of the Service automatically attached to the container,
add labels starting with `traefik.http.services.{service-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.servicename.loadbalancer.passhostheader": "false"`.
doc: @ is not authorized in names definition.
2019-10-28 10:04:05 +00:00
!!! warning "The character `@` is not authorized in the service name `<service_name>`."
Improve routing documentation
2019-09-23 12:32:04 +00:00
??? info "`traefik.http.services.<service_name>.loadbalancer.server.port`"
Registers a port.
Useful when the container exposes multiples ports.
```json
"traefik.http.services.myservice.loadbalancer.server.port": "8080"
```
??? info "`traefik.http.services.<service_name>.loadbalancer.server.scheme`"
Overrides the default scheme.
```json
"traefik.http.services.myservice.loadbalancer.server.scheme": "http"
```
Add missing doc about servers transport.
2021-02-15 11:04:04 +00:00
??? info "`traefik.http.services.<service_name>.loadbalancer.serverstransport`"
See [serverstransport](../services/index.md#serverstransport) for more information.
```json
"traefik.http.services.<service_name>.loadbalancer.serverstransport": "foobar"
```
Improve routing documentation
2019-09-23 12:32:04 +00:00
??? info "`traefik.http.services.<service_name>.loadbalancer.passhostheader`"
Add the pass host header section to the services documentation
2019-09-30 09:26:06 +00:00
See [pass Host header](../services/index.md#pass-host-header) for more information.
Improve routing documentation
2019-09-23 12:32:04 +00:00
```json
"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.
```json
"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.
```json
doc: Use neutral domains.
2020-03-13 21:50:05 +00:00
"traefik.http.services.myservice.loadbalancer.healthcheck.hostname": "example.org"
Improve routing documentation
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.services.<service_name>.loadbalancer.healthcheck.interval`"
See [health check](../services/index.md#health-check) for more information.
```json
"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.
```json
"traefik.http.services.myservice.loadbalancer.healthcheck.path": "/foo"
```
??? info "`traefik.http.services.<service_name>.loadbalancer.healthcheck.port`"
See [health check](../services/index.md#health-check) for more information.
```json
"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.
```json
"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.
```json
"traefik.http.services.myservice.loadbalancer.healthcheck.timeout": "10"
```
Do not follow redirects for the health check URLs
2020-02-26 16:28:04 +00:00
??? info "`traefik.http.services.<service_name>.loadbalancer.healthcheck.followredirects`"
See [health check](../services/index.md#health-check) for more information.
```json
"traefik.http.services.myservice.loadbalancer.healthcheck.followredirects": "true"
```
fix: cookie documentation.
2020-04-29 15:10:05 +00:00
??? info "`traefik.http.services.<service_name>.loadbalancer.sticky.cookie`"
Improve routing documentation
2019-09-23 12:32:04 +00:00
See [sticky sessions](../services/index.md#sticky-sessions) for more information.
```json
fix: cookie documentation.
2020-04-29 15:10:05 +00:00
"traefik.http.services.myservice.loadbalancer.sticky.cookie": "true"
Improve routing documentation
2019-09-23 12:32:04 +00:00
```
??? info "`traefik.http.services.<service_name>.loadbalancer.sticky.cookie.httponly`"
See [sticky sessions](../services/index.md#sticky-sessions) for more information.
```json
"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.
```json
"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.
```json
"traefik.http.services.myservice.loadbalancer.sticky.cookie.secure": "true"
```
Fix sameSite (Traefik v2)
2020-03-23 10:24:05 +00:00
??? info "`traefik.http.services.<service_name>.loadbalancer.sticky.cookie.samesite`"
See [sticky sessions](../services/index.md#sticky-sessions) for more information.
```json
"traefik.http.services.myservice.loadbalancer.sticky.cookie.samesite": "none"
```
Improve routing documentation
2019-09-23 12:32:04 +00:00
??? info "`traefik.http.services.<service_name>.loadbalancer.responseforwarding.flushinterval`"
Add a response forwarding section to the service documentation
2019-10-01 11:26:04 +00:00
See [response forwarding](../services/index.md#response-forwarding) for more information.
Improve routing documentation
2019-09-23 12:32:04 +00:00
```json
"traefik.http.services.myservice.loadbalancer.responseforwarding.flushinterval": "10"
```
### Middleware
You can declare pieces of middleware using labels starting with `traefik.http.middlewares.{middleware-name-of-your-choice}.`, followed by the middleware type/options.
For example, to declare a middleware [`redirectscheme`](../../middlewares/redirectscheme.md) named `my-redirect`, you'd write `"traefik.http.middlewares.my-redirect.redirectscheme.scheme": "https"`.
More information about available middlewares in the dedicated [middlewares section](../../middlewares/overview.md).
doc: @ is not authorized in names definition.
2019-10-28 10:04:05 +00:00
!!! warning "The character `@` is not authorized in the middleware name."
Improve routing documentation
2019-09-23 12:32:04 +00:00
??? example "Declaring and Referencing a Middleware"
```json
{
...
"labels": {
"traefik.http.middlewares.my-redirect.redirectscheme.scheme": "https",
"traefik.http.routers.my-container.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"
```json
{
...
"labels": {
doc: Use neutral domains.
2020-03-13 21:50:05 +00:00
"traefik.tcp.routers.my-router.rule": "HostSNI(`example.com`)",
Improve routing documentation
2019-09-23 12:32:04 +00:00
"traefik.tcp.routers.my-router.tls": "true",
"traefik.tcp.services.my-service.loadbalancer.server.port": "4123"
}
}
```
!!! warning "TCP and HTTP"
YAML I love you
2019-09-23 15:00:06 +00:00
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 container (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.
```json
"traefik.tcp.routers.mytcprouter.entrypoints": "ep1,ep2"
```
??? info "`traefik.tcp.routers.<router_name>.rule`"
See [rule](../routers/index.md#rule_1) for more information.
```json
doc: Use neutral domains.
2020-03-13 21:50:05 +00:00
"traefik.tcp.routers.mytcprouter.rule": "HostSNI(`example.com`)"
YAML I love you
2019-09-23 15:00:06 +00:00
```
??? info "`traefik.tcp.routers.<router_name>.service`"
See [service](../routers/index.md#services) for more information.
```json
"traefik.tcp.routers.mytcprouter.service": "myservice"
```
??? info "`traefik.tcp.routers.<router_name>.tls`"
See [TLS](../routers/index.md#tls_1) for more information.
```json
"traefik.tcp.routers.mytcprouter.tls": "true
```
??? info "`traefik.tcp.routers.<router_name>.tls.certresolver`"
See [certResolver](../routers/index.md#certresolver_1) for more information.
```json
"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.
```json
doc: Use neutral domains.
2020-03-13 21:50:05 +00:00
"traefik.tcp.routers.mytcprouter.tls.domains[0].main": "example.org"
YAML I love you
2019-09-23 15:00:06 +00:00
```
??? info "`traefik.tcp.routers.<router_name>.tls.domains[n].sans`"
See [domains](../routers/index.md#domains_1) for more information.
```json
doc: Use neutral domains.
2020-03-13 21:50:05 +00:00
"traefik.tcp.routers.mytcprouter.tls.domains[0].sans": "test.example.org,dev.example.org"
YAML I love you
2019-09-23 15:00:06 +00:00
```
??? info "`traefik.tcp.routers.<router_name>.tls.options`"
See [options](../routers/index.md#options_1) for more information.
```json
"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.
```json
"traefik.tcp.routers.mytcprouter.tls.passthrough": "true"
```
#### TCP Services
??? info "`traefik.tcp.services.<service_name>.loadbalancer.server.port`"
Registers a port of the application.
```json
"traefik.tcp.services.mytcpservice.loadbalancer.server.port": "423"
```
??? info "`traefik.tcp.services.<service_name>.loadbalancer.terminationdelay`"
See [termination delay](../services/index.md#termination-delay) for more information.
```json
"traefik.tcp.services.mytcpservice.loadbalancer.terminationdelay": "100"
```
Improve routing documentation
2019-09-23 12:32:04 +00:00
added support for tcp proxyProtocol v1&v2 to backend
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.
```json
"traefik.tcp.services.mytcpservice.loadbalancer.proxyprotocol.version": "1"
```
Add UDP in providers with labels
2020-02-20 21:24:05 +00:00
### UDP
You can declare UDP Routers and/or Services using labels.
??? example "Declaring UDP Routers and Services"
```json
{
...
"labels": {
"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 container (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.
```json
"traefik.udp.routers.myudprouter.entrypoints": "ep1,ep2"
```
??? info "`traefik.udp.routers.<router_name>.service`"
See [service](../routers/index.md#services_1) for more information.
```json
"traefik.udp.routers.myudprouter.service": "myservice"
```
#### UDP Services
??? info "`traefik.udp.services.<service_name>.loadbalancer.server.port`"
Registers a port of the application.
```json
"traefik.udp.services.myudpservice.loadbalancer.server.port": "423"
```
Improve routing documentation
2019-09-23 12:32:04 +00:00
### Specific Provider Options
#### `traefik.enable`
```json
"traefik.enable": "true"
```
Setting this option controls whether Traefik exposes the application.
It overrides the value of `exposedByDefault`.
#### `traefik.marathon.ipadressidx`
```json
"traefik.marathon.ipadressidx": "1"
```
If a task has several IP addresses, this option specifies which one, in the list of available addresses, to select.
Reference in a new issue Copy permalink