traefik/docs/content/middlewares/retry.md

84 lines
2.3 KiB
Markdown
Raw Normal View History

2019-04-08 15:14:08 +00:00
# Retry
Retrying until it Succeeds
{: .subtitle }
2019-09-10 12:40:05 +00:00
<!--
TODO: add schema
-->
The Retry middleware is in charge of reissuing a request a given number of times to a backend server if that server does not reply.
To be clear, as soon as the server answers, the middleware stops retrying, regardless of the response status.
The Retry middleware has an optional configuration for exponential backoff.
2019-04-08 15:14:08 +00:00
## Configuration Examples
2019-04-08 15:14:08 +00:00
```yaml tab="Docker"
# Retry to send request 4 times with exponential backoff
2019-04-08 15:14:08 +00:00
labels:
2019-09-23 15:00:06 +00:00
- "traefik.http.middlewares.test-retry.retry.attempts=4"
- "traefik.http.middlewares.test-retry.retry.initialinterval=100ms"
```
2019-04-08 15:14:08 +00:00
```yaml tab="Kubernetes"
# Retry to send request 4 times with exponential backoff
2019-04-08 15:14:08 +00:00
apiVersion: traefik.containo.us/v1alpha1
kind: Middleware
metadata:
name: test-retry
spec:
retry:
attempts: 4
initialInterval: 100ms
2019-04-08 15:14:08 +00:00
```
2019-10-15 15:34:08 +00:00
```yaml tab="Consul Catalog"
# Retry to send request 4 times with exponential backoff
2019-10-15 15:34:08 +00:00
- "traefik.http.middlewares.test-retry.retry.attempts=4"
- "traefik.http.middlewares.test-retry.retry.initialinterval=100ms"
2019-10-15 15:34:08 +00:00
```
```json tab="Marathon"
"labels": {
"traefik.http.middlewares.test-retry.retry.attempts": "4",
"traefik.http.middlewares.test-retry.retry.initialinterval": "100ms",
}
```
2019-04-08 15:14:08 +00:00
```yaml tab="Rancher"
# Retry to send request 4 times with exponential backoff
2019-04-08 15:14:08 +00:00
labels:
2019-09-23 15:00:06 +00:00
- "traefik.http.middlewares.test-retry.retry.attempts=4"
- "traefik.http.middlewares.test-retry.retry.initialinterval=100ms"
2019-04-08 15:14:08 +00:00
```
2019-07-22 07:58:04 +00:00
```toml tab="File (TOML)"
2019-04-08 15:14:08 +00:00
# Retry to send request 4 times
[http.middlewares]
2019-07-01 09:30:05 +00:00
[http.middlewares.test-retry.retry]
attempts = 4
initialInterval = "100ms"
2019-04-08 15:14:08 +00:00
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
# Retry to send request 4 times with exponential backoff
2019-07-22 07:58:04 +00:00
http:
middlewares:
test-retry:
retry:
attempts: 4
initialInterval: 100ms
2019-07-22 07:58:04 +00:00
```
2019-04-08 15:14:08 +00:00
## Configuration Options
### `attempts`
2019-04-08 15:14:08 +00:00
_mandatory_
2019-09-23 15:00:06 +00:00
The `attempts` option defines how many times the request should be retried.
### `initialInterval`
The `initialInterval` option defines the first wait time in the exponential backoff series (provided in seconds or as a valid duration format, see [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration)). The maximum interval is calculated as twice the `initialInterval`. If unspecified, requests will be retried immediately.