Update docs to reflect Provider wording
This commit is contained in:
parent
a0872c9e31
commit
190ebbed27
25 changed files with 116 additions and 117 deletions
|
@ -1,13 +1,13 @@
|
||||||
# BoltDB Backend
|
# BoltDB Provider
|
||||||
|
|
||||||
Træfik can be configured to use BoltDB as a backend configuration.
|
Træfik can be configured to use BoltDB as a provider.
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# BoltDB configuration backend
|
# BoltDB Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable BoltDB configuration backend.
|
# Enable BoltDB Provider.
|
||||||
[boltdb]
|
[boltdb]
|
||||||
|
|
||||||
# BoltDB file.
|
# BoltDB file.
|
||||||
|
@ -56,4 +56,4 @@ filename = "boltdb.tmpl"
|
||||||
# insecureSkipVerify = true
|
# insecureSkipVerify = true
|
||||||
```
|
```
|
||||||
|
|
||||||
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).
|
To enable constraints see [provider-specific constraints section](/configuration/commons/#provider-specific).
|
||||||
|
|
|
@ -1,13 +1,13 @@
|
||||||
# Consul Key-Value Backend
|
# Consul Key-Value Provider
|
||||||
|
|
||||||
Træfik can be configured to use Consul as a backend configuration.
|
Træfik can be configured to use Consul as a provider.
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# Consul KV configuration backend
|
# Consul KV Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable Consul KV configuration backend.
|
# Enable Consul KV Provider.
|
||||||
[consul]
|
[consul]
|
||||||
|
|
||||||
# Consul server endpoint.
|
# Consul server endpoint.
|
||||||
|
@ -56,6 +56,6 @@ prefix = "traefik"
|
||||||
# insecureSkipVerify = true
|
# insecureSkipVerify = true
|
||||||
```
|
```
|
||||||
|
|
||||||
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).
|
To enable constraints see [provider-specific constraints section](/configuration/commons/#provider-specific).
|
||||||
|
|
||||||
Please refer to the [Key Value storage structure](/user-guide/kv-config/#key-value-storage-structure) section to get documentation on Traefik KV structure.
|
Please refer to the [Key Value storage structure](/user-guide/kv-config/#key-value-storage-structure) section to get documentation on Traefik KV structure.
|
||||||
|
|
|
@ -1,13 +1,13 @@
|
||||||
# Consul Catalog backend
|
# Consul Catalog Provider
|
||||||
|
|
||||||
Træfik can be configured to use service discovery catalog of Consul as a backend configuration.
|
Træfik can be configured to use service discovery catalog of Consul as a provider.
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# Consul Catalog configuration backend
|
# Consul Catalog Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable Consul Catalog configuration backend.
|
# Enable Consul Catalog Provider.
|
||||||
[consulCatalog]
|
[consulCatalog]
|
||||||
|
|
||||||
# Consul server endpoint.
|
# Consul server endpoint.
|
||||||
|
@ -76,9 +76,9 @@ prefix = "traefik"
|
||||||
# templateVersion = 2
|
# templateVersion = 2
|
||||||
```
|
```
|
||||||
|
|
||||||
This backend will create routes matching on hostname based on the service name used in Consul.
|
This provider will create routes matching on hostname based on the service name used in Consul.
|
||||||
|
|
||||||
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).
|
To enable constraints see [provider-specific constraints section](/configuration/commons/#provider-specific).
|
||||||
|
|
||||||
## Tags
|
## Tags
|
||||||
|
|
||||||
|
|
|
@ -1,16 +1,16 @@
|
||||||
|
|
||||||
# Docker Backend
|
# Docker Provider
|
||||||
|
|
||||||
Træfik can be configured to use Docker as a backend configuration.
|
Træfik can be configured to use Docker as a provider.
|
||||||
|
|
||||||
## Docker
|
## Docker
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# Docker configuration backend
|
# Docker Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable Docker configuration backend.
|
# Enable Docker Provider.
|
||||||
[docker]
|
[docker]
|
||||||
|
|
||||||
# Docker server endpoint. Can be a tcp or a unix socket endpoint.
|
# Docker server endpoint. Can be a tcp or a unix socket endpoint.
|
||||||
|
@ -82,17 +82,17 @@ swarmMode = false
|
||||||
# insecureSkipVerify = true
|
# insecureSkipVerify = true
|
||||||
```
|
```
|
||||||
|
|
||||||
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).
|
To enable constraints see [provider-specific constraints section](/configuration/commons/#provider-specific).
|
||||||
|
|
||||||
|
|
||||||
## Docker Swarm Mode
|
## Docker Swarm Mode
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# Docker Swarm Mode configuration backend
|
# Docker Swarm Mode Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable Docker configuration backend.
|
# Enable Docker Provider.
|
||||||
[docker]
|
[docker]
|
||||||
|
|
||||||
# Docker server endpoint.
|
# Docker server endpoint.
|
||||||
|
@ -159,7 +159,7 @@ exposedByDefault = false
|
||||||
# insecureSkipVerify = true
|
# insecureSkipVerify = true
|
||||||
```
|
```
|
||||||
|
|
||||||
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).
|
To enable constraints see [provider-specific constraints section](/configuration/commons/#provider-specific).
|
||||||
|
|
||||||
## Labels: overriding default behavior
|
## Labels: overriding default behavior
|
||||||
|
|
||||||
|
|
|
@ -1,15 +1,15 @@
|
||||||
# DynamoDB Backend
|
# DynamoDB Provider
|
||||||
|
|
||||||
Træfik can be configured to use Amazon DynamoDB as a backend configuration.
|
Træfik can be configured to use Amazon DynamoDB as a provider.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# DynamoDB configuration backend
|
# DynamoDB Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable DynamoDB configuration backend.
|
# Enable DynamoDB Provider.
|
||||||
[dynamodb]
|
[dynamodb]
|
||||||
|
|
||||||
# Region to use when connecting to AWS.
|
# Region to use when connecting to AWS.
|
||||||
|
@ -68,4 +68,3 @@ Items in the `dynamodb` table must have three attributes:
|
||||||
See `types/types.go` for details.
|
See `types/types.go` for details.
|
||||||
The presence or absence of this attribute determines its type.
|
The presence or absence of this attribute determines its type.
|
||||||
So an item should never have both a `frontend` and a `backend` attribute.
|
So an item should never have both a `frontend` and a `backend` attribute.
|
||||||
|
|
||||||
|
|
|
@ -1,15 +1,15 @@
|
||||||
# ECS Backend
|
# ECS Provider
|
||||||
|
|
||||||
Træfik can be configured to use Amazon ECS as a backend configuration.
|
Træfik can be configured to use Amazon ECS as a provider.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# ECS configuration backend
|
# ECS Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable ECS configuration backend.
|
# Enable ECS Provider.
|
||||||
[ecs]
|
[ecs]
|
||||||
|
|
||||||
# ECS Cluster Name.
|
# ECS Cluster Name.
|
||||||
|
|
|
@ -1,13 +1,13 @@
|
||||||
# Etcd Backend
|
# Etcd Provider
|
||||||
|
|
||||||
Træfik can be configured to use Etcd as a backend configuration.
|
Træfik can be configured to use Etcd as a provider.
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# Etcd configuration backend
|
# Etcd Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable Etcd configuration backend.
|
# Enable Etcd Provider.
|
||||||
[etcd]
|
[etcd]
|
||||||
|
|
||||||
# Etcd server endpoint.
|
# Etcd server endpoint.
|
||||||
|
@ -66,7 +66,7 @@ useAPIV3 = true
|
||||||
# insecureSkipVerify = true
|
# insecureSkipVerify = true
|
||||||
```
|
```
|
||||||
|
|
||||||
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).
|
To enable constraints see [provider-specific constraints section](/configuration/commons/#provider-specific).
|
||||||
|
|
||||||
Please refer to the [Key Value storage structure](/user-guide/kv-config/#key-value-storage-structure) section to get documentation on Traefik KV structure.
|
Please refer to the [Key Value storage structure](/user-guide/kv-config/#key-value-storage-structure) section to get documentation on Traefik KV structure.
|
||||||
|
|
||||||
|
|
|
@ -1,13 +1,13 @@
|
||||||
# Eureka Backend
|
# Eureka Provider
|
||||||
|
|
||||||
Træfik can be configured to use Eureka as a backend configuration.
|
Træfik can be configured to use Eureka as a provider.
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# Eureka configuration backend
|
# Eureka Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable Eureka configuration backend.
|
# Enable Eureka Provider.
|
||||||
[eureka]
|
[eureka]
|
||||||
|
|
||||||
# Eureka server endpoint.
|
# Eureka server endpoint.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# File Backends
|
# File Provider
|
||||||
|
|
||||||
Træfik can be configured with a file.
|
Træfik can be configured with a file.
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Kubernetes Ingress Backend
|
# Kubernetes Ingress Provider
|
||||||
|
|
||||||
Træfik can be configured to use Kubernetes Ingress as a backend configuration.
|
Træfik can be configured to use Kubernetes Ingress as a provider.
|
||||||
|
|
||||||
See also [Kubernetes user guide](/user-guide/kubernetes).
|
See also [Kubernetes user guide](/user-guide/kubernetes).
|
||||||
|
|
||||||
|
@ -8,10 +8,10 @@ See also [Kubernetes user guide](/user-guide/kubernetes).
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# Kubernetes Ingress configuration backend
|
# Kubernetes Ingress Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable Kubernetes Ingress configuration backend.
|
# Enable Kubernetes Ingress Provider.
|
||||||
[kubernetes]
|
[kubernetes]
|
||||||
|
|
||||||
# Kubernetes server endpoint.
|
# Kubernetes server endpoint.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Marathon Backend
|
# Marathon Provider
|
||||||
|
|
||||||
Træfik can be configured to use Marathon as a backend configuration.
|
Træfik can be configured to use Marathon as a provider.
|
||||||
|
|
||||||
See also [Marathon user guide](/user-guide/marathon).
|
See also [Marathon user guide](/user-guide/marathon).
|
||||||
|
|
||||||
|
@ -9,10 +9,10 @@ See also [Marathon user guide](/user-guide/marathon).
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# Mesos/Marathon configuration backend
|
# Mesos/Marathon Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable Marathon configuration backend.
|
# Enable Marathon Provider.
|
||||||
[marathon]
|
[marathon]
|
||||||
|
|
||||||
# Marathon server endpoint.
|
# Marathon server endpoint.
|
||||||
|
@ -157,7 +157,7 @@ domain = "marathon.localhost"
|
||||||
# respectReadinessChecks = true
|
# respectReadinessChecks = true
|
||||||
```
|
```
|
||||||
|
|
||||||
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).
|
To enable constraints see [provider-specific constraints section](/configuration/commons/#provider-specific).
|
||||||
|
|
||||||
## Labels: overriding default behavior
|
## Labels: overriding default behavior
|
||||||
|
|
||||||
|
|
|
@ -1,13 +1,13 @@
|
||||||
# Mesos Generic Backend
|
# Mesos Generic Provider
|
||||||
|
|
||||||
Træfik can be configured to use Mesos as a backend configuration.
|
Træfik can be configured to use Mesos as a provider.
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# Mesos configuration backend
|
# Mesos Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable Mesos configuration backend.
|
# Enable Mesos Provider.
|
||||||
[mesos]
|
[mesos]
|
||||||
|
|
||||||
# Mesos server endpoint.
|
# Mesos server endpoint.
|
||||||
|
|
|
@ -1,15 +1,15 @@
|
||||||
# Rancher Backend
|
# Rancher Provider
|
||||||
|
|
||||||
Træfik can be configured to use Rancher as a backend configuration.
|
Træfik can be configured to use Rancher as a provider.
|
||||||
|
|
||||||
## Global Configuration
|
## Global Configuration
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# Rancher configuration backend
|
# Rancher Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable Rancher configuration backend.
|
# Enable Rancher Provider.
|
||||||
[rancher]
|
[rancher]
|
||||||
|
|
||||||
# Default domain used.
|
# Default domain used.
|
||||||
|
@ -64,13 +64,13 @@ enableServiceHealthFilter = true
|
||||||
# templateVersion = 2
|
# templateVersion = 2
|
||||||
```
|
```
|
||||||
|
|
||||||
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).
|
To enable constraints see [provider-specific constraints section](/configuration/commons/#provider-specific).
|
||||||
|
|
||||||
## Rancher Metadata Service
|
## Rancher Metadata Service
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
# Enable Rancher metadata service configuration backend instead of the API
|
# Enable Rancher metadata service provider instead of the API
|
||||||
# configuration backend.
|
# provider.
|
||||||
#
|
#
|
||||||
# Optional
|
# Optional
|
||||||
# Default: false
|
# Default: false
|
||||||
|
@ -97,7 +97,7 @@ prefix = "/2016-07-29"
|
||||||
## Rancher API
|
## Rancher API
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
# Enable Rancher API configuration backend.
|
# Enable Rancher API provider.
|
||||||
#
|
#
|
||||||
# Optional
|
# Optional
|
||||||
# Default: true
|
# Default: true
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Rest Backend
|
# Rest Provider
|
||||||
|
|
||||||
Træfik can be configured:
|
Træfik can be configured:
|
||||||
|
|
||||||
|
@ -7,7 +7,7 @@ Træfik can be configured:
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
# Enable rest backend.
|
# Enable REST Provider.
|
||||||
[rest]
|
[rest]
|
||||||
# Name of the related entry point
|
# Name of the related entry point
|
||||||
#
|
#
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Azure Service Fabric Backend
|
# Azure Service Fabric Provider
|
||||||
|
|
||||||
Træfik can be configured to use Azure Service Fabric as a backend configuration.
|
Træfik can be configured to use Azure Service Fabric as a provider.
|
||||||
|
|
||||||
See [this repository for an example deployment package and further documentation.](https://aka.ms/traefikonsf)
|
See [this repository for an example deployment package and further documentation.](https://aka.ms/traefikonsf)
|
||||||
|
|
||||||
|
@ -8,10 +8,10 @@ See [this repository for an example deployment package and further documentation
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# Azure Service Fabric provider
|
# Azure Service Fabric Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable Azure Service Fabric configuration backend
|
# Enable Azure Service Fabric Provider
|
||||||
[serviceFabric]
|
[serviceFabric]
|
||||||
|
|
||||||
# Azure Service Fabric Management Endpoint
|
# Azure Service Fabric Management Endpoint
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Web Backend
|
# Web Provider
|
||||||
|
|
||||||
!!! danger "DEPRECATED"
|
!!! danger "DEPRECATED"
|
||||||
The web provider is deprecated, please use the [api](/configuration/api.md), the [ping](/configuration/ping.md), the [metrics](/configuration/metrics) and the [rest](/configuration/backends/rest.md) provider.
|
The web provider is deprecated, please use the [api](/configuration/api.md), the [ping](/configuration/ping.md), the [metrics](/configuration/metrics) and the [rest](/configuration/backends/rest.md) provider.
|
||||||
|
@ -12,7 +12,7 @@ Træfik can be configured:
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
# Enable web backend.
|
# Enable Web Provider.
|
||||||
[web]
|
[web]
|
||||||
|
|
||||||
# Web administration port.
|
# Web administration port.
|
||||||
|
|
|
@ -1,13 +1,13 @@
|
||||||
# Zookeeper Backend
|
# Zookeeper Provider
|
||||||
|
|
||||||
Træfik can be configured to use Zookeeper as a backend configuration.
|
Træfik can be configured to use Zookeeper as a provider.
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
################################################################
|
################################################################
|
||||||
# Zookeeper configuration backend
|
# Zookeeper Provider
|
||||||
################################################################
|
################################################################
|
||||||
|
|
||||||
# Enable Zookeeperconfiguration backend.
|
# Enable Zookeeper Provider.
|
||||||
[zookeeper]
|
[zookeeper]
|
||||||
|
|
||||||
# Zookeeper server endpoint.
|
# Zookeeper server endpoint.
|
||||||
|
@ -56,6 +56,6 @@ prefix = "traefik"
|
||||||
# insecureSkipVerify = true
|
# insecureSkipVerify = true
|
||||||
```
|
```
|
||||||
|
|
||||||
To enable constraints see [backend-specific constraints section](/configuration/commons/#backend-specific).
|
To enable constraints see [provider-specific constraints section](/configuration/commons/#provider-specific).
|
||||||
|
|
||||||
Please refer to the [Key Value storage structure](/user-guide/kv-config/#key-value-storage-structure) section to get documentation on Traefik KV structure.
|
Please refer to the [Key Value storage structure](/user-guide/kv-config/#key-value-storage-structure) section to get documentation on Traefik KV structure.
|
||||||
|
|
|
@ -33,7 +33,7 @@
|
||||||
#
|
#
|
||||||
# checkNewVersion = false
|
# checkNewVersion = false
|
||||||
|
|
||||||
# Backends throttle duration.
|
# Providers throttle duration.
|
||||||
#
|
#
|
||||||
# Optional
|
# Optional
|
||||||
# Default: "2s"
|
# Default: "2s"
|
||||||
|
@ -85,7 +85,7 @@ Can be provided in a format supported by [time.ParseDuration](https://golang.org
|
||||||
If no units are provided, the value is parsed assuming seconds.
|
If no units are provided, the value is parsed assuming seconds.
|
||||||
**Note:** in this time frame no new requests are accepted.
|
**Note:** in this time frame no new requests are accepted.
|
||||||
|
|
||||||
- `providersThrottleDuration`: Backends throttle duration: minimum duration in seconds between 2 events from providers before applying a new configuration.
|
- `providersThrottleDuration`: Providers 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.
|
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).
|
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.
|
If no units are provided, the value is parsed assuming seconds.
|
||||||
|
@ -108,7 +108,7 @@ Each frontend can specify its own entrypoints.
|
||||||
|
|
||||||
In a micro-service architecture, with a central service discovery, setting constraints limits Træfik scope to a smaller number of routes.
|
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.
|
Træfik filters services according to service attributes/tags set in your providers.
|
||||||
|
|
||||||
Supported filters:
|
Supported filters:
|
||||||
|
|
||||||
|
@ -136,9 +136,9 @@ constraints = ["tag==us-*"]
|
||||||
constraints = ["tag!=us-*", "tag!=asia-*"]
|
constraints = ["tag!=us-*", "tag!=asia-*"]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backend-specific
|
### provider-specific
|
||||||
|
|
||||||
Supported backends:
|
Supported Providers:
|
||||||
|
|
||||||
- Docker
|
- Docker
|
||||||
- Consul K/V
|
- Consul K/V
|
||||||
|
@ -151,12 +151,12 @@ Supported backends:
|
||||||
- Kubernetes (using a provider-specific mechanism based on label selectors)
|
- Kubernetes (using a provider-specific mechanism based on label selectors)
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
# Backend-specific constraint
|
# Provider-specific constraint
|
||||||
[consulCatalog]
|
[consulCatalog]
|
||||||
# ...
|
# ...
|
||||||
constraints = ["tag==api"]
|
constraints = ["tag==api"]
|
||||||
|
|
||||||
# Backend-specific constraint
|
# Provider-specific constraint
|
||||||
[marathon]
|
[marathon]
|
||||||
# ...
|
# ...
|
||||||
constraints = ["tag==api", "tag!=v*-beta"]
|
constraints = ["tag==api", "tag!=v*-beta"]
|
||||||
|
@ -421,12 +421,12 @@ idleTimeout = "360s"
|
||||||
!!! warning
|
!!! warning
|
||||||
For advanced users only.
|
For advanced users only.
|
||||||
|
|
||||||
Supported by all backends except: File backend, Web backend and DynamoDB backend.
|
Supported by all providers except: File Provider, Web Provider and DynamoDB Provider.
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[backend_name]
|
[provider_name]
|
||||||
|
|
||||||
# Override default configuration template. For advanced users :)
|
# Override default provider configuration template. For advanced users :)
|
||||||
#
|
#
|
||||||
# Optional
|
# Optional
|
||||||
# Default: ""
|
# Default: ""
|
||||||
|
|
|
@ -47,7 +47,7 @@ _(But if you'd rather configure some of your routes manually, Træfik supports t
|
||||||
- Packaged as a single binary file (made with :heart: with go) and available as a [tiny](https://microbadger.com/images/traefik) [official](https://hub.docker.com/r/_/traefik/) docker image
|
- Packaged as a single binary file (made with :heart: with go) and available as a [tiny](https://microbadger.com/images/traefik) [official](https://hub.docker.com/r/_/traefik/) docker image
|
||||||
|
|
||||||
|
|
||||||
## Supported backends
|
## Supported Providers
|
||||||
|
|
||||||
- [Docker](/configuration/backends/docker/) / [Swarm mode](/configuration/backends/docker/#docker-swarm-mode)
|
- [Docker](/configuration/backends/docker/) / [Swarm mode](/configuration/backends/docker/#docker-swarm-mode)
|
||||||
- [Kubernetes](/configuration/backends/kubernetes/)
|
- [Kubernetes](/configuration/backends/kubernetes/)
|
||||||
|
@ -166,7 +166,7 @@ IP: 172.27.0.4
|
||||||
### 4 — Enjoy Træfik's Magic
|
### 4 — Enjoy Træfik's Magic
|
||||||
|
|
||||||
Now that you have a basic understanding of how Træfik can automatically create the routes to your services and load balance them, it might be time to dive into [the documentation](/) and let Træfik work for you!
|
Now that you have a basic understanding of how Træfik can automatically create the routes to your services and load balance them, it might be time to dive into [the documentation](/) and let Træfik work for you!
|
||||||
Whatever your infrastructure is, there is probably [an available Træfik backend](/#supported-backends) that will do the job.
|
Whatever your infrastructure is, there is probably [an available Træfik provider](/#supported-providers) that will do the job.
|
||||||
|
|
||||||
Our recommendation would be to see for yourself how simple it is to enable HTTPS with [Træfik's let's encrypt integration](/user-guide/examples/#lets-encrypt-support) using the dedicated [user guide](/user-guide/docker-and-lets-encrypt/).
|
Our recommendation would be to see for yourself how simple it is to enable HTTPS with [Træfik's let's encrypt integration](/user-guide/examples/#lets-encrypt-support) using the dedicated [user guide](/user-guide/docker-and-lets-encrypt/).
|
||||||
|
|
||||||
|
|
|
@ -113,7 +113,7 @@ This is the minimum configuration required to do the following:
|
||||||
- Log `ERROR`-level messages (or more severe) to the console, but silence `DEBUG`-level messages
|
- Log `ERROR`-level messages (or more severe) to the console, but silence `DEBUG`-level messages
|
||||||
- Check for new versions of Træfik periodically
|
- Check for new versions of Træfik periodically
|
||||||
- Create two entry points, namely an `HTTP` endpoint on port `80`, and an `HTTPS` endpoint on port `443` where all incoming traffic on port `80` will immediately get redirected to `HTTPS`.
|
- Create two entry points, namely an `HTTP` endpoint on port `80`, and an `HTTPS` endpoint on port `443` where all incoming traffic on port `80` will immediately get redirected to `HTTPS`.
|
||||||
- Enable the Docker configuration backend and listen for container events on the Docker unix socket we've mounted earlier. However, **new containers will not be exposed by Træfik by default, we'll get into this in a bit!**
|
- Enable the Docker provider and listen for container events on the Docker unix socket we've mounted earlier. However, **new containers will not be exposed by Træfik by default, we'll get into this in a bit!**
|
||||||
- Enable automatic request and configuration of SSL certificates using Let's Encrypt.
|
- Enable automatic request and configuration of SSL certificates using Let's Encrypt.
|
||||||
These certificates will be stored in the `acme.json` file, which you can back-up yourself and store off-premises.
|
These certificates will be stored in the `acme.json` file, which you can back-up yourself and store off-premises.
|
||||||
|
|
||||||
|
|
|
@ -422,7 +422,7 @@ Træfik will not start but the [static configuration](/basics/#static-trfik-conf
|
||||||
|
|
||||||
If you configured ACME (Let's Encrypt), your registration account and your certificates will also be uploaded.
|
If you configured ACME (Let's Encrypt), your registration account and your certificates will also be uploaded.
|
||||||
|
|
||||||
If you configured a file backend `[file]`, all your dynamic configuration (backends, frontends...) will be uploaded to the Key-value store.
|
If you configured a file provider `[file]`, all your dynamic configuration (backends, frontends...) will be uploaded to the Key-value store.
|
||||||
|
|
||||||
To upload your ACME certificates to the KV store, get your Traefik TOML file and add the new `storage` option in the `acme` section:
|
To upload your ACME certificates to the KV store, get your Traefik TOML file and add the new `storage` option in the `acme` section:
|
||||||
|
|
||||||
|
|
|
@ -101,7 +101,7 @@ Let's explain this command:
|
||||||
| `--constraint=node.role==manager` | we ask docker to schedule Træfik on a manager node. |
|
| `--constraint=node.role==manager` | we ask docker to schedule Træfik on a manager node. |
|
||||||
| `--mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock` | we bind mount the docker socket where Træfik is scheduled to be able to speak to the daemon. |
|
| `--mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock` | we bind mount the docker socket where Træfik is scheduled to be able to speak to the daemon. |
|
||||||
| `--network traefik-net` | we attach the Træfik service (and thus the underlying container) to the `traefik-net` network. |
|
| `--network traefik-net` | we attach the Træfik service (and thus the underlying container) to the `traefik-net` network. |
|
||||||
| `--docker` | enable docker backend, and `--docker.swarmMode` to enable the swarm mode on Træfik. |
|
| `--docker` | enable docker provider, and `--docker.swarmMode` to enable the swarm mode on Træfik. |
|
||||||
| `--api | activate the webUI on port 8080 |
|
| `--api | activate the webUI on port 8080 |
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -104,7 +104,7 @@ Let's explain this command:
|
||||||
| `--net=my-net` | run the container on the network my-net |
|
| `--net=my-net` | run the container on the network my-net |
|
||||||
| `-v /var/lib/boot2docker/:/ssl` | mount the ssl keys generated by docker-machine |
|
| `-v /var/lib/boot2docker/:/ssl` | mount the ssl keys generated by docker-machine |
|
||||||
| `-c /dev/null` | empty config file |
|
| `-c /dev/null` | empty config file |
|
||||||
| `--docker` | enable docker backend |
|
| `--docker` | enable docker provider |
|
||||||
| `--docker.endpoint=tcp://172.18.0.1:2376` | connect to the swarm master using the docker_gwbridge network |
|
| `--docker.endpoint=tcp://172.18.0.1:2376` | connect to the swarm master using the docker_gwbridge network |
|
||||||
| `--docker.tls` | enable TLS using the docker-machine keys |
|
| `--docker.tls` | enable TLS using the docker-machine keys |
|
||||||
| `--api` | activate the webUI on port 8080 |
|
| `--api` | activate the webUI on port 8080 |
|
||||||
|
|
34
mkdocs.yml
34
mkdocs.yml
|
@ -69,27 +69,27 @@ pages:
|
||||||
- 'Logs': 'configuration/logs.md'
|
- 'Logs': 'configuration/logs.md'
|
||||||
- 'EntryPoints': 'configuration/entrypoints.md'
|
- 'EntryPoints': 'configuration/entrypoints.md'
|
||||||
- 'Let''s Encrypt': 'configuration/acme.md'
|
- 'Let''s Encrypt': 'configuration/acme.md'
|
||||||
- 'Backend: Web': 'configuration/backends/web.md'
|
|
||||||
- 'Backend: BoltDB': 'configuration/backends/boltdb.md'
|
|
||||||
- 'Backend: Consul': 'configuration/backends/consul.md'
|
|
||||||
- 'Backend: Consul Catalog': 'configuration/backends/consulcatalog.md'
|
|
||||||
- 'Backend: Docker': 'configuration/backends/docker.md'
|
|
||||||
- 'Backend: DynamoDB': 'configuration/backends/dynamodb.md'
|
|
||||||
- 'Backend: ECS': 'configuration/backends/ecs.md'
|
|
||||||
- 'Backend: Etcd': 'configuration/backends/etcd.md'
|
|
||||||
- 'Backend: Eureka': 'configuration/backends/eureka.md'
|
|
||||||
- 'Backend: File': 'configuration/backends/file.md'
|
|
||||||
- 'Backend: Kubernetes Ingress': 'configuration/backends/kubernetes.md'
|
|
||||||
- 'Backend: Marathon': 'configuration/backends/marathon.md'
|
|
||||||
- 'Backend: Mesos': 'configuration/backends/mesos.md'
|
|
||||||
- 'Backend: Rancher': 'configuration/backends/rancher.md'
|
|
||||||
- 'Backend: Rest': 'configuration/backends/rest.md'
|
|
||||||
- 'Backend: Azure Service Fabric': 'configuration/backends/servicefabric.md'
|
|
||||||
- 'Backend: Zookeeper': 'configuration/backends/zookeeper.md'
|
|
||||||
- 'API / Dashboard': 'configuration/api.md'
|
- 'API / Dashboard': 'configuration/api.md'
|
||||||
|
- 'BoltDB': 'configuration/backends/boltdb.md'
|
||||||
|
- 'Consul': 'configuration/backends/consul.md'
|
||||||
|
- 'Consul Catalog': 'configuration/backends/consulcatalog.md'
|
||||||
|
- 'Docker': 'configuration/backends/docker.md'
|
||||||
|
- 'DynamoDB': 'configuration/backends/dynamodb.md'
|
||||||
|
- 'ECS': 'configuration/backends/ecs.md'
|
||||||
|
- 'Etcd': 'configuration/backends/etcd.md'
|
||||||
|
- 'Eureka': 'configuration/backends/eureka.md'
|
||||||
|
- 'File': 'configuration/backends/file.md'
|
||||||
|
- 'Kubernetes Ingress': 'configuration/backends/kubernetes.md'
|
||||||
|
- 'Marathon': 'configuration/backends/marathon.md'
|
||||||
|
- 'Mesos': 'configuration/backends/mesos.md'
|
||||||
|
- 'Rancher': 'configuration/backends/rancher.md'
|
||||||
|
- 'Rest': 'configuration/backends/rest.md'
|
||||||
|
- 'Azure Service Fabric': 'configuration/backends/servicefabric.md'
|
||||||
|
- 'Zookeeper': 'configuration/backends/zookeeper.md'
|
||||||
- 'Ping': 'configuration/ping.md'
|
- 'Ping': 'configuration/ping.md'
|
||||||
- 'Metrics': 'configuration/metrics.md'
|
- 'Metrics': 'configuration/metrics.md'
|
||||||
- 'Tracing': 'configuration/tracing.md'
|
- 'Tracing': 'configuration/tracing.md'
|
||||||
|
- 'Web (Deprecated)': 'configuration/backends/web.md'
|
||||||
- User Guides:
|
- User Guides:
|
||||||
- 'Configuration Examples': 'user-guide/examples.md'
|
- 'Configuration Examples': 'user-guide/examples.md'
|
||||||
- 'Swarm Mode Cluster': 'user-guide/swarm-mode.md'
|
- 'Swarm Mode Cluster': 'user-guide/swarm-mode.md'
|
||||||
|
|
Loading…
Reference in a new issue