Merge pull request #3232 from hhunter-ms/issue_2918b

[Resiliency] Clarify timeout section
This commit is contained in:
greenie-msft 2023-03-24 12:53:04 -07:00 committed by GitHub
commit 992c460912
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions

View File

@ -12,12 +12,12 @@ Define timeouts, retries, and circuit breaker policies under `policies`. Each po
## Timeouts
Timeouts can be used to early-terminate long-running operations. If you've exceeded a timeout duration:
Timeouts are optional policies that can be used to early-terminate long-running operations. If you've exceeded a timeout duration:
- The operation in progress is terminated (if possible).
- An error is returned.
Valid values are of the form accepted by Go's [time.ParseDuration](https://pkg.go.dev/time#ParseDuration), for example: `15s`, `2m`, `1h30m`.
Valid values are of the form accepted by Go's [time.ParseDuration](https://pkg.go.dev/time#ParseDuration), for example: `15s`, `2m`, `1h30m`. Timeouts have no set maximum value.
Example:
@ -31,6 +31,8 @@ spec:
largeResponse: 10s
```
If you don't specify a timeout value, the policy does not enforce a time and defaults to whatever you set up per the request client.
## Retries
With `retries`, you can define a retry strategy for failed operations, including requests failed due to triggering a defined timeout or circuit breaker policy. The following retry options are configurable: