From 743d772a804327e843a740a37040f37577e4b994 Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Mon, 28 Oct 2019 11:04:05 +0100 Subject: [PATCH] doc: @ is not authorized in names definition. --- docs/content/providers/docker.md | 2 +- docs/content/routing/providers/docker.md | 6 ++++++ docs/content/routing/providers/marathon.md | 6 ++++++ docs/content/routing/providers/rancher.md | 6 ++++++ docs/content/routing/providers/service-by-label.md | 5 ++--- docs/content/routing/routers/index.md | 8 ++++++++ docs/content/routing/services/index.md | 4 ++-- 7 files changed, 31 insertions(+), 6 deletions(-) diff --git a/docs/content/providers/docker.md b/docs/content/providers/docker.md index 9e0715175..af39fc68b 100644 --- a/docs/content/providers/docker.md +++ b/docs/content/providers/docker.md @@ -128,7 +128,7 @@ Traefik requires access to the docker socket to get its dynamic configuration. ??? info "Resources about Docker's Security" - [KubeCon EU 2018 Keynote, Running with Scissors, from Liz Rice](https://www.youtube.com/watch?v=ltrV-Qmh3oY) - - [Don't expose the Docker socket (not even to a container)](https://www.lvh.io/posts/dont-expose-the-docker-socket-not-even-to-a-container.html) + - [Don't expose the Docker socket (not even to a container)](https://www.lvh.io/posts/dont-expose-the-docker-socket-not-even-to-a-container/) - [A thread on Stack Overflow about sharing the `/var/run/docker.sock` file](https://news.ycombinator.com/item?id=17983623) - [To DinD or not to DinD](https://blog.loof.fr/2018/01/to-dind-or-not-do-dind.html) diff --git a/docs/content/routing/providers/docker.md b/docs/content/routing/providers/docker.md index eade358c5..9fc796b87 100644 --- a/docs/content/routing/providers/docker.md +++ b/docs/content/routing/providers/docker.md @@ -129,6 +129,8 @@ add labels starting with `traefik.http.routers..` and follo For example, to change the rule, you could add the label ```traefik.http.routers.my-container.rule=Host(`mydomain.com`)```. +!!! warning "The character `@` is not authorized in the router name ``." + ??? info "`traefik.http.routers..rule`" See [rule](../routers/index.md#rule) for more information. @@ -217,6 +219,8 @@ add labels starting with `traefik.http.services..`, followe For example, to change the `passHostHeader` behavior, you'd add the label `traefik.http.services..loadbalancer.passhostheader=false`. +!!! warning "The character `@` is not authorized in the service name ``." + ??? info "`traefik.http.services..loadbalancer.server.port`" Registers a port. @@ -350,6 +354,8 @@ you'd write `traefik.http.middlewares.my-redirect.redirectscheme.scheme=https`. More information about available middlewares in the dedicated [middlewares section](../../middlewares/overview.md). +!!! warning "The character `@` is not authorized in the middleware name." + ??? example "Declaring and Referencing a Middleware" ```yaml diff --git a/docs/content/routing/providers/marathon.md b/docs/content/routing/providers/marathon.md index 10478c39e..72881f156 100644 --- a/docs/content/routing/providers/marathon.md +++ b/docs/content/routing/providers/marathon.md @@ -52,6 +52,8 @@ add labels starting with `traefik.http.routers.{router-name-of-your-choice}.` an For example, to change the routing rule, you could add the label ```"traefik.http.routers.routername.rule": "Host(`mydomain.com`)"```. +!!! warning "The character `@` is not authorized in the router name ``." + ??? info "`traefik.http.routers..rule`" See [rule](../routers/index.md#rule) for more information. @@ -139,6 +141,8 @@ add labels starting with `traefik.http.services.{service-name-of-your-choice}.`, For example, to change the passHostHeader behavior, you'd add the label `"traefik.http.services.servicename.loadbalancer.passhostheader": "false"`. +!!! warning "The character `@` is not authorized in the service name ``." + ??? info "`traefik.http.services..loadbalancer.server.port`" Registers a port. @@ -268,6 +272,8 @@ For example, to declare a middleware [`redirectscheme`](../../middlewares/redire More information about available middlewares in the dedicated [middlewares section](../../middlewares/overview.md). +!!! warning "The character `@` is not authorized in the middleware name." + ??? example "Declaring and Referencing a Middleware" ```json diff --git a/docs/content/routing/providers/rancher.md b/docs/content/routing/providers/rancher.md index 4adb45614..d523221f8 100644 --- a/docs/content/routing/providers/rancher.md +++ b/docs/content/routing/providers/rancher.md @@ -57,6 +57,8 @@ To update the configuration of the Router automatically attached to the containe For example, to change the rule, you could add the label ```traefik.http.routers.my-container.rule=Host(`mydomain.com`)```. +!!! warning "The character `@` is not authorized in the router name ``." + ??? info "`traefik.http.routers..rule`" See [rule](../routers/index.md#rule) for more information. @@ -145,6 +147,8 @@ add labels starting with `traefik.http.services.{name-of-your-choice}.`, followe For example, to change the `passHostHeader` behavior, you'd add the label `traefik.http.services.{name-of-your-choice}.loadbalancer.passhostheader=false`. +!!! warning "The character `@` is not authorized in the service name ``." + ??? info "`traefik.http.services..loadbalancer.server.port`" Registers a port. @@ -274,6 +278,8 @@ For example, to declare a middleware [`redirectscheme`](../../middlewares/redire More information about available middlewares in the dedicated [middlewares section](../../middlewares/overview.md). +!!! warning "The character `@` is not authorized in the middleware name." + ??? example "Declaring and Referencing a Middleware" ```yaml diff --git a/docs/content/routing/providers/service-by-label.md b/docs/content/routing/providers/service-by-label.md index bd16fd43e..611f1ad2e 100644 --- a/docs/content/routing/providers/service-by-label.md +++ b/docs/content/routing/providers/service-by-label.md @@ -7,9 +7,8 @@ There are, however, exceptions when using label-based configurations: and a label defines a service (e.g. implicitly through a loadbalancer server port value), but the router does not specify any service, then that service is automatically assigned to the router. -1. If a label defines a router (e.g. through a router Rule) -but no service is defined, then a service is automatically created -and assigned to the router. +1. If a label defines a router (e.g. through a router Rule) but no service is defined, +then a service is automatically created and assigned to the router. !!! info "" As one would expect, in either of these cases, if in addition a service is specified for the router, diff --git a/docs/content/routing/routers/index.md b/docs/content/routing/routers/index.md index d9290d28f..4e00a72cc 100644 --- a/docs/content/routing/routers/index.md +++ b/docs/content/routing/routers/index.md @@ -84,6 +84,8 @@ In the process, routers may use pieces of [middleware](../../middlewares/overvie ## Configuring HTTP Routers +!!! warning "The character `@` is not authorized in the router name" + ### EntryPoints If not specified, HTTP routers will accept requests from all defined entry points. @@ -342,6 +344,8 @@ A value of `0` for the priority is ignored: `priority = 0` means that the defaul You can attach a list of [middlewares](../../middlewares/overview.md) to each HTTP router. The middlewares will take effect only if the rule matches, and before forwarding the request to the service. +!!! warning "The character `@` is not authorized in the middleware name." + !!! tip "Middlewares order" Middlewares are applied in the same order as their declaration in **router**. @@ -381,6 +385,8 @@ but there are exceptions for label-based providers. See the specific [docker](../providers/docker.md#service-definition), [rancher](../providers/rancher.md#service-definition), or [marathon](../providers/marathon.md#service-definition) documentation. +!!! warning "The character `@` is not authorized in the middleware name." + !!! important "HTTP routers can only target HTTP services (not TCP services)." ### TLS @@ -629,6 +635,8 @@ The [supported `provider` table](../../https/acme.md#providers) indicates if the ## Configuring TCP Routers +!!! warning "The character `@` is not authorized in the router name" + ### General If both HTTP routers and TCP routers listen to the same entry points, the TCP routers will apply *before* the HTTP routers. diff --git a/docs/content/routing/services/index.md b/docs/content/routing/services/index.md index cd48b5ba8..212754fe0 100644 --- a/docs/content/routing/services/index.md +++ b/docs/content/routing/services/index.md @@ -346,7 +346,7 @@ By default, `passHostHeader` is true. loadBalancer: passHostHeader: false ``` - + #### Response Forwarding This section is about configuring how Traefik forwards the response from the backend server to the client. @@ -378,7 +378,7 @@ Below are the available options for the Response Forwarding mechanism: responseForwarding: flushInterval: 1s ``` - + ### Weighted Round Robin (service) The WRR is able to load balance the requests between multiple services based on weights.