Traefik & Marathon¶

Traefik can be configured to use Marathon as a provider.

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": "traefik/whoami",
            "network": "BRIDGE",
            "portMappings": [
                {
                    "containerPort": 80,
                    "hostPort": 0,
                    "protocol": "tcp"
                }
            ]
        }
    },
    "labels": {
        "traefik.http.Routers.app.Rule": "PathPrefix(`/app`)"
    }
}

Routing Configuration¶

See the dedicated section in routing.

Provider Configuration¶

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

`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 LabelRegex("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 = "LabelRegex(`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`)"

`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

`tls.ca`¶

Certificate Authority used for the secured connection to Marathon.

File (TOML)

[providers.marathon.tls]
  ca = "path/to/ca.crt"

File (YAML)

providers:
  marathon:
    tls:
      ca: path/to/ca.crt

CLI

--providers.marathon.tls.ca=path/to/ca.crt

`tls.caOptional`¶

Policy followed for the secured connection to Marathon with TLS Client Authentication. Requires tls.ca to be defined.

true: VerifyClientCertIfGiven
false: RequireAndVerifyClientCert
if tls.ca is undefined NoClientCert

File (TOML)

[providers.marathon.tls]
  caOptional = true

File (YAML)

providers:
  marathon:
    tls:
      caOptional: true

CLI

--providers.marathon.tls.caOptional=true

`tls.cert`¶

Public certificate used for the secured connection to Marathon.

File (TOML)

[providers.marathon.tls]
  cert = "path/to/foo.cert"
  key = "path/to/foo.key"

File (YAML)

providers:
  marathon:
    tls:
      cert: path/to/foo.cert
      key: path/to/foo.key

CLI

--providers.marathon.tls.cert=path/to/foo.cert
--providers.marathon.tls.key=path/to/foo.key

`tls.key`¶

Private certificate used for the secured connection to Marathon.

File (TOML)

[providers.marathon.tls]
  cert = "path/to/foo.cert"
  key = "path/to/foo.key"

File (YAML)

providers:
  marathon:
    tls:
      cert: path/to/foo.cert
      key: path/to/foo.key

CLI

--providers.marathon.tls.cert=path/to/foo.cert
--providers.marathon.tls.key=path/to/foo.key

`tls.insecureSkipVerify`¶

If insecureSkipVerify is true, TLS for the connection to Marathon accepts any certificate presented by the server and any host name in that certificate.

File (TOML)

[providers.marathon.tls]
  insecureSkipVerify = true

File (YAML)

providers:
  marathon:
    tls:
      insecureSkipVerify: true

CLI

--providers.marathon.tls.insecureSkipVerify=true

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

Traefik & Marathon¶

Configuration Examples¶

Routing Configuration¶

Provider Configuration¶

basic¶

dcosToken¶

defaultRule¶

dialerTimeout¶

endpoint¶

exposedByDefault¶

constraints¶

forceTaskHostname¶

keepAlive¶

respectReadinessChecks¶

responseHeaderTimeout¶

tls¶

tls.ca¶

tls.caOptional¶

tls.cert¶

tls.key¶

tls.insecureSkipVerify¶

tlsHandshakeTimeout¶

trace¶

watch¶

`basic`¶

`dcosToken`¶

`defaultRule`¶

`dialerTimeout`¶

`endpoint`¶

`exposedByDefault`¶

`constraints`¶

`forceTaskHostname`¶

`keepAlive`¶

`respectReadinessChecks`¶

`responseHeaderTimeout`¶

`tls`¶

`tls.ca`¶

`tls.caOptional`¶

`tls.cert`¶

`tls.key`¶

`tls.insecureSkipVerify`¶

`tlsHandshakeTimeout`¶

`trace`¶

`watch`¶