Traefik & Consul

A Story of KV store & Containers

Store your configuration in Consul and let Traefik do the rest!

Routing Configuration

See the dedicated section in routing.

Provider Configuration

endpoints

Required, Default=”127.0.0.1:8500”

Defines how to access Consul.

File (YAML)

providers:
  consul:
    endpoints:
      - "127.0.0.1:8500"

File (TOML)

[providers.consul]
  endpoints = ["127.0.0.1:8500"]

CLI

--providers.consul.endpoints=127.0.0.1:8500

rootKey

Required, Default=”traefik”

Defines the root key of the configuration.

File (YAML)

providers:
  consul:
    rootKey: "traefik"

File (TOML)

[providers.consul]
  rootKey = "traefik"

CLI

--providers.consul.rootkey=traefik

namespace

Optional, Default=””

The namespace option defines the namespace to query.

Warning

The namespace option only works with Consul Enterprise, which provides the Namespaces feature.

File (YAML)

providers:
  consul:
    # ...
    namespace: "production"

File (TOML)

[providers.consul]
  # ...
  namespace = "production"

CLI

--providers.consul.namespace=production

username

Optional, Default=””

Defines a username to connect to Consul with.

File (YAML)

providers:
  consul:
    # ...
    username: "foo"

File (TOML)

[providers.consul]
  # ...
  username = "foo"

CLI

--providers.consul.username=foo

password

Optional, Default=””

Defines a password with which to connect to Consul.

File (YAML)

providers:
  consul:
    # ...
    password: "bar"

File (TOML)

[providers.consul]
  # ...
  password = "bar"

CLI

--providers.consul.password=bar

token

Optional, Default=””

Defines a token with which to connect to Consul.

File (YAML)

providers:
  consul:
    # ...
    token: "bar"

File (TOML)

[providers.consul]
  # ...
  token = "bar"

CLI

--providers.consul.token=bar

tls

Optional

Defines the TLS configuration used for the secure connection to Consul.

ca

Optional

ca is the path to the certificate authority used for the secure connection to Consul, it defaults to the system bundle.

File (YAML)

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

File (TOML)

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

CLI

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

caOptional

Optional

The value of caOptional defines which policy should be used for the secure connection with TLS Client Authentication to Consul.

If ca is undefined, this option will be ignored, and no client certificate will be requested during the handshake. Any provided certificate will thus never be verified.

When this option is set to true, a client certificate is requested during the handshake but is not required. If a certificate is sent, it is required to be valid.

When this option is set to false, a client certificate is requested during the handshake, and at least one valid certificate should be sent by the client.

File (YAML)

providers:
  consul:
    tls:
      caOptional: true

File (TOML)

[providers.consul.tls]
  caOptional = true

CLI

--providers.consul.tls.caOptional=true

cert

Optional

cert is the path to the public certificate used for the secure connection to Consul. When using this option, setting the key option is required.

File (YAML)

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

File (TOML)

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

CLI

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

key

Optional

key is the path to the private key used for the secure connection to Consul. When using this option, setting the cert option is required.

File (YAML)

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

File (TOML)

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

CLI

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

insecureSkipVerify

Optional, Default=false

If insecureSkipVerify is true, the TLS connection to Consul accepts any certificate presented by the server regardless of the hostnames it covers.

File (YAML)

providers:
  consul:
    tls:
      insecureSkipVerify: true

File (TOML)

[providers.consul.tls]
  insecureSkipVerify = true

CLI

--providers.consul.tls.insecureSkipVerify=true