traefik/docs/content/providers/consul.md

Traefik & Consul

A Story of KV store & Containers {: .subtitle }

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 to Consul.

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

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

--providers.consul.endpoints=127.0.0.1:8500

rootKey

Required, Default="traefik"

Defines the root key of the configuration.

providers:
  consul:
    rootKey: "traefik"

[providers.consul]
  rootKey = "traefik"

--providers.consul.rootkey=traefik

username

Optional, Default=""

Defines a username to connect to Consul with.

providers:
  consul:
    # ...
    usename: "foo"

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

--providers.consul.username=foo

password

Optional, Default=""

Defines a password with which to connect to Consul.

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

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

--providers.consul.password=foo

tls

Optional

tls.ca

Certificate Authority used for the secure connection to Consul.

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

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

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

tls.caOptional

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

!!! warning ""

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

providers:
  consul:
    tls:
      caOptional: true

[providers.consul.tls]
  caOptional = true

--providers.consul.tls.caOptional=true

tls.cert

Public certificate used for the secure connection to Consul.

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

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

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

tls.key

Private certificate used for the secure connection to Consul.

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

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

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

tls.insecureSkipVerify

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

providers:
  consul:
    tls:
      insecureSkipVerify: true

[providers.consul.tls]
  insecureSkipVerify = true

--providers.consul.tls.insecureSkipVerify=true