1842 lines
52 KiB
Markdown
1842 lines
52 KiB
Markdown
|
||
# Global configuration
|
||
|
||
## Main section
|
||
|
||
```toml
|
||
# traefik.toml
|
||
################################################################
|
||
# Global configuration
|
||
################################################################
|
||
|
||
# Duration to give active requests a chance to finish during hot-reloads.
|
||
# Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw
|
||
# values (digits). If no units are provided, the value is parsed assuming
|
||
# seconds.
|
||
#
|
||
# Optional
|
||
# Default: "10s"
|
||
#
|
||
# graceTimeOut = "10s"
|
||
|
||
# Enable debug mode
|
||
#
|
||
# Optional
|
||
# Default: false
|
||
#
|
||
# debug = true
|
||
|
||
# Periodically check if a new version has been released
|
||
#
|
||
# Optional
|
||
# Default: true
|
||
#
|
||
# checkNewVersion = false
|
||
|
||
# Traefik logs file
|
||
# If not defined, logs to stdout
|
||
#
|
||
# Optional
|
||
#
|
||
# traefikLogsFile = "log/traefik.log"
|
||
|
||
# Access logs file
|
||
#
|
||
# Deprecated - see [accessLog] lower down
|
||
# Optional
|
||
#
|
||
# accessLogsFile = "log/access.log"
|
||
|
||
# Log level
|
||
#
|
||
# Optional
|
||
# Default: "ERROR"
|
||
# Accepted values, in order of severity: "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "PANIC"
|
||
# Messages at and above the selected level will be logged.
|
||
#
|
||
# logLevel = "ERROR"
|
||
|
||
# Backends throttle duration: minimum duration in seconds between 2 events from providers
|
||
# before applying a new configuration. It avoids unnecessary reloads if multiples events
|
||
# are sent in a short amount of time.
|
||
# Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw
|
||
# values (digits). If no units are provided, the value is parsed assuming
|
||
# seconds.
|
||
#
|
||
# Optional
|
||
# Default: "2s"
|
||
#
|
||
# ProvidersThrottleDuration = "2s"
|
||
|
||
# IdleTimeout: maximum amount of time an idle (keep-alive) connection will remain idle before closing itself.
|
||
# This is set to enforce closing of stale client connections.
|
||
# Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw
|
||
# values (digits). If no units are provided, the value is parsed assuming seconds.
|
||
#
|
||
# Optional
|
||
# Default: "180s"
|
||
#
|
||
# IdleTimeout = "360s"
|
||
|
||
# Controls the maximum idle (keep-alive) connections to keep per-host. If zero, DefaultMaxIdleConnsPerHost
|
||
# from the Go standard library net/http module is used.
|
||
# If you encounter 'too many open files' errors, you can either increase this
|
||
# value or change the `ulimit`.
|
||
#
|
||
# Optional
|
||
# Default: 200
|
||
#
|
||
# MaxIdleConnsPerHost = 200
|
||
|
||
# If set to true invalid SSL certificates are accepted for backends.
|
||
# Note: This disables detection of man-in-the-middle attacks so should only be used on secure backend networks.
|
||
# Optional
|
||
# Default: false
|
||
#
|
||
# InsecureSkipVerify = true
|
||
|
||
# Register Certificates in the RootCA. This certificates will be use for backends calls.
|
||
# Note: You can use file path or cert content directly
|
||
# Optional
|
||
# Default: []
|
||
#
|
||
# RootCAs = [ "/mycert.cert" ]
|
||
|
||
# Entrypoints to be used by frontends that do not specify any entrypoint.
|
||
# Each frontend can specify its own entrypoints.
|
||
#
|
||
# Optional
|
||
# Default: ["http"]
|
||
#
|
||
# defaultEntryPoints = ["http", "https"]
|
||
```
|
||
|
||
### Constraints
|
||
|
||
In a micro-service architecture, with a central service discovery, setting constraints limits Træfik scope to a smaller number of routes.
|
||
|
||
Træfik filters services according to service attributes/tags set in your configuration backends.
|
||
|
||
Supported backends:
|
||
|
||
- Docker
|
||
- Consul K/V
|
||
- BoltDB
|
||
- Zookeeper
|
||
- Etcd
|
||
- Consul Catalog
|
||
- Rancher
|
||
|
||
Supported filters:
|
||
|
||
- `tag`
|
||
|
||
```toml
|
||
# Constraints definition
|
||
#
|
||
# Optional
|
||
#
|
||
# Simple matching constraint
|
||
# constraints = ["tag==api"]
|
||
#
|
||
# Simple mismatching constraint
|
||
# constraints = ["tag!=api"]
|
||
#
|
||
# Globbing
|
||
# constraints = ["tag==us-*"]
|
||
#
|
||
# Backend-specific constraint
|
||
# [consulCatalog]
|
||
# endpoint = 127.0.0.1:8500
|
||
# constraints = ["tag==api"]
|
||
#
|
||
# Multiple constraints
|
||
# - "tag==" must match with at least one tag
|
||
# - "tag!=" must match with none of tags
|
||
# constraints = ["tag!=us-*", "tag!=asia-*"]
|
||
# [consulCatalog]
|
||
# endpoint = 127.0.0.1:8500
|
||
# constraints = ["tag==api", "tag!=v*-beta"]
|
||
```
|
||
|
||
## Access log definition
|
||
|
||
Access logs are written when `[accessLog]` is defined.
|
||
By default it will write to stdout and produce logs in the textual Common Log Format (CLF), extended with additional fields.
|
||
|
||
To enable access logs using the default settings just add the `[accessLog]` entry.
|
||
```toml
|
||
[accessLog]
|
||
```
|
||
|
||
To write the logs into a logfile specify the `filePath`.
|
||
```toml
|
||
[accessLog]
|
||
filePath = "/path/to/access.log"
|
||
```
|
||
|
||
To write JSON format logs, specify `json` as the format:
|
||
```toml
|
||
[accessLog]
|
||
filePath = "/path/to/access.log"
|
||
format = "json"
|
||
```
|
||
|
||
## Entrypoints definition
|
||
|
||
```toml
|
||
# Entrypoints definition
|
||
#
|
||
# Optional
|
||
# Default:
|
||
# [entryPoints]
|
||
# [entryPoints.http]
|
||
# address = ":80"
|
||
#
|
||
# To redirect an http entrypoint to an https entrypoint (with SNI support):
|
||
# [entryPoints]
|
||
# [entryPoints.http]
|
||
# address = ":80"
|
||
# [entryPoints.http.redirect]
|
||
# entryPoint = "https"
|
||
# [entryPoints.https]
|
||
# address = ":443"
|
||
# [entryPoints.https.tls]
|
||
# [[entryPoints.https.tls.certificates]]
|
||
# CertFile = "integration/fixtures/https/snitest.com.cert"
|
||
# KeyFile = "integration/fixtures/https/snitest.com.key"
|
||
# [[entryPoints.https.tls.certificates]]
|
||
# CertFile = "integration/fixtures/https/snitest.org.cert"
|
||
# KeyFile = "integration/fixtures/https/snitest.org.key"
|
||
#
|
||
# To redirect an entrypoint rewriting the URL:
|
||
# [entryPoints]
|
||
# [entryPoints.http]
|
||
# address = ":80"
|
||
# [entryPoints.http.redirect]
|
||
# regex = "^http://localhost/(.*)"
|
||
# replacement = "http://mydomain/$1"
|
||
#
|
||
# Only accept clients that present a certificate signed by a specified
|
||
# Certificate Authority (CA)
|
||
# ClientCAFiles can be configured with multiple CA:s in the same file or
|
||
# use multiple files containing one or several CA:s. The CA:s has to be in PEM format.
|
||
# All clients will be required to present a valid cert.
|
||
# The requirement will apply to all server certs in the entrypoint
|
||
# In the example below both snitest.com and snitest.org will require client certs
|
||
#
|
||
# [entryPoints]
|
||
# [entryPoints.https]
|
||
# address = ":443"
|
||
# [entryPoints.https.tls]
|
||
# ClientCAFiles = ["tests/clientca1.crt", "tests/clientca2.crt"]
|
||
# [[entryPoints.https.tls.certificates]]
|
||
# CertFile = "integration/fixtures/https/snitest.com.cert"
|
||
# KeyFile = "integration/fixtures/https/snitest.com.key"
|
||
# [[entryPoints.https.tls.certificates]]
|
||
# CertFile = "integration/fixtures/https/snitest.org.cert"
|
||
# KeyFile = "integration/fixtures/https/snitest.org.key"
|
||
#
|
||
# To enable basic auth on an entrypoint
|
||
# with 2 user/pass: test:test and test2:test2
|
||
# Passwords can be encoded in MD5, SHA1 and BCrypt: you can use htpasswd to generate those ones
|
||
# Users can be specified directly in the toml file, or indirectly by referencing an external file; if both are provided, the two are merged, with external file contents having precedence
|
||
# [entryPoints]
|
||
# [entryPoints.http]
|
||
# address = ":80"
|
||
# [entryPoints.http.auth.basic]
|
||
# users = ["test:$apr1$H6uskkkW$IgXLP6ewTrSuBkTrqE8wj/", "test2:$apr1$d9hr9HBB$4HxwgUir3HP4EsggP/QNo0"]
|
||
# usersFile = "/path/to/.htpasswd"
|
||
#
|
||
# To enable digest auth on an entrypoint
|
||
# with 2 user/realm/pass: test:traefik:test and test2:traefik:test2
|
||
# You can use htdigest to generate those ones
|
||
# Users can be specified directly in the toml file, or indirectly by referencing an external file; if both are provided, the two are merged, with external file contents having precedence
|
||
# [entryPoints]
|
||
# [entryPoints.http]
|
||
# address = ":80"
|
||
# [entryPoints.http.auth.basic]
|
||
# users = ["test:traefik:a2688e031edb4be6a3797f3882655c05 ", "test2:traefik:518845800f9e2bfb1f1f740ec24f074e"]
|
||
# usersFile = "/path/to/.htdigest"
|
||
#
|
||
# To specify an https entrypoint with a minimum TLS version, and specifying an array of cipher suites (from crypto/tls):
|
||
# [entryPoints]
|
||
# [entryPoints.https]
|
||
# address = ":443"
|
||
# [entryPoints.https.tls]
|
||
# MinVersion = "VersionTLS12"
|
||
# CipherSuites = ["TLS_RSA_WITH_AES_256_GCM_SHA384"]
|
||
# [[entryPoints.https.tls.certificates]]
|
||
# CertFile = "integration/fixtures/https/snitest.com.cert"
|
||
# KeyFile = "integration/fixtures/https/snitest.com.key"
|
||
# [[entryPoints.https.tls.certificates]]
|
||
# CertFile = "integration/fixtures/https/snitest.org.cert"
|
||
# KeyFile = "integration/fixtures/https/snitest.org.key"
|
||
|
||
# To enable compression support using gzip format:
|
||
# [entryPoints]
|
||
# [entryPoints.http]
|
||
# address = ":80"
|
||
# compress = true
|
||
|
||
[entryPoints]
|
||
[entryPoints.http]
|
||
address = ":80"
|
||
```
|
||
|
||
## Retry configuration
|
||
|
||
```toml
|
||
# Enable retry sending request if network error
|
||
#
|
||
# Optional
|
||
#
|
||
[retry]
|
||
|
||
# Number of attempts
|
||
#
|
||
# Optional
|
||
# Default: (number servers in backend) -1
|
||
#
|
||
# attempts = 3
|
||
```
|
||
|
||
## Health check configuration
|
||
```toml
|
||
# Enable custom health check options.
|
||
#
|
||
# Optional
|
||
#
|
||
[healthcheck]
|
||
|
||
# Set the default health check interval. Will only be effective if health check
|
||
# paths are defined. Given provider-specific support, the value may be
|
||
# overridden on a per-backend basis.
|
||
# Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw
|
||
# values (digits). If no units are provided, the value is parsed assuming
|
||
# seconds.
|
||
#
|
||
# Optional
|
||
# Default: "30s"
|
||
#
|
||
# interval = "30s"
|
||
```
|
||
|
||
## ACME (Let's Encrypt) configuration
|
||
|
||
```toml
|
||
# Sample entrypoint configuration when using ACME
|
||
[entryPoints]
|
||
[entryPoints.https]
|
||
address = ":443"
|
||
[entryPoints.https.tls]
|
||
|
||
# Enable ACME (Let's Encrypt): automatic SSL
|
||
#
|
||
# Optional
|
||
#
|
||
[acme]
|
||
|
||
# Email address used for registration
|
||
#
|
||
# Required
|
||
#
|
||
email = "test@traefik.io"
|
||
|
||
# File or key used for certificates storage.
|
||
# WARNING, if you use Traefik in Docker, you have 2 options:
|
||
# - create a file on your host and mount it as a volume
|
||
# storageFile = "acme.json"
|
||
# $ docker run -v "/my/host/acme.json:acme.json" traefik
|
||
# - mount the folder containing the file as a volume
|
||
# storageFile = "/etc/traefik/acme/acme.json"
|
||
# $ docker run -v "/my/host/acme:/etc/traefik/acme" traefik
|
||
#
|
||
# Required
|
||
#
|
||
storage = "acme.json" # or "traefik/acme/account" if using KV store
|
||
|
||
# Entrypoint to proxy acme challenge/apply certificates to.
|
||
# WARNING, must point to an entrypoint on port 443
|
||
#
|
||
# Required
|
||
#
|
||
entryPoint = "https"
|
||
|
||
# Use a DNS based acme challenge rather than external HTTPS access, e.g. for a firewalled server
|
||
# Select the provider that matches the DNS domain that will host the challenge TXT record,
|
||
# and provide environment variables with access keys to enable setting it:
|
||
# - cloudflare: CLOUDFLARE_EMAIL, CLOUDFLARE_API_KEY
|
||
# - digitalocean: DO_AUTH_TOKEN
|
||
# - dnsimple: DNSIMPLE_EMAIL, DNSIMPLE_API_KEY
|
||
# - dnsmadeeasy: DNSMADEEASY_API_KEY, DNSMADEEASY_API_SECRET
|
||
# - exoscale: EXOSCALE_API_KEY, EXOSCALE_API_SECRET
|
||
# - gandi: GANDI_API_KEY
|
||
# - linode: LINODE_API_KEY
|
||
# - manual: none, but run traefik interactively & turn on acmeLogging to see instructions & press Enter
|
||
# - namecheap: NAMECHEAP_API_USER, NAMECHEAP_API_KEY
|
||
# - rfc2136: RFC2136_TSIG_KEY, RFC2136_TSIG_SECRET, RFC2136_TSIG_ALGORITHM, RFC2136_NAMESERVER
|
||
# - route53: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, or configured user/instance IAM profile
|
||
# - dyn: DYN_CUSTOMER_NAME, DYN_USER_NAME, DYN_PASSWORD
|
||
# - vultr: VULTR_API_KEY
|
||
# - ovh: OVH_ENDPOINT, OVH_APPLICATION_KEY, OVH_APPLICATION_SECRET, OVH_CONSUMER_KEY
|
||
# - pdns: PDNS_API_KEY, PDNS_API_URL
|
||
#
|
||
# Optional
|
||
#
|
||
# dnsProvider = "digitalocean"
|
||
|
||
# By default, the dnsProvider will verify the TXT DNS challenge record before letting ACME verify
|
||
# If delayDontCheckDNS is greater than zero, avoid this & instead just wait so many seconds.
|
||
# Useful if internal networks block external DNS queries
|
||
#
|
||
# Optional
|
||
#
|
||
# delayDontCheckDNS = 0
|
||
|
||
# If true, display debug log messages from the acme client library
|
||
#
|
||
# Optional
|
||
#
|
||
# acmeLogging = true
|
||
|
||
# Enable on demand certificate. This will request a certificate from Let's Encrypt during the first TLS handshake for a hostname that does not yet have a certificate.
|
||
# WARNING, TLS handshakes will be slow when requesting a hostname certificate for the first time, this can leads to DoS attacks.
|
||
# WARNING, Take note that Let's Encrypt have rate limiting: https://letsencrypt.org/docs/rate-limits
|
||
#
|
||
# Optional
|
||
#
|
||
# onDemand = true
|
||
|
||
# Enable certificate generation on frontends Host rules. This will request a certificate from Let's Encrypt for each frontend with a Host rule.
|
||
# For example, a rule Host:test1.traefik.io,test2.traefik.io will request a certificate with main domain test1.traefik.io and SAN test2.traefik.io.
|
||
#
|
||
# Optional
|
||
#
|
||
# OnHostRule = true
|
||
|
||
# CA server to use
|
||
# Uncomment the line to run on the staging let's encrypt server
|
||
# Leave comment to go to prod
|
||
#
|
||
# Optional
|
||
#
|
||
# caServer = "https://acme-staging.api.letsencrypt.org/directory"
|
||
|
||
# Domains list
|
||
# You can provide SANs (alternative domains) to each main domain
|
||
# All domains must have A/AAAA records pointing to Traefik
|
||
# WARNING, Take note that Let's Encrypt have rate limiting: https://letsencrypt.org/docs/rate-limits
|
||
# Each domain & SANs will lead to a certificate request.
|
||
#
|
||
# [[acme.domains]]
|
||
# main = "local1.com"
|
||
# sans = ["test1.local1.com", "test2.local1.com"]
|
||
# [[acme.domains]]
|
||
# main = "local2.com"
|
||
# sans = ["test1.local2.com", "test2x.local2.com"]
|
||
# [[acme.domains]]
|
||
# main = "local3.com"
|
||
# [[acme.domains]]
|
||
# main = "local4.com"
|
||
[[acme.domains]]
|
||
main = "local1.com"
|
||
sans = ["test1.local1.com", "test2.local1.com"]
|
||
[[acme.domains]]
|
||
main = "local3.com"
|
||
[[acme.domains]]
|
||
main = "local4.com"
|
||
```
|
||
|
||
# Configuration backends
|
||
|
||
## File backend
|
||
|
||
Like any other reverse proxy, Træfik can be configured with a file. You have three choices:
|
||
|
||
- simply add your configuration at the end of the global configuration file `traefik.toml`:
|
||
|
||
```toml
|
||
# traefik.toml
|
||
logLevel = "DEBUG"
|
||
defaultEntryPoints = ["http", "https"]
|
||
[entryPoints]
|
||
[entryPoints.http]
|
||
address = ":80"
|
||
[entryPoints.http.redirect]
|
||
entryPoint = "https"
|
||
[entryPoints.https]
|
||
address = ":443"
|
||
[entryPoints.https.tls]
|
||
[[entryPoints.https.tls.certificates]]
|
||
CertFile = "integration/fixtures/https/snitest.com.cert"
|
||
KeyFile = "integration/fixtures/https/snitest.com.key"
|
||
[[entryPoints.https.tls.certificates]]
|
||
CertFile = "integration/fixtures/https/snitest.org.cert"
|
||
KeyFile = "integration/fixtures/https/snitest.org.key"
|
||
|
||
[file]
|
||
|
||
# rules
|
||
[backends]
|
||
[backends.backend1]
|
||
[backends.backend1.circuitbreaker]
|
||
expression = "NetworkErrorRatio() > 0.5"
|
||
[backends.backend1.servers.server1]
|
||
url = "http://172.17.0.2:80"
|
||
weight = 10
|
||
[backends.backend1.servers.server2]
|
||
url = "http://172.17.0.3:80"
|
||
weight = 1
|
||
[backends.backend2]
|
||
[backends.backend2.maxconn]
|
||
amount = 10
|
||
extractorfunc = "request.host"
|
||
[backends.backend2.LoadBalancer]
|
||
method = "drr"
|
||
[backends.backend2.servers.server1]
|
||
url = "http://172.17.0.4:80"
|
||
weight = 1
|
||
[backends.backend2.servers.server2]
|
||
url = "http://172.17.0.5:80"
|
||
weight = 2
|
||
|
||
[frontends]
|
||
[frontends.frontend1]
|
||
backend = "backend2"
|
||
[frontends.frontend1.routes.test_1]
|
||
rule = "Host:test.localhost"
|
||
[frontends.frontend2]
|
||
backend = "backend1"
|
||
passHostHeader = true
|
||
priority = 10
|
||
|
||
# restrict access to this frontend to the specified list of IPv4/IPv6 CIDR Nets
|
||
# an unset or empty list allows all Source-IPs to access
|
||
# if one of the Net-Specifications are invalid, the whole list is invalid
|
||
# and allows all Source-IPs to access.
|
||
whitelistSourceRange = ["10.42.0.0/16", "152.89.1.33/32", "afed:be44::/16"]
|
||
|
||
entrypoints = ["https"] # overrides defaultEntryPoints
|
||
[frontends.frontend2.routes.test_1]
|
||
rule = "Host:{subdomain:[a-z]+}.localhost"
|
||
[frontends.frontend3]
|
||
entrypoints = ["http", "https"] # overrides defaultEntryPoints
|
||
backend = "backend2"
|
||
rule = "Path:/test"
|
||
```
|
||
|
||
- or put your rules in a separate file, for example `rules.toml`:
|
||
|
||
```toml
|
||
# traefik.toml
|
||
logLevel = "DEBUG"
|
||
[entryPoints]
|
||
[entryPoints.http]
|
||
address = ":80"
|
||
[entryPoints.http.redirect]
|
||
entryPoint = "https"
|
||
[entryPoints.https]
|
||
address = ":443"
|
||
[entryPoints.https.tls]
|
||
[[entryPoints.https.tls.certificates]]
|
||
CertFile = "integration/fixtures/https/snitest.com.cert"
|
||
KeyFile = "integration/fixtures/https/snitest.com.key"
|
||
[[entryPoints.https.tls.certificates]]
|
||
CertFile = "integration/fixtures/https/snitest.org.cert"
|
||
KeyFile = "integration/fixtures/https/snitest.org.key"
|
||
|
||
[file]
|
||
filename = "rules.toml"
|
||
```
|
||
|
||
```toml
|
||
# rules.toml
|
||
[backends]
|
||
[backends.backend1]
|
||
[backends.backend1.circuitbreaker]
|
||
expression = "NetworkErrorRatio() > 0.5"
|
||
[backends.backend1.servers.server1]
|
||
url = "http://172.17.0.2:80"
|
||
weight = 10
|
||
[backends.backend1.servers.server2]
|
||
url = "http://172.17.0.3:80"
|
||
weight = 1
|
||
[backends.backend2]
|
||
[backends.backend2.maxconn]
|
||
amount = 10
|
||
extractorfunc = "request.host"
|
||
[backends.backend2.LoadBalancer]
|
||
method = "drr"
|
||
[backends.backend2.servers.server1]
|
||
url = "http://172.17.0.4:80"
|
||
weight = 1
|
||
[backends.backend2.servers.server2]
|
||
url = "http://172.17.0.5:80"
|
||
weight = 2
|
||
|
||
[frontends]
|
||
[frontends.frontend1]
|
||
backend = "backend2"
|
||
[frontends.frontend1.routes.test_1]
|
||
rule = "Host:test.localhost"
|
||
[frontends.frontend2]
|
||
backend = "backend1"
|
||
passHostHeader = true
|
||
priority = 10
|
||
entrypoints = ["https"] # overrides defaultEntryPoints
|
||
[frontends.frontend2.routes.test_1]
|
||
rule = "Host:{subdomain:[a-z]+}.localhost"
|
||
[frontends.frontend3]
|
||
entrypoints = ["http", "https"] # overrides defaultEntryPoints
|
||
backend = "backend2"
|
||
rule = "Path:/test"
|
||
```
|
||
|
||
- or you could have multiple .toml files in a directory:
|
||
|
||
```toml
|
||
[file]
|
||
directory = "/path/to/config/"
|
||
```
|
||
|
||
If you want Træfik to watch file changes automatically, just add:
|
||
|
||
```toml
|
||
[file]
|
||
watch = true
|
||
```
|
||
|
||
## API backend
|
||
|
||
Træfik can be configured using a RESTful api.
|
||
To enable it:
|
||
|
||
```toml
|
||
[web]
|
||
address = ":8080"
|
||
|
||
# Set the root path for webui and API
|
||
#
|
||
# Optional
|
||
#
|
||
# path = "/mypath"
|
||
#
|
||
# SSL certificate and key used
|
||
#
|
||
# Optional
|
||
#
|
||
# CertFile = "traefik.crt"
|
||
# KeyFile = "traefik.key"
|
||
#
|
||
# Set REST API to read-only mode
|
||
#
|
||
# Optional
|
||
# ReadOnly = false
|
||
#
|
||
# To enable more detailed statistics
|
||
# [web.statistics]
|
||
# RecentErrors = 10
|
||
#
|
||
# To enable Traefik to export internal metrics to Prometheus
|
||
# [web.metrics.prometheus]
|
||
# Buckets=[0.1,0.3,1.2,5.0]
|
||
#
|
||
# To enable basic auth on the webui
|
||
# with 2 user/pass: test:test and test2:test2
|
||
# Passwords can be encoded in MD5, SHA1 and BCrypt: you can use htpasswd to generate those ones
|
||
# Users can be specified directly in the toml file, or indirectly by referencing an external file; if both are provided, the two are merged, with external file contents having precedence
|
||
# [web.auth.basic]
|
||
# users = ["test:$apr1$H6uskkkW$IgXLP6ewTrSuBkTrqE8wj/", "test2:$apr1$d9hr9HBB$4HxwgUir3HP4EsggP/QNo0"]
|
||
# usersFile = "/path/to/.htpasswd"
|
||
# To enable digest auth on the webui
|
||
# with 2 user/realm/pass: test:traefik:test and test2:traefik:test2
|
||
# You can use htdigest to generate those ones
|
||
# Users can be specified directly in the toml file, or indirectly by referencing an external file; if both are provided, the two are merged, with external file contents having precedence
|
||
# [web.auth.digest]
|
||
# users = ["test:traefik:a2688e031edb4be6a3797f3882655c05 ", "test2:traefik:518845800f9e2bfb1f1f740ec24f074e"]
|
||
# usersFile = "/path/to/.htdigest"
|
||
```
|
||
|
||
- `/`: provides a simple HTML frontend of Træfik
|
||
|
||
|
||
|
||
|
||
- `/ping`: A simple endpoint to check for Træfik process liveness. Supports HTTP `GET` and `HEAD` requests.
|
||
|
||
```shell
|
||
$ curl -sv "http://localhost:8080/ping"
|
||
* Trying ::1...
|
||
* Connected to localhost (::1) port 8080 (#0)
|
||
> GET /ping HTTP/1.1
|
||
> Host: localhost:8080
|
||
> User-Agent: curl/7.43.0
|
||
> Accept: */*
|
||
>
|
||
< HTTP/1.1 200 OK
|
||
< Date: Thu, 25 Aug 2016 01:35:36 GMT
|
||
< Content-Length: 2
|
||
< Content-Type: text/plain; charset=utf-8
|
||
<
|
||
* Connection #0 to host localhost left intact
|
||
OK
|
||
```
|
||
|
||
- `/health`: `GET` json metrics
|
||
|
||
```shell
|
||
$ curl -s "http://localhost:8080/health" | jq .
|
||
{
|
||
// Træfik PID
|
||
"pid": 2458,
|
||
// Træfik server uptime (formated time)
|
||
"uptime": "39m6.885931127s",
|
||
// Træfik server uptime in seconds
|
||
"uptime_sec": 2346.885931127,
|
||
// current server date
|
||
"time": "2015-10-07 18:32:24.362238909 +0200 CEST",
|
||
// current server date in seconds
|
||
"unixtime": 1444235544,
|
||
// count HTTP response status code in realtime
|
||
"status_code_count": {
|
||
"502": 1
|
||
},
|
||
// count HTTP response status code since Træfik started
|
||
"total_status_code_count": {
|
||
"200": 7,
|
||
"404": 21,
|
||
"502": 13
|
||
},
|
||
// count HTTP response
|
||
"count": 1,
|
||
// count HTTP response
|
||
"total_count": 41,
|
||
// sum of all response time (formated time)
|
||
"total_response_time": "35.456865605s",
|
||
// sum of all response time in seconds
|
||
"total_response_time_sec": 35.456865605,
|
||
// average response time (formated time)
|
||
"average_response_time": "864.8016ms",
|
||
// average response time in seconds
|
||
"average_response_time_sec": 0.8648016000000001,
|
||
|
||
// request statistics [requires --web.statistics to be set]
|
||
// ten most recent requests with 4xx and 5xx status codes
|
||
"recent_errors": [
|
||
{
|
||
// status code
|
||
"status_code": 500,
|
||
// description of status code
|
||
"status": "Internal Server Error",
|
||
// request HTTP method
|
||
"method": "GET",
|
||
// request hostname
|
||
"host": "localhost",
|
||
// request path
|
||
"path": "/path",
|
||
// RFC 3339 formatted date/time
|
||
"time": "2016-10-21T16:59:15.418495872-07:00"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
- `/api`: `GET` configuration for all providers
|
||
|
||
```shell
|
||
$ curl -s "http://localhost:8080/api" | jq .
|
||
{
|
||
"file": {
|
||
"frontends": {
|
||
"frontend2": {
|
||
"routes": {
|
||
"test_2": {
|
||
"rule": "Path:/test"
|
||
}
|
||
},
|
||
"backend": "backend1"
|
||
},
|
||
"frontend1": {
|
||
"routes": {
|
||
"test_1": {
|
||
"rule": "Host:test.localhost"
|
||
}
|
||
},
|
||
"backend": "backend2"
|
||
}
|
||
},
|
||
"backends": {
|
||
"backend2": {
|
||
"loadBalancer": {
|
||
"method": "drr"
|
||
},
|
||
"servers": {
|
||
"server2": {
|
||
"weight": 2,
|
||
"URL": "http://172.17.0.5:80"
|
||
},
|
||
"server1": {
|
||
"weight": 1,
|
||
"url": "http://172.17.0.4:80"
|
||
}
|
||
}
|
||
},
|
||
"backend1": {
|
||
"loadBalancer": {
|
||
"method": "wrr"
|
||
},
|
||
"circuitBreaker": {
|
||
"expression": "NetworkErrorRatio() > 0.5"
|
||
},
|
||
"servers": {
|
||
"server2": {
|
||
"weight": 1,
|
||
"url": "http://172.17.0.3:80"
|
||
},
|
||
"server1": {
|
||
"weight": 10,
|
||
"url": "http://172.17.0.2:80"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
- `/api/providers`: `GET` providers
|
||
- `/api/providers/{provider}`: `GET` or `PUT` provider
|
||
- `/api/providers/{provider}/backends`: `GET` backends
|
||
- `/api/providers/{provider}/backends/{backend}`: `GET` a backend
|
||
- `/api/providers/{provider}/backends/{backend}/servers`: `GET` servers in a backend
|
||
- `/api/providers/{provider}/backends/{backend}/servers/{server}`: `GET` a server in a backend
|
||
- `/api/providers/{provider}/frontends`: `GET` frontends
|
||
- `/api/providers/{provider}/frontends/{frontend}`: `GET` a frontend
|
||
- `/api/providers/{provider}/frontends/{frontend}/routes`: `GET` routes in a frontend
|
||
- `/api/providers/{provider}/frontends/{frontend}/routes/{route}`: `GET` a route in a frontend
|
||
|
||
- `/metrics`: You can enable Traefik to export internal metrics to different monitoring systems (Only Prometheus is supported at the moment).
|
||
|
||
```bash
|
||
$ traefik --web.metrics.prometheus --web.metrics.prometheus.buckets="0.1,0.3,1.2,5.0"
|
||
```
|
||
|
||
## Docker backend
|
||
|
||
Træfik can be configured to use Docker as a backend configuration:
|
||
|
||
```toml
|
||
################################################################
|
||
# Docker configuration backend
|
||
################################################################
|
||
|
||
# Enable Docker configuration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[docker]
|
||
|
||
# Docker server endpoint. Can be a tcp or a unix socket endpoint.
|
||
#
|
||
# Required
|
||
#
|
||
endpoint = "unix:///var/run/docker.sock"
|
||
|
||
# Default domain used.
|
||
# Can be overridden by setting the "traefik.domain" label on a container.
|
||
#
|
||
# Required
|
||
#
|
||
domain = "docker.localhost"
|
||
|
||
# Enable watch docker changes
|
||
#
|
||
# Optional
|
||
#
|
||
watch = true
|
||
|
||
# Override default configuration template. For advanced users :)
|
||
#
|
||
# Optional
|
||
#
|
||
# filename = "docker.tmpl"
|
||
|
||
# Expose containers by default in traefik
|
||
# If set to false, containers that don't have `traefik.enable=true` will be ignored
|
||
#
|
||
# Optional
|
||
# Default: true
|
||
#
|
||
exposedbydefault = true
|
||
|
||
# Use the IP address from the binded port instead of the inner network one. For specific use-case :)
|
||
|
||
#
|
||
# Optional
|
||
# Default: false
|
||
#
|
||
usebindportip = true
|
||
# Use Swarm Mode services as data provider
|
||
#
|
||
# Optional
|
||
# Default: false
|
||
#
|
||
swarmmode = false
|
||
|
||
|
||
# Enable docker TLS connection
|
||
#
|
||
# [docker.tls]
|
||
# ca = "/etc/ssl/ca.crt"
|
||
# cert = "/etc/ssl/docker.crt"
|
||
# key = "/etc/ssl/docker.key"
|
||
# insecureskipverify = true
|
||
```
|
||
|
||
Labels can be used on containers to override default behaviour:
|
||
|
||
- `traefik.backend=foo`: give the name `foo` to the generated backend for this container.
|
||
- `traefik.backend.maxconn.amount=10`: set a maximum number of connections to the backend. Must be used in conjunction with the below label to take effect.
|
||
- `traefik.backend.maxconn.extractorfunc=client.ip`: set the function to be used against the request to determine what to limit maximum connections to the backend by. Must be used in conjunction with the above label to take effect.
|
||
- `traefik.backend.loadbalancer.method=drr`: override the default `wrr` load balancer algorithm
|
||
- `traefik.backend.loadbalancer.sticky=true`: enable backend sticky sessions
|
||
- `traefik.backend.loadbalancer.swarm=true `: use Swarm's inbuilt load balancer (only relevant under Swarm Mode).
|
||
- `traefik.backend.circuitbreaker.expression=NetworkErrorRatio() > 0.5`: create a [circuit breaker](/basics/#backends) to be used against the backend
|
||
- `traefik.port=80`: register this port. Useful when the container exposes multiples ports.
|
||
- `traefik.protocol=https`: override the default `http` protocol
|
||
- `traefik.weight=10`: assign this weight to the container
|
||
- `traefik.enable=false`: disable this container in Træfik
|
||
- `traefik.frontend.rule=Host:test.traefik.io`: override the default frontend rule (Default: `Host:{containerName}.{domain}` or `Host:{service}.{project_name}.{domain}` if you are using `docker-compose`).
|
||
- `traefik.frontend.passHostHeader=true`: forward client `Host` header to the backend.
|
||
- `traefik.frontend.priority=10`: override default frontend priority
|
||
- `traefik.frontend.entryPoints=http,https`: assign this frontend to entry points `http` and `https`. Overrides `defaultEntryPoints`.
|
||
- `traefik.frontend.auth.basic=test:$apr1$H6uskkkW$IgXLP6ewTrSuBkTrqE8wj/,test2:$apr1$d9hr9HBB$4HxwgUir3HP4EsggP/QNo0`: Sets basic authentication for that frontend with the usernames and passwords test:test and test2:test2, respectively
|
||
- `traefik.frontend.whitelistSourceRange: "1.2.3.0/24, fe80::/16"`: List of IP-Ranges which are allowed to access. An unset or empty list allows all Source-IPs to access. If one of the Net-Specifications are invalid, the whole list is invalid and allows all Source-IPs to access.
|
||
- `traefik.docker.network`: Set the docker network to use for connections to this container. If a container is linked to several networks, be sure to set the proper network name (you can check with docker inspect <container_id>) otherwise it will randomly pick one (depending on how docker is returning them). For instance when deploying docker `stack` from compose files, the compose defined networks will be prefixed with the `stack` name.
|
||
|
||
If several ports need to be exposed from a container, the services labels can be used
|
||
- `traefik.<service-name>.port=443`: create a service binding with frontend/backend using this port. Overrides `traefik.port`.
|
||
- `traefik.<service-name>.protocol=https`: assign `https` protocol. Overrides `traefik.protocol`.
|
||
- `traefik.<service-name>.weight=10`: assign this service weight. Overrides `traefik.weight`.
|
||
- `traefik.<service-name>.frontend.backend=fooBackend`: assign this service frontend to `foobackend`. Default is to assign to the service backend.
|
||
- `traefik.<service-name>.frontend.entryPoints=http`: assign this service entrypoints. Overrides `traefik.frontend.entrypoints`.
|
||
- `traefik.<service-name>.frontend.auth.basic=test:$apr1$H6uskkkW$IgXLP6ewTrSuBkTrqE8wj/,test2:$apr1$d9hr9HBB$4HxwgUir3HP4EsggP/QNo0` Sets a Basic Auth for that frontend with the users test:test and test2:test2.
|
||
- `traefik.<service-name>.frontend.passHostHeader=true`: Forward client `Host` header to the backend. Overrides `traefik.frontend.passHostHeader`.
|
||
- `traefik.<service-name>.frontend.priority=10`: assign the service frontend priority. Overrides `traefik.frontend.priority`.
|
||
- `traefik.<service-name>.frontend.rule=Path:/foo`: assign the service frontend rule. Overrides `traefik.frontend.rule`.
|
||
|
||
NB: when running inside a container, Træfik will need network access through `docker network connect <network> <traefik-container>`
|
||
|
||
## Marathon backend
|
||
|
||
Træfik can be configured to use Marathon as a backend configuration:
|
||
|
||
|
||
```toml
|
||
################################################################
|
||
# Mesos/Marathon configuration backend
|
||
################################################################
|
||
|
||
# Enable Marathon configuration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[marathon]
|
||
|
||
# Marathon server endpoint.
|
||
# You can also specify multiple endpoint for Marathon:
|
||
# endpoint := "http://10.241.1.71:8080,10.241.1.72:8080,10.241.1.73:8080"
|
||
#
|
||
# Required
|
||
#
|
||
endpoint = "http://127.0.0.1:8080"
|
||
|
||
# Enable watch Marathon changes
|
||
#
|
||
# Optional
|
||
#
|
||
watch = true
|
||
|
||
# Default domain used.
|
||
#
|
||
# Required
|
||
#
|
||
domain = "marathon.localhost"
|
||
|
||
# Override default configuration template. For advanced users :)
|
||
#
|
||
# Optional
|
||
#
|
||
# filename = "marathon.tmpl"
|
||
|
||
# Expose Marathon apps by default in traefik
|
||
#
|
||
# Optional
|
||
# Default: true
|
||
#
|
||
# exposedByDefault = true
|
||
|
||
# Convert Marathon groups to subdomains
|
||
# Default behavior: /foo/bar/myapp => foo-bar-myapp.{defaultDomain}
|
||
# with groupsAsSubDomains enabled: /foo/bar/myapp => myapp.bar.foo.{defaultDomain}
|
||
#
|
||
# Optional
|
||
# Default: false
|
||
#
|
||
# groupsAsSubDomains = true
|
||
|
||
# Enable compatibility with marathon-lb labels
|
||
#
|
||
# Optional
|
||
# Default: false
|
||
#
|
||
# marathonLBCompatibility = true
|
||
|
||
# Enable Marathon basic authentication
|
||
#
|
||
# Optional
|
||
#
|
||
# [marathon.basic]
|
||
# httpBasicAuthUser = "foo"
|
||
# httpBasicPassword = "bar"
|
||
|
||
# TLS client configuration. https://golang.org/pkg/crypto/tls/#Config
|
||
#
|
||
# Optional
|
||
#
|
||
# [marathon.TLS]
|
||
# CA = "/etc/ssl/ca.crt"
|
||
# Cert = "/etc/ssl/marathon.cert"
|
||
# Key = "/etc/ssl/marathon.key"
|
||
# InsecureSkipVerify = true
|
||
|
||
# DCOSToken for DCOS environment, This will override the Authorization header
|
||
#
|
||
# Optional
|
||
#
|
||
# dcosToken = "xxxxxx"
|
||
|
||
# Override DialerTimeout
|
||
# Amount of time to allow the Marathon provider to wait to open a TCP connection
|
||
# to a Marathon master.
|
||
# Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw
|
||
# values (digits). If no units are provided, the value is parsed assuming
|
||
# seconds.
|
||
#
|
||
# Optional
|
||
# Default: "60s"
|
||
# dialerTimeout = "60s"
|
||
|
||
# Set the TCP Keep Alive interval for the Marathon HTTP Client.
|
||
# Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw
|
||
# values (digits). If no units are provided, the value is parsed assuming
|
||
# seconds.
|
||
#
|
||
# Optional
|
||
# Default: "10s"
|
||
#
|
||
# keepAlive = "10s"
|
||
|
||
# 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.
|
||
#
|
||
# Optional
|
||
# Default: false
|
||
#
|
||
# forceTaskHostname: false
|
||
```
|
||
|
||
Labels can be used on containers to override default behaviour:
|
||
|
||
- `traefik.backend=foo`: assign the application to `foo` backend
|
||
- `traefik.backend.maxconn.amount=10`: set a maximum number of connections to the backend. Must be used in conjunction with the below label to take effect.
|
||
- `traefik.backend.maxconn.extractorfunc=client.ip`: set the function to be used against the request to determine what to limit maximum connections to the backend by. Must be used in conjunction with the above label to take effect.
|
||
- `traefik.backend.loadbalancer.method=drr`: override the default `wrr` load balancer algorithm
|
||
- `traefik.backend.loadbalancer.sticky=true`: enable backend sticky sessions
|
||
- `traefik.backend.circuitbreaker.expression=NetworkErrorRatio() > 0.5`: create a [circuit breaker](/basics/#backends) to be used against the backend
|
||
- `traefik.backend.healthcheck.path=/health`: set the Traefik health check path [default: no health checks]
|
||
- `traefik.backend.healthcheck.interval=5s`: sets a custom health check interval in Go-parseable (`time.ParseDuration`) format [default: 30s]
|
||
- `traefik.portIndex=1`: register port by index in the application's ports array. Useful when the application exposes multiple ports.
|
||
- `traefik.port=80`: register the explicit application port value. Cannot be used alongside `traefik.portIndex`.
|
||
- `traefik.protocol=https`: override the default `http` protocol
|
||
- `traefik.weight=10`: assign this weight to the application
|
||
- `traefik.enable=false`: disable this application in Træfik
|
||
- `traefik.frontend.rule=Host:test.traefik.io`: override the default frontend rule (Default: `Host:{containerName}.{domain}`).
|
||
- `traefik.frontend.passHostHeader=true`: forward client `Host` header to the backend.
|
||
- `traefik.frontend.priority=10`: override default frontend priority
|
||
- `traefik.frontend.entryPoints=http,https`: assign this frontend to entry points `http` and `https`. Overrides `defaultEntryPoints`.
|
||
- `traefik.frontend.auth.basic=test:$apr1$H6uskkkW$IgXLP6ewTrSuBkTrqE8wj/,test2:$apr1$d9hr9HBB$4HxwgUir3HP4EsggP/QNo0`: Sets basic authentication for that frontend with the usernames and passwords test:test and test2:test2, respectively
|
||
|
||
|
||
## Mesos generic backend
|
||
|
||
Træfik can be configured to use Mesos as a backend configuration:
|
||
|
||
|
||
```toml
|
||
################################################################
|
||
# Mesos configuration backend
|
||
################################################################
|
||
|
||
# Enable Mesos configuration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[mesos]
|
||
|
||
# Mesos server endpoint.
|
||
# You can also specify multiple endpoint for Mesos:
|
||
# endpoint = "192.168.35.40:5050,192.168.35.41:5050,192.168.35.42:5050"
|
||
# endpoint = "zk://192.168.35.20:2181,192.168.35.21:2181,192.168.35.22:2181/mesos"
|
||
#
|
||
# Required
|
||
#
|
||
endpoint = "http://127.0.0.1:8080"
|
||
|
||
# Enable watch Mesos changes
|
||
#
|
||
# Optional
|
||
#
|
||
watch = true
|
||
|
||
# Default domain used.
|
||
# Can be overridden by setting the "traefik.domain" label on an application.
|
||
#
|
||
# Required
|
||
#
|
||
domain = "mesos.localhost"
|
||
|
||
# Override default configuration template. For advanced users :)
|
||
#
|
||
# Optional
|
||
#
|
||
# filename = "mesos.tmpl"
|
||
|
||
# Expose Mesos apps by default in traefik
|
||
#
|
||
# Optional
|
||
# Default: false
|
||
#
|
||
# ExposedByDefault = true
|
||
|
||
# TLS client configuration. https://golang.org/pkg/crypto/tls/#Config
|
||
#
|
||
# Optional
|
||
#
|
||
# [mesos.TLS]
|
||
# InsecureSkipVerify = true
|
||
|
||
# Zookeeper timeout (in seconds)
|
||
#
|
||
# Optional
|
||
# Default: 30
|
||
#
|
||
# ZkDetectionTimeout = 30
|
||
|
||
# Polling interval (in seconds)
|
||
#
|
||
# Optional
|
||
# Default: 30
|
||
#
|
||
# RefreshSeconds = 30
|
||
|
||
# IP sources (e.g. host, docker, mesos, rkt)
|
||
#
|
||
# Optional
|
||
#
|
||
# IPSources = "host"
|
||
|
||
# HTTP Timeout (in seconds)
|
||
#
|
||
# Optional
|
||
# Default: 30
|
||
#
|
||
# StateTimeoutSecond = "30"
|
||
```
|
||
|
||
## Kubernetes Ingress backend
|
||
|
||
|
||
Træfik can be configured to use Kubernetes Ingress as a backend configuration:
|
||
|
||
```toml
|
||
################################################################
|
||
# Kubernetes Ingress configuration backend
|
||
################################################################
|
||
# Enable Kubernetes Ingress configuration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[kubernetes]
|
||
|
||
# Kubernetes server endpoint
|
||
#
|
||
# When deployed as a replication controller in Kubernetes, Traefik will use
|
||
# the environment variables KUBERNETES_SERVICE_HOST and KUBERNETES_SERVICE_PORT
|
||
# to construct the endpoint.
|
||
# Secure token will be found in /var/run/secrets/kubernetes.io/serviceaccount/token
|
||
# and SSL CA cert in /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
|
||
#
|
||
# The endpoint may be given to override the environment variable values.
|
||
#
|
||
# When the environment variables are not found, Traefik will try to connect to
|
||
# the Kubernetes API server with an external-cluster client. In this case, the
|
||
# endpoint is required. Specifically, it may be set to the URL used by
|
||
# `kubectl proxy` to connect to a Kubernetes cluster from localhost.
|
||
#
|
||
# Optional for in-cluster configuration, required otherwise
|
||
# Default: empty
|
||
#
|
||
# endpoint = "http://localhost:8080"
|
||
|
||
# Bearer token used for the Kubernetes client configuration.
|
||
#
|
||
# Optional
|
||
# Default: empty
|
||
#
|
||
# token = "my token"
|
||
|
||
# Path to the certificate authority file used for the Kubernetes client
|
||
# configuration.
|
||
#
|
||
# Optional
|
||
# Default: empty
|
||
#
|
||
# certAuthFilePath = "/my/ca.crt"
|
||
|
||
# Array of namespaces to watch.
|
||
#
|
||
# Optional
|
||
# Default: ["default"].
|
||
#
|
||
# namespaces = ["default", "production"]
|
||
|
||
# See: http://kubernetes.io/docs/user-guide/labels/#list-and-watch-filtering
|
||
# labelselector = "A and not B"
|
||
#
|
||
```
|
||
|
||
Annotations can be used on containers to override default behaviour for the whole Ingress resource:
|
||
|
||
- `traefik.frontend.rule.type: PathPrefixStrip`: override the default frontend rule type (Default: `PathPrefix`).
|
||
|
||
Annotations can be used on the Kubernetes service to override default behaviour:
|
||
|
||
- `traefik.backend.loadbalancer.method=drr`: override the default `wrr` load balancer algorithm
|
||
- `traefik.backend.loadbalancer.sticky=true`: enable backend sticky sessions
|
||
|
||
You can find here an example [ingress](https://raw.githubusercontent.com/containous/traefik/master/examples/k8s/cheese-ingress.yaml) and [replication controller](https://raw.githubusercontent.com/containous/traefik/master/examples/k8s/traefik.yaml).
|
||
|
||
Additionally, an annotation can be used on Kubernetes services to set the [circuit breaker expression](https://docs.traefik.io/basics/#backends) for a backend.
|
||
|
||
- `traefik.backend.circuitbreaker: <expression>`: set the circuit breaker expression for the backend (Default: nil).
|
||
|
||
As known from nginx when used as Kubernetes Ingress Controller, a List of IP-Ranges which are allowed to access can be configured by using an ingress annotation:
|
||
|
||
- `ingress.kubernetes.io/whitelist-source-range: "1.2.3.0/24, fe80::/16"`
|
||
|
||
An unset or empty list allows all Source-IPs to access. If one of the Net-Specifications are invalid, the whole list is invalid and allows all Source-IPs to access.
|
||
|
||
|
||
### Authentication
|
||
|
||
Is possible to add additional authentication annotations in the Ingress rule.
|
||
The source of the authentication is a secret that contains usernames and passwords inside the the key auth.
|
||
|
||
- `ingress.kubernetes.io/auth-type`: `basic`
|
||
- `ingress.kubernetes.io/auth-secret`: contains the usernames and passwords with access to the paths defined in the Ingress Rule.
|
||
|
||
The secret must be created in the same namespace as the Ingress rule.
|
||
|
||
Limitations:
|
||
|
||
- Basic authentication only.
|
||
- Realm not configurable; only `traefik` default.
|
||
- Secret must contain only single file.
|
||
|
||
## Consul backend
|
||
|
||
Træfik can be configured to use Consul as a backend configuration:
|
||
|
||
```toml
|
||
################################################################
|
||
# Consul KV configuration backend
|
||
################################################################
|
||
|
||
# Enable Consul KV configuration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[consul]
|
||
|
||
# Consul server endpoint
|
||
#
|
||
# Required
|
||
#
|
||
endpoint = "127.0.0.1:8500"
|
||
|
||
# Enable watch Consul changes
|
||
#
|
||
# Optional
|
||
#
|
||
watch = true
|
||
|
||
# Prefix used for KV store.
|
||
#
|
||
# Optional
|
||
#
|
||
prefix = "traefik"
|
||
|
||
# Override default configuration template. For advanced users :)
|
||
#
|
||
# Optional
|
||
#
|
||
# filename = "consul.tmpl"
|
||
|
||
# Enable consul TLS connection
|
||
#
|
||
# Optional
|
||
#
|
||
# [consul.tls]
|
||
# ca = "/etc/ssl/ca.crt"
|
||
# cert = "/etc/ssl/consul.crt"
|
||
# key = "/etc/ssl/consul.key"
|
||
# insecureskipverify = true
|
||
```
|
||
|
||
Please refer to the [Key Value storage structure](/user-guide/kv-config/#key-value-storage-structure) section to get documentation on traefik KV structure.
|
||
|
||
## Consul catalog backend
|
||
|
||
Træfik can be configured to use service discovery catalog of Consul as a backend configuration:
|
||
|
||
```toml
|
||
################################################################
|
||
# Consul Catalog configuration backend
|
||
################################################################
|
||
|
||
# Enable Consul Catalog configuration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[consulCatalog]
|
||
|
||
# Consul server endpoint
|
||
#
|
||
# Required
|
||
#
|
||
endpoint = "127.0.0.1:8500"
|
||
|
||
# Default domain used.
|
||
#
|
||
# Optional
|
||
#
|
||
domain = "consul.localhost"
|
||
|
||
# Prefix for Consul catalog tags
|
||
#
|
||
# Optional
|
||
#
|
||
prefix = "traefik"
|
||
|
||
# Default frontEnd Rule for Consul services
|
||
# The format is a Go Template with ".ServiceName", ".Domain" and ".Attributes" available
|
||
# "getTag(name, tags, defaultValue)", "hasTag(name, tags)" and "getAttribute(name, tags, defaultValue)" functions are available
|
||
# "getAttribute(...)" function uses prefixed tag names based on "prefix" value
|
||
#
|
||
# Optional
|
||
#
|
||
frontEndRule = "Host:{{.ServiceName}}.{{Domain}}"
|
||
```
|
||
|
||
This backend will create routes matching on hostname based on the service name
|
||
used in consul.
|
||
|
||
Additional settings can be defined using Consul Catalog tags:
|
||
|
||
- `traefik.enable=false`: disable this container in Træfik
|
||
- `traefik.protocol=https`: override the default `http` protocol
|
||
- `traefik.backend.weight=10`: assign this weight to the container
|
||
- `traefik.backend.circuitbreaker=NetworkErrorRatio() > 0.5`
|
||
- `traefik.backend.loadbalancer=drr`: override the default load balancing mode
|
||
- `traefik.backend.maxconn.amount=10`: set a maximum number of connections to the backend. Must be used in conjunction with the below label to take effect.
|
||
- `traefik.backend.maxconn.extractorfunc=client.ip`: set the function to be used against the request to determine what to limit maximum connections to the backend by. Must be used in conjunction with the above label to take effect.
|
||
- `traefik.frontend.rule=Host:test.traefik.io`: override the default frontend rule (Default: `Host:{{.ServiceName}}.{{.Domain}}`).
|
||
- `traefik.frontend.passHostHeader=true`: forward client `Host` header to the backend.
|
||
- `traefik.frontend.priority=10`: override default frontend priority
|
||
- `traefik.frontend.entryPoints=http,https`: assign this frontend to entry points `http` and `https`. Overrides `defaultEntryPoints`.
|
||
|
||
## Etcd backend
|
||
|
||
Træfik can be configured to use Etcd as a backend configuration:
|
||
|
||
```toml
|
||
################################################################
|
||
# Etcd configuration backend
|
||
################################################################
|
||
|
||
# Enable Etcd configuration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[etcd]
|
||
|
||
# Etcd server endpoint
|
||
#
|
||
# Required
|
||
#
|
||
endpoint = "127.0.0.1:2379"
|
||
|
||
# Enable watch Etcd changes
|
||
#
|
||
# Optional
|
||
#
|
||
watch = true
|
||
|
||
# Prefix used for KV store.
|
||
#
|
||
# Optional
|
||
#
|
||
prefix = "/traefik"
|
||
|
||
# Override default configuration template. For advanced users :)
|
||
#
|
||
# Optional
|
||
#
|
||
# filename = "etcd.tmpl"
|
||
|
||
# Use etcd user/pass authentication
|
||
#
|
||
# Optional
|
||
#
|
||
# username = foo
|
||
# password = bar
|
||
|
||
# Enable etcd TLS connection
|
||
#
|
||
# Optional
|
||
#
|
||
# [etcd.tls]
|
||
# ca = "/etc/ssl/ca.crt"
|
||
# cert = "/etc/ssl/etcd.crt"
|
||
# key = "/etc/ssl/etcd.key"
|
||
# insecureskipverify = true
|
||
```
|
||
|
||
Please refer to the [Key Value storage structure](/user-guide/kv-config/#key-value-storage-structure) section to get documentation on traefik KV structure.
|
||
|
||
|
||
## Zookeeper backend
|
||
|
||
Træfik can be configured to use Zookeeper as a backend configuration:
|
||
|
||
```toml
|
||
################################################################
|
||
# Zookeeper configuration backend
|
||
################################################################
|
||
|
||
# Enable Zookeeperconfiguration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[zookeeper]
|
||
|
||
# Zookeeper server endpoint
|
||
#
|
||
# Required
|
||
#
|
||
endpoint = "127.0.0.1:2181"
|
||
|
||
# Enable watch Zookeeper changes
|
||
#
|
||
# Optional
|
||
#
|
||
watch = true
|
||
|
||
# Prefix used for KV store.
|
||
#
|
||
# Optional
|
||
#
|
||
prefix = "traefik"
|
||
|
||
# Override default configuration template. For advanced users :)
|
||
#
|
||
# Optional
|
||
#
|
||
# filename = "zookeeper.tmpl"
|
||
```
|
||
|
||
Please refer to the [Key Value storage structure](/user-guide/kv-config/#key-value-storage-structure) section to get documentation on traefik KV structure.
|
||
|
||
## BoltDB backend
|
||
|
||
Træfik can be configured to use BoltDB as a backend configuration:
|
||
|
||
```toml
|
||
################################################################
|
||
# BoltDB configuration backend
|
||
################################################################
|
||
|
||
# Enable BoltDB configuration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[boltdb]
|
||
|
||
# BoltDB file
|
||
#
|
||
# Required
|
||
#
|
||
endpoint = "/my.db"
|
||
|
||
# Enable watch BoltDB changes
|
||
#
|
||
# Optional
|
||
#
|
||
watch = true
|
||
|
||
# Prefix used for KV store.
|
||
#
|
||
# Optional
|
||
#
|
||
prefix = "/traefik"
|
||
|
||
# Override default configuration template. For advanced users :)
|
||
#
|
||
# Optional
|
||
#
|
||
# filename = "boltdb.tmpl"
|
||
```
|
||
|
||
## Eureka backend
|
||
|
||
Træfik can be configured to use Eureka as a backend configuration:
|
||
|
||
|
||
```toml
|
||
################################################################
|
||
# Eureka configuration backend
|
||
################################################################
|
||
|
||
# Enable Eureka configuration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[eureka]
|
||
|
||
# Eureka server endpoint.
|
||
# endpoint := "http://my.eureka.server/eureka"
|
||
#
|
||
# Required
|
||
#
|
||
endpoint = "http://my.eureka.server/eureka"
|
||
|
||
# Override default configuration time between refresh
|
||
#
|
||
# Optional
|
||
# default 30s
|
||
delay = "1m"
|
||
|
||
# Override default configuration template. For advanced users :)
|
||
#
|
||
# Optional
|
||
#
|
||
# filename = "eureka.tmpl"
|
||
```
|
||
|
||
Please refer to the [Key Value storage structure](/user-guide/kv-config/#key-value-storage-structure) section to get documentation on traefik KV structure.
|
||
|
||
|
||
## ECS backend
|
||
|
||
Træfik can be configured to use Amazon ECS as a backend configuration:
|
||
|
||
|
||
```toml
|
||
################################################################
|
||
# ECS configuration backend
|
||
################################################################
|
||
|
||
# Enable ECS configuration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[ecs]
|
||
|
||
# ECS Cluster Name
|
||
#
|
||
# Optional
|
||
# Default: "default"
|
||
#
|
||
Cluster = "default"
|
||
|
||
# Enable watch ECS changes
|
||
#
|
||
# Optional
|
||
# Default: true
|
||
#
|
||
Watch = true
|
||
|
||
# Polling interval (in seconds)
|
||
#
|
||
# Optional
|
||
# Default: 15
|
||
#
|
||
RefreshSeconds = 15
|
||
|
||
# Expose ECS services by default in traefik
|
||
#
|
||
# Optional
|
||
# Default: true
|
||
#
|
||
ExposedByDefault = false
|
||
|
||
# Region to use when connecting to AWS
|
||
#
|
||
# Optional
|
||
#
|
||
# Region = "us-east-1"
|
||
|
||
# AccessKeyID to use when connecting to AWS
|
||
#
|
||
# Optional
|
||
#
|
||
# AccessKeyID = "abc"
|
||
|
||
# SecretAccessKey to use when connecting to AWS
|
||
#
|
||
# Optional
|
||
#
|
||
# SecretAccessKey = "123"
|
||
|
||
```
|
||
|
||
Labels can be used on task containers to override default behaviour:
|
||
|
||
- `traefik.protocol=https`: override the default `http` protocol
|
||
- `traefik.weight=10`: assign this weight to the container
|
||
- `traefik.enable=false`: disable this container in Træfik
|
||
- `traefik.frontend.rule=Host:test.traefik.io`: override the default frontend rule (Default: `Host:{containerName}.{domain}`).
|
||
- `traefik.frontend.passHostHeader=true`: forward client `Host` header to the backend.
|
||
- `traefik.frontend.priority=10`: override default frontend priority
|
||
- `traefik.frontend.entryPoints=http,https`: assign this frontend to entry points `http` and `https`. Overrides `defaultEntryPoints`.
|
||
|
||
If `AccessKeyID`/`SecretAccessKey` is not given credentials will be resolved in the following order:
|
||
|
||
- From environment variables; `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_SESSION_TOKEN`.
|
||
- Shared credentials, determined by `AWS_PROFILE` and `AWS_SHARED_CREDENTIALS_FILE`, defaults to `default` and `~/.aws/credentials`.
|
||
- EC2 instance role or ECS task role
|
||
|
||
Træfik needs the following policy to read ECS information:
|
||
|
||
```json
|
||
{
|
||
"Version": "2012-10-17",
|
||
"Statement": [
|
||
{
|
||
"Sid": "Traefik ECS read access",
|
||
"Effect": "Allow",
|
||
"Action": [
|
||
"ecs:ListTasks",
|
||
"ecs:DescribeTasks",
|
||
"ecs:DescribeContainerInstances",
|
||
"ecs:DescribeTaskDefinition",
|
||
"ec2:DescribeInstances"
|
||
],
|
||
"Resource": [
|
||
"*"
|
||
]
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
# Rancher backend
|
||
|
||
Træfik can be configured to use Rancher as a backend configuration:
|
||
|
||
|
||
```toml
|
||
################################################################
|
||
# Rancher configuration backend
|
||
################################################################
|
||
|
||
# Enable Rancher configuration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[rancher]
|
||
|
||
# Default domain used.
|
||
# Can be overridden by setting the "traefik.domain" label on an service.
|
||
#
|
||
# Required
|
||
#
|
||
domain = "rancher.localhost"
|
||
|
||
# Enable watch Rancher changes
|
||
#
|
||
# Optional
|
||
# Default: true
|
||
#
|
||
Watch = true
|
||
|
||
# Polling interval (in seconds)
|
||
#
|
||
# Optional
|
||
#
|
||
RefreshSeconds = 15
|
||
|
||
# Expose Rancher services by default in traefik
|
||
#
|
||
# Optional
|
||
# Default: true
|
||
#
|
||
ExposedByDefault = false
|
||
|
||
# Filter services with unhealthy states and inactive states
|
||
#
|
||
# Optional
|
||
# Default: false
|
||
#
|
||
EnableServiceHealthFilter = true
|
||
```
|
||
|
||
```toml
|
||
# Enable Rancher metadata service configuration backend instead of the API
|
||
# configuration backend
|
||
#
|
||
# Optional
|
||
# Default: false
|
||
#
|
||
[rancher.metadata]
|
||
|
||
# Poll the Rancher metadata service for changes every `rancher.RefreshSeconds`
|
||
# NOTE: this is less accurate than the default long polling technique which
|
||
# will provide near instantaneous updates to Traefik
|
||
#
|
||
# Optional
|
||
# Default: false
|
||
#
|
||
IntervalPoll = true
|
||
|
||
# Prefix used for accessing the Rancher metadata service
|
||
#
|
||
# Optional
|
||
# Default: "/latest"
|
||
#
|
||
Prefix = "/2016-07-29"
|
||
```
|
||
|
||
```toml
|
||
# Enable Rancher API configuration backend
|
||
#
|
||
# Optional
|
||
# Default: true
|
||
#
|
||
[rancher.api]
|
||
|
||
# Endpoint to use when connecting to the Rancher API
|
||
#
|
||
# Required
|
||
Endpoint = "http://rancherserver.example.com/v1"
|
||
|
||
# AccessKey to use when connecting to the Rancher API
|
||
#
|
||
# Required
|
||
AccessKey = "XXXXXXXXXXXXXXXXXXXX"
|
||
|
||
# SecretKey to use when connecting to the Rancher API
|
||
#
|
||
# Required
|
||
SecretKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
||
```
|
||
|
||
If Traefik needs access to the Rancher API, you need to set the `endpoint`, `accesskey` and `secretkey` parameters.
|
||
|
||
To enable traefik to fetch information about the Environment it's deployed in only, you need to create an `Environment API Key`.
|
||
This can be found within the API Key advanced options.
|
||
|
||
Labels can be used on task containers to override default behaviour:
|
||
|
||
- `traefik.protocol=https`: override the default `http` protocol
|
||
- `traefik.weight=10`: assign this weight to the container
|
||
- `traefik.enable=false`: disable this container in Træfik
|
||
- `traefik.frontend.rule=Host:test.traefik.io`: override the default frontend rule (Default: `Host:{containerName}.{domain}`).
|
||
- `traefik.frontend.passHostHeader=true`: forward client `Host` header to the backend.
|
||
- `traefik.frontend.priority=10`: override default frontend priority
|
||
- `traefik.frontend.entryPoints=http,https`: assign this frontend to entry points `http` and `https`. Overrides `defaultEntryPoints`.
|
||
- `traefik.frontend.auth.basic=test:$apr1$H6uskkkW$IgXLP6ewTrSuBkTrqE8wj/,test2:$apr1$d9hr9HBB$4HxwgUir3HP4EsggP/QNo0`: Sets basic authentication for that frontend with the usernames and passwords test:test and test2:test2, respectively
|
||
|
||
|
||
## DynamoDB backend
|
||
|
||
Træfik can be configured to use Amazon DynamoDB as a backend configuration:
|
||
|
||
|
||
```toml
|
||
################################################################
|
||
# DynamoDB configuration backend
|
||
################################################################
|
||
|
||
# Enable DynamoDB configuration backend
|
||
#
|
||
# Optional
|
||
#
|
||
[dynamodb]
|
||
|
||
# DyanmoDB Table Name
|
||
#
|
||
# Optional
|
||
#
|
||
TableName = "traefik"
|
||
|
||
# Enable watch DynamoDB changes
|
||
#
|
||
# Optional
|
||
#
|
||
Watch = true
|
||
|
||
# Polling interval (in seconds)
|
||
#
|
||
# Optional
|
||
#
|
||
RefreshSeconds = 15
|
||
|
||
# Region to use when connecting to AWS
|
||
#
|
||
# Required
|
||
#
|
||
# Region = "us-west-1"
|
||
|
||
# AccessKeyID to use when connecting to AWS
|
||
#
|
||
# Optional
|
||
#
|
||
# AccessKeyID = "abc"
|
||
|
||
# SecretAccessKey to use when connecting to AWS
|
||
#
|
||
# Optional
|
||
#
|
||
# SecretAccessKey = "123"
|
||
|
||
# Endpoint of local dynamodb instance for testing
|
||
#
|
||
# Optional
|
||
#
|
||
# Endpoint = "http://localhost:8080"
|
||
|
||
```
|
||
|
||
Items in the `dynamodb` table must have three attributes:
|
||
|
||
- `id` : string
|
||
- The id is the primary key.
|
||
- `name` : string
|
||
- The name is used as the name of the frontend or backend.
|
||
- `frontend` or `backend` : map
|
||
- This attribute's structure matches exactly the structure of a Frontend or Backend type in traefik. See `types/types.go` for details. The presence or absence of this attribute determines its type. So an item should never have both a `frontend` and a `backend` attribute.
|