traefik/docs/content/providers/marathon.md

Traefik & Marathon

Traefik can be configured to use Marathon as a provider. {: .subtitle }

See also Marathon user guide.

Configuration Examples

??? example "Configuring Marathon & Deploying / Exposing Applications"

Enabling the marathon provider

```toml tab="File"
[providers.marathon]
endpoint = "http://127.0.0.1:8080"
```

```txt tab="CLI"
--providers.marathon
--providers.marathon.endpoint="http://127.0.0.1:8080"
```

Attaching labels to marathon applications

```json
{
	"id": "/whoami",
	"container": {
		"type": "DOCKER",
		"docker": {
			"image": "containous/whoami",
			"network": "BRIDGE",
			"portMappings": [
				{
					"containerPort": 80,
					"hostPort": 0,
					"protocol": "tcp"
				}
			]
		}
	},
	"labels": {
		"traefik.http.Routers.app.Rule": "PathPrefix(`/app`)"
	}
}
```

Provider Configuration Options

!!! tip "Browse the Reference" If you're in a hurry, maybe you'd rather go through the static and the dynamic configuration references.

basic

Optional

Enables Marathon basic authentication.

[marathon.basic]
httpBasicAuthUser = "foo"
httpBasicPassword = "bar"

--providers.marathon
--providers.marathon.basic.httpbasicauthuser="foo"
--providers.marathon.basic.httpbasicpassword="bar"

dcosToken

Optional

DCOSToken for DCOS environment.

If set, it overrides the Authorization header.

[marathon]
dcosToken = "xxxxxx"
# ...

--providers.marathon
--providers.marathon.dcosToken="xxxxxx"

defaultRule

Optional, Default=Host(`{{ normalize .Name }}`)

For a given application if no routing rule was defined by a label, it is defined by this defaultRule instead.

It must be a valid Go template, augmented with the sprig template functions.

The app ID can be accessed as the Name identifier, and the template has access to all the labels defined on this Marathon application.

[marathon]
defaultRule = ""
# ...

--providers.marathon
--providers.marathon.defaultRule="Host(`{{ .Name }}.{{ index .Labels \"customLabel\"}}`)"

dialerTimeout

Optional, Default=5s

Overrides DialerTimeout.

Amount of time the Marathon provider should wait before timing out, when trying to open a TCP connection to a Marathon master.

Can be provided in a format supported by time.ParseDuration, or directly as a number of seconds.

endpoint

Optional, Default=http://127.0.0.1:8080

Marathon server endpoint.

You can optionally specify multiple endpoints:

[marathon]
endpoint = "http://10.241.1.71:8080,10.241.1.72:8080,10.241.1.73:8080"
# ...

--providers.marathon
--providers.marathon.endpoint="http://10.241.1.71:8080,10.241.1.72:8080,10.241.1.73:8080"

exposedByDefault

Optional, Default=true

Exposes Marathon applications by default through Traefik.

If set to false, applications that don't have a traefik.enable=true label will be ignored from the resulting routing configuration.

filterMarathonConstraints

Optional, Default=false

Enables filtering using Marathon constraints.

If enabled, Traefik will take into account Marathon constraints, as defined in Marathon constraints.

Each individual constraint will be treated as a verbatim compounded tag, e.g. "rack_id:CLUSTER:rack-1", with all constraint groups concatenated together using ":".

forceTaskHostname

Optional, Default=false

By default, a task's IP address (as returned by the Marathon API) is used as backend server if an IP-per-task configuration can be found; otherwise, the name of the host running the task is used. The latter behavior can be enforced by enabling this switch.

keepAlive

Optional, Default=10s

Set the TCP Keep Alive interval for the Marathon HTTP Client. Can be provided in a format supported by time.ParseDuration, or directly as a number of seconds.

respectReadinessChecks

Optional, Default=false

Applications may define readiness checks which are probed by Marathon during deployments periodically, and these check results are exposed via the API. Enabling respectReadinessChecks causes Traefik to filter out tasks whose readiness checks have not succeeded. Note that the checks are only valid at deployment times.

See the Marathon guide for details.

responseHeaderTimeout

Optional, Default=60s

Overrides ResponseHeaderTimeout. Amount of time the Marathon provider should wait before timing out, when waiting for the first response header from a Marathon master.

Can be provided in a format supported by time.ParseDuration, or directly as a number of seconds.

TLS

Optional

TLS client configuration. tls/#Config.

[marathon.TLS]
CA = "/etc/ssl/ca.crt"
Cert = "/etc/ssl/marathon.cert"
Key = "/etc/ssl/marathon.key"
insecureSkipVerify = true

--providers.marathon.tls
--providers.marathon.tls.ca="/etc/ssl/ca.crt"
--providers.marathon.tls.cert="/etc/ssl/marathon.cert"
--providers.marathon.tls.key="/etc/ssl/marathon.key"
--providers.marathon.tls.insecureskipverify=true

TLSHandshakeTimeout

Optional, Default=5s

Overrides TLSHandshakeTimeout. Amount of time the Marathon provider should wait before timing out, when waiting for the TLS handshake to complete. Can be provided in a format supported by time.ParseDuration, or directly as a number of seconds.

trace

Optional, Default=false

Displays additional provider logs (if available).

watch

Optional, Default=true

Enables watching for Marathon changes.

Routing Configuration Options

General

Traefik creates, for each Marathon application, a corresponding service and router.

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).

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. For example, to change the routing rule, you could add the label traefik.HTTP.Routers.Routername.Rule=Host(`my-domain`).

Every Router parameter can be updated this way.

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 load balancer method, you'd add the label traefik.HTTP.Services.Servicename.LoadBalancer.Method=drr.

Every Service parameter can be updated this way.

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 schemeredirect named my-redirect, you'd write traefik.HTTP.Middlewares.my-redirect.RedirectScheme.Scheme: https.

??? example "Declaring and Referencing a Middleware"

```json
{
	...
	"labels": {
		"traefik.http.middlewares.my-redirect.schemeredirect.scheme": "https",
		"traefik.http.routers.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.

More information about available middlewares in the dedicated middlewares section.

TCP

You can declare TCP Routers and/or Services using labels.

??? example "Declaring TCP Routers and Services"

```json
{
	...
	"labels": {
		"traefik.tcp.routers.my-router.rule": "HostSNI(`my-host.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 (as it would by default if no TCP Router/Service is defined).
Both a TCP Router/Service and an HTTP Router/Service can be created for the same application, but it has to be done explicitly in the config.

Specific Options

traefik.enable

Setting this option controls whether Traefik exposes the application. It overrides the value of exposedByDefault.

traefik.tags

Sets the tags for constraints filtering.

traefik.marathon.ipadressidx

If a task has several IP addresses, this option specifies which one, in the list of available addresses, to select.