docs: improve errorpages examples to avoid confusion
This commit is contained in:
parent
553ef94047
commit
088fe3c270
1 changed files with 22 additions and 14 deletions
|
@ -21,7 +21,7 @@ The Errors middleware returns a custom page in lieu of the default, according to
|
||||||
```yaml tab="Docker"
|
```yaml tab="Docker"
|
||||||
# Dynamic Custom Error Page for 5XX Status Code
|
# Dynamic Custom Error Page for 5XX Status Code
|
||||||
labels:
|
labels:
|
||||||
- "traefik.http.middlewares.test-errors.errors.status=500-599"
|
- "traefik.http.middlewares.test-errors.errors.status=500,501,503,505-599"
|
||||||
- "traefik.http.middlewares.test-errors.errors.service=serviceError"
|
- "traefik.http.middlewares.test-errors.errors.service=serviceError"
|
||||||
- "traefik.http.middlewares.test-errors.errors.query=/{status}.html"
|
- "traefik.http.middlewares.test-errors.errors.query=/{status}.html"
|
||||||
```
|
```
|
||||||
|
@ -34,7 +34,10 @@ metadata:
|
||||||
spec:
|
spec:
|
||||||
errors:
|
errors:
|
||||||
status:
|
status:
|
||||||
- "500-599"
|
- "500"
|
||||||
|
- "501"
|
||||||
|
- "503"
|
||||||
|
- "505-599"
|
||||||
query: /{status}.html
|
query: /{status}.html
|
||||||
service:
|
service:
|
||||||
name: whoami
|
name: whoami
|
||||||
|
@ -42,36 +45,39 @@ spec:
|
||||||
```
|
```
|
||||||
|
|
||||||
```yaml tab="Consul Catalog"
|
```yaml tab="Consul Catalog"
|
||||||
# Dynamic Custom Error Page for 5XX Status Code
|
# Dynamic Custom Error Page for 5XX Status Code excluding 502 and 504
|
||||||
- "traefik.http.middlewares.test-errors.errors.status=500-599"
|
- "traefik.http.middlewares.test-errors.errors.status=500,501,503,505-599"
|
||||||
- "traefik.http.middlewares.test-errors.errors.service=serviceError"
|
- "traefik.http.middlewares.test-errors.errors.service=serviceError"
|
||||||
- "traefik.http.middlewares.test-errors.errors.query=/{status}.html"
|
- "traefik.http.middlewares.test-errors.errors.query=/{status}.html"
|
||||||
```
|
```
|
||||||
|
|
||||||
```json tab="Marathon"
|
```json tab="Marathon"
|
||||||
"labels": {
|
"labels": {
|
||||||
"traefik.http.middlewares.test-errors.errors.status": "500-599",
|
"traefik.http.middlewares.test-errors.errors.status": "500,501,503,505-599",
|
||||||
"traefik.http.middlewares.test-errors.errors.service": "serviceError",
|
"traefik.http.middlewares.test-errors.errors.service": "serviceError",
|
||||||
"traefik.http.middlewares.test-errors.errors.query": "/{status}.html"
|
"traefik.http.middlewares.test-errors.errors.query": "/{status}.html"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
```yaml tab="Rancher"
|
```yaml tab="Rancher"
|
||||||
# Dynamic Custom Error Page for 5XX Status Code
|
# Dynamic Custom Error Page for 5XX Status Code excluding 502 and 504
|
||||||
labels:
|
labels:
|
||||||
- "traefik.http.middlewares.test-errors.errors.status=500-599"
|
- "traefik.http.middlewares.test-errors.errors.status=500,501,503,505-599"
|
||||||
- "traefik.http.middlewares.test-errors.errors.service=serviceError"
|
- "traefik.http.middlewares.test-errors.errors.service=serviceError"
|
||||||
- "traefik.http.middlewares.test-errors.errors.query=/{status}.html"
|
- "traefik.http.middlewares.test-errors.errors.query=/{status}.html"
|
||||||
```
|
```
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
# Custom Error Page for 5XX
|
# Dynamic Custom Error Page for 5XX Status Code excluding 502 and 504
|
||||||
http:
|
http:
|
||||||
middlewares:
|
middlewares:
|
||||||
test-errors:
|
test-errors:
|
||||||
errors:
|
errors:
|
||||||
status:
|
status:
|
||||||
- "500-599"
|
- "500"
|
||||||
|
- "501"
|
||||||
|
- "503"
|
||||||
|
- "505-599"
|
||||||
service: serviceError
|
service: serviceError
|
||||||
query: "/{status}.html"
|
query: "/{status}.html"
|
||||||
|
|
||||||
|
@ -80,10 +86,10 @@ http:
|
||||||
```
|
```
|
||||||
|
|
||||||
```toml tab="File (TOML)"
|
```toml tab="File (TOML)"
|
||||||
# Custom Error Page for 5XX
|
# Dynamic Custom Error Page for 5XX Status Code excluding 502 and 504
|
||||||
[http.middlewares]
|
[http.middlewares]
|
||||||
[http.middlewares.test-errors.errors]
|
[http.middlewares.test-errors.errors]
|
||||||
status = ["500-599"]
|
status = ["500","501","503","505-599"]
|
||||||
service = "serviceError"
|
service = "serviceError"
|
||||||
query = "/{status}.html"
|
query = "/{status}.html"
|
||||||
|
|
||||||
|
@ -101,14 +107,16 @@ http:
|
||||||
|
|
||||||
The `status` option defines which status or range of statuses should result in an error page.
|
The `status` option defines which status or range of statuses should result in an error page.
|
||||||
|
|
||||||
The status code ranges are inclusive (`500-599` will trigger with every code between `500` and `599`, `500` and `599` included).
|
The status code ranges are inclusive (`505-599` will trigger with every code between `505` and `599`, `505` and `599` included).
|
||||||
|
|
||||||
!!! note ""
|
!!! note ""
|
||||||
|
|
||||||
You can define either a status code as a number (`500`),
|
You can define either a status code as a number (`500`),
|
||||||
as multiple comma-separated numbers (`500,502`),
|
as multiple comma-separated numbers (`500,502`),
|
||||||
as ranges by separating two codes with a dash (`500-599`),
|
as ranges by separating two codes with a dash (`505-599`),
|
||||||
or a combination of the two (`404,418,500-599`).
|
or a combination of the two (`404,418,505-599`).
|
||||||
|
The comma-separated syntax is only available for label-based providers.
|
||||||
|
The examples above demonstrate which syntax is appropriate for each provider.
|
||||||
|
|
||||||
### `service`
|
### `service`
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue