From 6845068b8276b8dd0f39f5f2ed4a1f193bc5e090 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Thu, 29 Mar 2018 00:18:50 +0200 Subject: [PATCH] doc: template version for ECS, Consul Catalog and Mesos. --- docs/configuration/backends/consulcatalog.md | 16 ++++++++++++++++ docs/configuration/backends/ecs.md | 9 +++++++++ docs/configuration/backends/mesos.md | 20 +++++++++++++++----- 3 files changed, 40 insertions(+), 5 deletions(-) diff --git a/docs/configuration/backends/consulcatalog.md b/docs/configuration/backends/consulcatalog.md index 94b56450a..de6a01259 100644 --- a/docs/configuration/backends/consulcatalog.md +++ b/docs/configuration/backends/consulcatalog.md @@ -58,6 +58,22 @@ prefix = "traefik" # cert = "/etc/ssl/consul.crt" # key = "/etc/ssl/consul.key" # insecureskipverify = true + +# Override default configuration template. +# For advanced users :) +# +# Optional +# +# filename = "consulcatalog.tmpl" + +# Override template version +# For advanced users :) +# +# Optional +# - "1": previous template version (must be used only with older custom templates, see "filename") +# - "2": current template version (must be used to force template version when "filename" is used) +# +# templateVersion = "2" ``` This backend will create routes matching on hostname based on the service name used in Consul. diff --git a/docs/configuration/backends/ecs.md b/docs/configuration/backends/ecs.md index ef2278f29..e08b8f254 100644 --- a/docs/configuration/backends/ecs.md +++ b/docs/configuration/backends/ecs.md @@ -84,6 +84,15 @@ secretAccessKey = "123" # Optional # # filename = "ecs.tmpl" + +# Override template version +# For advanced users :) +# +# Optional +# - "1": previous template version (must be used only with older custom templates, see "filename") +# - "2": current template version (must be used to force template version when "filename" is used) +# +# templateVersion = "2" ``` If `AccessKeyID`/`SecretAccessKey` is not given credentials will be resolved in the following order: diff --git a/docs/configuration/backends/mesos.md b/docs/configuration/backends/mesos.md index 229418729..9fd465fd8 100644 --- a/docs/configuration/backends/mesos.md +++ b/docs/configuration/backends/mesos.md @@ -34,6 +34,13 @@ watch = true # domain = "mesos.localhost" +# Expose Mesos apps by default in Traefik. +# +# Optional +# Default: true +# +# exposedByDefault = false + # Override default configuration template. # For advanced users :) # @@ -41,12 +48,14 @@ domain = "mesos.localhost" # # filename = "mesos.tmpl" -# Expose Mesos apps by default in Traefik. +# Override template version +# For advanced users :) # # Optional -# Default: true +# - "1": previous template version (must be used only with older custom templates, see "filename") +# - "2": current template version (must be used to force template version when "filename" is used) # -# ExposedByDefault = false +# templateVersion = "2" # TLS client configuration. https://golang.org/pkg/crypto/tls/#Config # @@ -90,11 +99,12 @@ domain = "mesos.localhost" # Default: false # # groupsAsSubDomains = true + ``` -## Labels: overriding default behaviour +## Labels: overriding default behavior -The following labels can be defined on Mesos tasks. They adjust the behaviour for the entire application. +The following labels can be defined on Mesos tasks. They adjust the behavior for the entire application. | Label | Description | |------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|