1
0
Fork 0

doc: structural review

- user-guide review.
- add DataDog and StatD configuration.
- sync sample.toml and doc.
- split entry points doc.
- Deprecated.
This commit is contained in:
Fernandez Ludovic 2017-08-26 12:12:44 +02:00 committed by Traefiker
parent 24862402e5
commit 7c2ba62b56
32 changed files with 848 additions and 695 deletions

View file

@ -36,7 +36,7 @@
# Access logs file
#
# Optional
# Deprecated - see [accessLog] lower down
# DEPRECATED - see [accessLog] lower down
#
# accessLogsFile = "log/access.log"
@ -433,6 +433,7 @@
#
# responseHeaderTimeout = "0s"
################################################################
# Web configuration backend
################################################################
@ -455,21 +456,31 @@
#
# CertFile = "traefik.crt"
# KeyFile = "traefik.key"
#
# Set REST API to read-only mode
#
# Optional
# ReadOnly = false
#
# 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]
#
# DataDog metrics exporter type
# [web.metrics.datadog]
# Address = "localhost:8125"
# Pushinterval = "10s"
# StatsD metrics exporter type
# [web.metrics.statsd]
# Address = "localhost:8125"
# Pushinterval = "10s"
# 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
@ -511,7 +522,6 @@
#
# directory = "/path/to/config/"
# Enable watch file changes
#
# Optional
@ -572,7 +582,6 @@
# insecureskipverify = true
################################################################
# Docker Swarmmode configuration backend
################################################################
@ -693,16 +702,12 @@
#
# groupsAsSubDomains = true
# 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 Go's time.ParseDuration function or
# as raw values (digits). If no units are provided, the value is parsed assuming
# seconds.
# Enable compatibility with marathon-lb labels
#
# Optional
# Default: "60s"
# dialerTimeout = "60s"
# Default: false
#
# marathonLBCompatibility = true
# Enable Marathon basic authentication
#
@ -712,16 +717,36 @@
# 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 Go's time.ParseDuration function or
# as raw values (digits). If no units are provided, the value is parsed assuming
# 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
@ -751,6 +776,7 @@
#
# respectReadinessChecks = false
################################################################
# Mesos configuration backend
################################################################
@ -830,6 +856,7 @@
#
# StateTimeoutSecond = "30"
################################################################
# Kubernetes Ingress configuration backend
################################################################
@ -881,9 +908,15 @@
#
# namespaces = ["default"]
# See: http://kubernetes.io/docs/user-guide/labels/#list-and-watch-filtering
# Ingress label selector to identify Ingress objects that should be processed.
# See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors for details.
#
# Optional
# Default: empty (process all Ingresses)
#
# labelselector = "A and not B"
################################################################
# Consul KV configuration backend
################################################################
@ -928,6 +961,7 @@
# key = "/etc/ssl/consul.key"
# insecureskipverify = true
################################################################
# Consul Catalog configuration backend
################################################################
@ -963,20 +997,16 @@
# 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
#
# 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}}"
# Should use all Consul catalog tags for constraint filtering
#
# Optional
#
#allTagsConstraintFiltering = false
# Constraints
#
# Optional
@ -984,6 +1014,7 @@
# constraints = ["tag==api", "tag==he*ld"]
# Matching with containers having this tag: "traefik.tags=api,helloworld"
################################################################
# Etcd configuration backend
################################################################
@ -1035,6 +1066,37 @@
# key = "/etc/ssl/etcd.key"
# insecureskipverify = true
################################################################
# 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"
################################################################
# Zookeeper configuration backend
################################################################
@ -1117,7 +1179,7 @@
# ECS Cluster Name
#
# Deprecated - Please use Clusters
# DEPRECATED - Please use Clusters
#
# Cluster = "default"
@ -1135,6 +1197,13 @@
#
# Watch = true
# Enable auto discover ECS clusters
#
# Optional
# Default: false
#
# AutoDiscoverClusters = false
# Polling interval (in seconds)
#
# Optional
@ -1173,6 +1242,7 @@
#
# filename = "ecs.tmpl"
################################################################
# Rancher configuration backend
################################################################
@ -1263,6 +1333,7 @@
# Required
# SecretKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
################################################################
# DynamoDB configuration backend
################################################################