

Traefik & Marathon

Traefik can be configured to use Marathon as a provider.

See also Marathon user guide.

Configuration Examples

Configuring Marathon & Deploying / Exposing Applications

Enabling the marathon provider

File (TOML)

[providers.marathon]

File (YAML)

providers:
  marathon: {}

CLI

--providers.marathon=true

Attaching labels to marathon applications

{
    "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

Browse the Reference

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

basic

Optional

File (TOML)

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

File (YAML)

providers:
  marathon:
    basic:
      httpBasicAuthUser: foo
      httpBasicPassword: bar

CLI

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

Enables Marathon basic authentication.

dcosToken

Optional

File (TOML)

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

File (YAML)

providers:
  marathon:
    dcosToken: "xxxxxx"
    # ...

CLI

--providers.marathon.dcosToken="xxxxxx"

DCOSToken for DCOS environment.

If set, it overrides the Authorization header.

defaultRule

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

File (TOML)

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

File (YAML)

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

CLI

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

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.

dialerTimeout

Optional, Default=5s

File (TOML)

[providers.marathon]
  dialerTimeout = "10s"
  # ...

File (YAML)

providers:
  marathon:
    dialerTimeout: "10s"
    # ...

CLI

--providers.marathon.dialerTimeout=10s

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

File (TOML)

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

File (YAML)

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

CLI

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

Marathon server endpoint.

You can optionally specify multiple endpoints:

exposedByDefault

Optional, Default=true

File (TOML)

[providers.marathon]
  exposedByDefault = false
  # ...

File (YAML)

providers:
  marathon:
    exposedByDefault: false
    # ...

CLI

--providers.marathon.exposedByDefault=false
# ...

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.

See also Restrict the Scope of Service Discovery.

constraints

Optional, Default=""

File (TOML)

[providers.marathon]
  constraints = "Label(`a.label.name`, `foo`)"
  # ...

File (YAML)

providers:
  marathon:
    constraints: "Label(`a.label.name`, `foo`)"
    # ...

CLI

--providers.marathon.constraints="Label(`a.label.name`, `foo`)"
# ...

Constraints is an expression that Traefik matches against the application's labels to determine whether to create any route for that application. That is to say, if none of the application's labels match the expression, no route for the application is created. In addition, the expression also matched against the application's constraints, such as described in Marathon constraints. If the expression is empty, all detected applications are included.

The expression syntax is based on the Label("key", "value"), and LabelRegexp("key", "value"), as well as the usual boolean logic. In addition, to match against marathon constraints, the function MarathonConstraint("field:operator:value") can be used, where the field, operator, and value parts are joined together in a single string with the : separator.

Constraints Expression Examples

# Includes only applications having a label with key `a.label.name` and value `foo`
constraints = "Label(`a.label.name`, `foo`)"

# Excludes applications having any label with key `a.label.name` and value `foo`
constraints = "!Label(`a.label.name`, `value`)"

# With logical AND.
constraints = "Label(`a.label.name`, `valueA`) && Label(`another.label.name`, `valueB`)"

# With logical OR.
constraints = "Label(`a.label.name`, `valueA`) || Label(`another.label.name`, `valueB`)"

# With logical AND and OR, with precedence set by parentheses.
constraints = "Label(`a.label.name`, `valueA`) && (Label(`another.label.name`, `valueB`) || Label(`yet.another.label.name`, `valueC`))"

# Includes only applications having a label with key `a.label.name` and a value matching the `a.+` regular expression.
constraints = "LabelRegexp(`a.label.name`, `a.+`)"

# Includes only applications having a Marathon constraint with field `A`, operator `B`, and value `C`.
constraints = "MarathonConstraint(`A:B:C`)"

# Uses both Marathon constraint and application label with logical operator.
constraints = "MarathonConstraint(`A:B:C`) && Label(`a.label.name`, `value`)"

See also Restrict the Scope of Service Discovery.

forceTaskHostname

Optional, Default=false

File (TOML)

[providers.marathon]
  forceTaskHostname = true
  # ...

File (YAML)

providers:
  marathon:
    forceTaskHostname: true
    # ...

CLI

--providers.marathon.forceTaskHostname=true
# ...

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

File (TOML)

[providers.marathon]
  keepAlive = "30s"
  # ...

File (YAML)

providers:
  marathon:
    keepAlive: "30s"
    # ...

CLI

--providers.marathon.keepAlive=30s
# ...

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

File (TOML)

[providers.marathon]
  respectReadinessChecks = true
  # ...

File (YAML)

providers:
  marathon:
    respectReadinessChecks: true
    # ...

CLI

--providers.marathon.respectReadinessChecks=true
# ...

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

File (TOML)

[providers.marathon]
  responseHeaderTimeout = "66s"
  # ...

File (YAML)

providers:
  marathon:
    responseHeaderTimeout: "66s"
    # ...

CLI

--providers.marathon.responseHeaderTimeout="66s"
# ...

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

File (TOML)

[providers.marathon.tls]
  ca = "/etc/ssl/ca.crt"
  cert = "/etc/ssl/marathon.cert"
  key = "/etc/ssl/marathon.key"
  insecureSkipVerify = true

File (YAML)

providers:
  marathon
    tls:
      ca: "/etc/ssl/ca.crt"
      cert: "/etc/ssl/marathon.cert"
      key: "/etc/ssl/marathon.key"
      insecureSkipVerify:  true

CLI

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

TLS client configuration. tls/#Config.

tlsHandshakeTimeout

Optional, Default=5s

File (TOML)

[providers.marathon]
  responseHeaderTimeout = "10s"
  # ...

File (YAML)

providers:
  marathon:
    responseHeaderTimeout: "10s"
    # ...

CLI

--providers.marathon.responseHeaderTimeout="10s"
# ...

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

File (TOML)

[providers.marathon]
  trace = true
  # ...

File (YAML)

providers:
  marathon:
    trace: true
    # ...

CLI

--providers.marathon.trace=true
# ...

Displays additional provider logs (if available).

watch

Optional, Default=true

File (TOML)

[providers.marathon]
  watch = false
  # ...

File (YAML)

providers:
  marathon:
    watch: false
    # ...

CLI

--providers.marathon.watch=false
# ...

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 passHostHeader behavior, you'd add the label traefik.http.services.servicename.loadbalancer.passhostheader=false.

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 redirectscheme named my-redirect, you'd write traefik.http.middlewares.my-redirect.redirectscheme.scheme: https.

Declaring and Referencing a Middleware

{
    ...
    "labels": {
        "traefik.http.middlewares.my-redirect.redirectscheme.scheme": "https",
        "traefik.http.routers.my-container.middlewares": "my-redirect"
    }
}

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.

Declaring TCP Routers and Services

{
    ...
    "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"
    }
}

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.marathon.ipadressidx

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