homelab/traefik
1
0
Fork 0
Code Activity

Uses ASCII characters to spell Traefik

Browse source
This commit is contained in:
Gérald Croës 2018-10-17 16:24:04 +02:00 • committed by Traefiker Bot
parent 95d86d84b4
commit e6a88f3531
48 changed files with 320 additions and 320 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/configuration/backends/boltdb.md
View file

@ -1,6 +1,6 @@
# BoltDB Provider
Træfik can be configured to use BoltDB as a provider.
Traefik can be configured to use BoltDB as a provider.
```toml
################################################################

2
docs/configuration/backends/consul.md
View file

@ -1,6 +1,6 @@
# Consul Key-Value Provider
Træfik can be configured to use Consul as a provider.
Traefik can be configured to use Consul as a provider.
```toml
################################################################

8
docs/configuration/backends/consulcatalog.md
View file

@ -1,6 +1,6 @@
# Consul Catalog Provider
Træfik can be configured to use service discovery catalog of Consul as a provider.
Traefik can be configured to use service discovery catalog of Consul as a provider.
```toml
################################################################
@ -96,7 +96,7 @@ Additional settings can be defined using Consul Catalog tags.
| Label | Description |
|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `<prefix>.enable=false` | Disables this container in Træfik. |
| `<prefix>.enable=false` | Disables this container in Traefik. |
| `<prefix>.protocol=https` | Overrides the default `http` protocol. |
| `<prefix>.weight=10` | Assigns this weight to the container. |
| `traefik.backend.buffering.maxRequestBodyBytes=0` | See [buffering](/configuration/commons/#buffering) section. |
@ -214,7 +214,7 @@ If you need to support multiple frontends for a service, for example when having
### Examples
If you want that Træfik uses Consul tags correctly you need to defined them like that:
If you want that Traefik uses Consul tags correctly you need to defined them like that:
```js
traefik.enable=true
@ -222,7 +222,7 @@ traefik.tags=api
traefik.tags=external
```
If the prefix defined in Træfik configuration is `bla`, tags need to be defined like that:
If the prefix defined in Traefik configuration is `bla`, tags need to be defined like that:
```js
bla.enable=true

14
docs/configuration/backends/docker.md
View file

@ -1,7 +1,7 @@
# Docker Provider
Træfik can be configured to use Docker as a provider.
Traefik can be configured to use Docker as a provider.
## Docker
@ -213,9 +213,9 @@ Labels can be used on containers to override default behavior.
|---------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `traefik.docker.network` | Overrides the default docker network to use for connections to the container. [1] |
| `traefik.domain` | Sets the default base domain for the frontend rules. For more information, check the [Container Labels section's of the user guide "Let's Encrypt & Docker"](/user-guide/docker-and-lets-encrypt/#container-labels) |
| `traefik.enable=false` | Disables this container in Træfik. |
| `traefik.enable=false` | Disables this container in Traefik. |
| `traefik.port=80` | Registers this port. Useful when the container exposes multiples ports. |
| `traefik.tags=foo,bar,myTag` | Adds Træfik tags to the Docker container/service to be used in [constraints](/configuration/commons/#constraints). |
| `traefik.tags=foo,bar,myTag` | Adds Traefik tags to the Docker container/service to be used in [constraints](/configuration/commons/#constraints). |
| `traefik.protocol=https` | Overrides the default `http` protocol |
| `traefik.weight=10` | Assigns this weight to the container |
| `traefik.backend=foo` | Gives the name `foo` to the generated backend for this container. |
@ -426,16 +426,16 @@ Segment labels override the default behavior.
More details in this [example](/user-guide/docker-and-lets-encrypt/#labels).
!!! warning
When running inside a container, Træfik will need network access through:
When running inside a container, Traefik will need network access through:
`docker network connect <network> <traefik-container>`
## usebindportip
The default behavior of Træfik is to route requests to the IP/Port of the matching container.
When setting `usebindportip` to true, you tell Træfik to use the IP/Port attached to the container's binding instead of the inner network IP/Port.
The default behavior of Traefik is to route requests to the IP/Port of the matching container.
When setting `usebindportip` to true, you tell Traefik to use the IP/Port attached to the container's binding instead of the inner network IP/Port.
When used in conjunction with the `traefik.port` label (that tells Træfik to route requests to a specific port), Træfik tries to find a binding with `traefik.port` port to select the container. If it can't find such a binding, Træfik falls back on the internal network IP of the container, but still uses the `traefik.port` that is set in the label.
When used in conjunction with the `traefik.port` label (that tells Traefik to route requests to a specific port), Traefik tries to find a binding with `traefik.port` port to select the container. If it can't find such a binding, Traefik falls back on the internal network IP of the container, but still uses the `traefik.port` that is set in the label.
Below is a recap of the behavior of `usebindportip` in different situations.

2
docs/configuration/backends/dynamodb.md
View file

@ -1,6 +1,6 @@
# DynamoDB Provider
Træfik can be configured to use Amazon DynamoDB as a provider.
Traefik can be configured to use Amazon DynamoDB as a provider.
## Configuration

6
docs/configuration/backends/ecs.md
View file

@ -1,6 +1,6 @@
# ECS Provider
Træfik can be configured to use Amazon ECS as a provider.
Traefik can be configured to use Amazon ECS as a provider.
## Configuration
@ -106,7 +106,7 @@ To enable constraints see [provider-specific constraints section](/configuration
## Policy
Træfik needs the following policy to read ECS information:
Traefik needs the following policy to read ECS information:
```json
{
@ -139,7 +139,7 @@ Labels can be used on task containers to override default behaviour:
| Label | Description |
|---------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `traefik.domain` | Sets the default base domain for frontend rules. |
| `traefik.enable=false` | Disables this container in Træfik. |
| `traefik.enable=false` | Disables this container in Traefik. |
| `traefik.port=80` | Overrides the default `port` value. Overrides `NetworkBindings` from Docker Container |
| `traefik.protocol=https` | Overrides the default `http` protocol |
| `traefik.weight=10` | Assigns this weight to the container |

2
docs/configuration/backends/etcd.md
View file

@ -1,6 +1,6 @@
# Etcd Provider
Træfik can be configured to use Etcd as a provider.
Traefik can be configured to use Etcd as a provider.
```toml
################################################################

2
docs/configuration/backends/eureka.md
View file

@ -1,6 +1,6 @@
# Eureka Provider
Træfik can be configured to use Eureka as a provider.
Traefik can be configured to use Eureka as a provider.
```toml
################################################################

24
docs/configuration/backends/file.md
View file

@ -1,6 +1,6 @@
# File Provider
Træfik can be configured with a file.
Traefik can be configured with a file.
## Reference
@ -192,16 +192,16 @@ Træfik can be configured with a file.
You have two choices:
- [Rules in Træfik configuration file](/configuration/backends/file/#rules-in-trfik-configuration-file)
- [Rules in Traefik configuration file](/configuration/backends/file/#rules-in-traefik-configuration-file)
- [Rules in dedicated files](/configuration/backends/file/#rules-in-dedicated-files)
To enable the file backend, you must either pass the `--file` option to the Træfik binary or put the `[file]` section (with or without inner settings) in the configuration file.
To enable the file backend, you must either pass the `--file` option to the Traefik binary or put the `[file]` section (with or without inner settings) in the configuration file.
The configuration file allows managing both backends/frontends and HTTPS certificates (which are not [Let's Encrypt](https://letsencrypt.org) certificates generated through Træfik).
The configuration file allows managing both backends/frontends and HTTPS certificates (which are not [Let's Encrypt](https://letsencrypt.org) certificates generated through Traefik).
TOML templating can be used if rules are not defined in the Træfik configuration file.
TOML templating can be used if rules are not defined in the Traefik configuration file.
### Rules in Træfik Configuration File
### Rules in Traefik Configuration File
Add your configuration at the end of the global configuration file `traefik.toml`:
@ -247,11 +247,11 @@ defaultEntryPoints = ["http", "https"]
It's recommended to use the file provider to declare certificates.
!!! warning
TOML templating cannot be used if rules are defined in the Træfik configuration file.
TOML templating cannot be used if rules are defined in the Traefik configuration file.
### Rules in Dedicated Files
Træfik allows defining rules in one or more separate files.
Traefik allows defining rules in one or more separate files.
#### One Separate File
@ -272,7 +272,7 @@ defaultEntryPoints = ["http", "https"]
watch = true
```
The option `file.watch` allows Træfik to watch file changes automatically.
The option `file.watch` allows Traefik to watch file changes automatically.
#### Multiple Separated Files
@ -284,7 +284,7 @@ You could have multiple `.toml` files in a directory (and recursively in its sub
watch = true
```
The option `file.watch` allows Træfik to watch file changes automatically.
The option `file.watch` allows Traefik to watch file changes automatically.
#### Separate Files Content
@ -322,9 +322,9 @@ Backends, Frontends and TLS certificates are defined one at time, as described i
!!! warning
TOML templating can only be used **if rules are defined in one or more separate files**.
Templating will not work in the Træfik configuration file.
Templating will not work in the Traefik configuration file.
Træfik allows using TOML templating.
Traefik allows using TOML templating.
Thus, it's possible to define easily lot of Backends, Frontends and TLS certificates as described in the file `template-rules.toml` :

4
docs/configuration/backends/kubernetes.md
View file

@ -1,6 +1,6 @@
# Kubernetes Ingress Provider
Træfik can be configured to use Kubernetes Ingress as a provider.
Traefik can be configured to use Kubernetes Ingress as a provider.
See also [Kubernetes user guide](/user-guide/kubernetes).
@ -357,5 +357,5 @@ This ingress follows the [Global Default Backend](https://kubernetes.io/docs/con
This will allow users to create a "default backend" that will match all unmatched requests.
!!! note
Due to Træfik's use of priorities, you may have to set this ingress priority lower than other ingresses in your environment, to avoid this global ingress from satisfying requests that _could_ match other ingresses.
Due to Traefik's use of priorities, you may have to set this ingress priority lower than other ingresses in your environment, to avoid this global ingress from satisfying requests that _could_ match other ingresses.
To do this, use the `traefik.ingress.kubernetes.io/priority` annotation (as seen in [General Annotations](/configuration/backends/kubernetes/#general-annotations)) on your ingresses accordingly.

4
docs/configuration/backends/marathon.md
View file

@ -1,6 +1,6 @@
# Marathon Provider
Træfik can be configured to use Marathon as a provider.
Traefik can be configured to use Marathon as a provider.
See also [Marathon user guide](/user-guide/marathon).
@ -196,7 +196,7 @@ The following labels can be defined on Marathon applications. They adjust the be
| Label | Description |
|---------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `traefik.domain` | Sets the default base domain used for the frontend rules. |
| `traefik.enable=false` | Disables this container in Træfik. |
| `traefik.enable=false` | Disables this container in Traefik. |
| `traefik.port=80` | Registers this port. Useful when the container exposes multiples ports. |
| `traefik.portIndex=1` | Registers port by index in the application's ports array. Useful when the application exposes multiple ports. |
| `traefik.protocol=https` | Overrides the default `http` protocol. |

4
docs/configuration/backends/mesos.md
View file

@ -1,6 +1,6 @@
# Mesos Generic Provider
Træfik can be configured to use Mesos as a provider.
Traefik can be configured to use Mesos as a provider.
```toml
################################################################
@ -109,7 +109,7 @@ The following labels can be defined on Mesos tasks. They adjust the behavior for
| Label | Description |
|---------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `traefik.domain` | Sets the default base domain for the frontend rules. |
| `traefik.enable=false` | Disables this container in Træfik. |
| `traefik.enable=false` | Disables this container in Traefik. |
| `traefik.port=80` | Registers this port. Useful when the application exposes multiple ports. |
| `traefik.portName=web` | Registers port by name in the application's ports array. Useful when the application exposes multiple ports. |
| `traefik.portIndex=1` | Registers port by index in the application's ports array. Useful when the application exposes multiple ports. |

4
docs/configuration/backends/rancher.md
View file

@ -1,6 +1,6 @@
# Rancher Provider
Træfik can be configured to use Rancher as a provider.
Traefik can be configured to use Rancher as a provider.
## Global Configuration
@ -141,7 +141,7 @@ Labels can be used on task containers to override default behavior:
| Label | Description |
|---------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `traefik.domain` | Sets the default base domain for the frontend rules. |
| `traefik.enable=false` | Disables this container in Træfik. |
| `traefik.enable=false` | Disables this container in Traefik. |
| `traefik.port=80` | Registers this port. Useful when the container exposes multiple ports. |
| `traefik.protocol=https` | Overrides the default `http` protocol. |
| `traefik.weight=10` | Assigns this weight to the container. |

2
docs/configuration/backends/rest.md
View file

@ -1,6 +1,6 @@
# Rest Provider
Træfik can be configured:
Traefik can be configured:
- using a RESTful api.

10
docs/configuration/backends/servicefabric.md
View file

@ -1,6 +1,6 @@
# Azure Service Fabric Provider
Træfik can be configured to use Azure Service Fabric as a provider.
Traefik 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)
@ -47,13 +47,13 @@ refreshSeconds = 10
## Labels
The provider uses labels to configure how services are exposed through Træfik.
The provider uses labels to configure how services are exposed through Traefik.
These can be set using Extensions and the Property Manager API
#### Extensions
Set labels with extensions through the services `ServiceManifest.xml` file.
Here is an example of an extension setting Træfik labels:
Here is an example of an extension setting Traefik labels:
```xml
<StatelessServiceType ServiceTypeName="WebServiceType">
@ -96,9 +96,9 @@ Labels, set through extensions or the property manager, can be used on services
| Label | Description |
|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `traefik.enable=false` | Disable this container in Træfik |
| `traefik.enable=false` | Disable this container in Traefik |
| `traefik.backend.circuitbreaker.expression=EXPR` | Create a [circuit breaker](/basics/#backends) to be used against the backend |
| `traefik.servicefabric.groupname` | Group all services with the same name into a single backend in Træfik |
| `traefik.servicefabric.groupname` | Group all services with the same name into a single backend in Traefik |
| `traefik.servicefabric.groupweight` | Set the weighting of the current services nodes in the backend group |
| `traefik.servicefabric.enablelabeloverrides` | Toggle whether labels can be overridden using the Service Fabric Property Manager API |
| `traefik.backend.healthcheck.path=/health` | Enable health check for the backend, hitting the container at `path`. |

16
docs/configuration/backends/web.md
View file

@ -3,7 +3,7 @@
!!! 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.
Træfik can be configured:
Traefik can be configured:
- using a RESTful api.
- to use a monitoring system (like Prometheus, DataDog or StatD, ...).
@ -97,7 +97,7 @@ usersFile = "/path/to/.htdigest"
## Metrics
You can enable Træfik to export internal metrics to different monitoring systems.
You can enable Traefik to export internal metrics to different monitoring systems.
### Prometheus
@ -239,8 +239,8 @@ recentErrors = 10
| Path | Method | Description |
|-----------------------------------------------------------------|:-------------:|----------------------------------------------------------------------------------------------------|
| `/` | `GET` | Provides a simple HTML frontend of Træfik |
| `/ping` | `GET`, `HEAD` | A simple endpoint to check for Træfik process liveness. Return a code `200` with the content: `OK` |
| `/` | `GET` | Provides a simple HTML frontend of Traefik |
| `/ping` | `GET`, `HEAD` | A simple endpoint to check for Traefik process liveness. Return a code `200` with the content: `OK` |
| `/health` | `GET` | JSON health metrics |
| `/api` | `GET` | Configuration for all providers |
| `/api/providers` | `GET` | Providers |
@ -286,11 +286,11 @@ curl -s "http://localhost:8080/health" | jq .
```
```json
{
// Træfik PID
// Traefik PID
"pid": 2458,
// Træfik server uptime (formated time)
// Traefik server uptime (formated time)
"uptime": "39m6.885931127s",
// Træfik server uptime in seconds
// Traefik server uptime in seconds
"uptime_sec": 2346.885931127,
// current server date
"time": "2015-10-07 18:32:24.362238909 +0200 CEST",
@ -300,7 +300,7 @@ curl -s "http://localhost:8080/health" | jq .
"status_code_count": {
"502": 1
},
// count HTTP response status code since Træfik started
// count HTTP response status code since Traefik started
"total_status_code_count": {
"200": 7,
"404": 21,

2
docs/configuration/backends/zookeeper.md
View file

@ -1,6 +1,6 @@
# Zookeeper Provider
Træfik can be configured to use Zookeeper as a provider.
Traefik can be configured to use Zookeeper as a provider.
```toml
################################################################