mirror of https://github.com/hashicorp/consul
* Timeout Docs Update (#19601) * Update routetimeoutfilter.mdx * Update website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Update website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Update website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --------- Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Update routetimeoutfilter.mdx * Update website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Update website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx * Update website/content/docs/connect/gateways/api-gateway/configuration/routetimeoutfilter.mdx --------- Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>pull/19676/head
sarahalsmiller
GitHub
parent
92d7d692a6
commit
dcae1bc4c2
|
|
@ -21,8 +21,8 @@ The following list outlines field hierarchy, data types, and requirements in a `
|
||||||
- [`name`](#metadata-name): string | required
|
- [`name`](#metadata-name): string | required
|
||||||
- [`namespace`](#metadata-namespace): string | `default`
|
- [`namespace`](#metadata-namespace): string | `default`
|
||||||
- [`spec`](#spec): map | required
|
- [`spec`](#spec): map | required
|
||||||
- [`idleTimeout`](#spec-idletimeout): number | `0`
|
- [`idleTimeout`](#spec-idletimeout): string | `""`
|
||||||
- [`requestTimeout`](#spec-retryonconnectfailure): number | `0`
|
- [`requestTimeout`](#spec-retryonconnectfailure): string | `""`
|
||||||
|
|
||||||
## Complete configuration
|
## Complete configuration
|
||||||
|
|
||||||
|
|
@ -97,18 +97,18 @@ Map that contains the details about the gateway policy. The `apiVersion`, `kind`
|
||||||
|
|
||||||
### `spec.idleTimeout
|
### `spec.idleTimeout
|
||||||
|
|
||||||
Specifies the total amount of time permitted for the request stream to be idle.
|
Specifies the total amount of time permitted for the request stream to be idle. Format the string as `"<number><unit>"`, for example `"5s"`. Consul uses the `metav1.Duration` package to parse the value. Refer to the [Go documentation](https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration) for additional information about defining parseable values.
|
||||||
|
|
||||||
#### Values
|
#### Values
|
||||||
|
|
||||||
- Default: 0
|
- Default: ""
|
||||||
- Data type: Integer
|
- Data type: String
|
||||||
|
|
||||||
### `spec.requestTimeout`
|
### `spec.requestTimeout`
|
||||||
|
|
||||||
Specifies the total amount of time in nanoseconds, including retry attempts, Consul permits for the entire downstream request to be processed.
|
Specifies the total amount of time in nanoseconds, including retry attempts, Consul permits for the entire downstream request to be processed. Format the string as `"<number><unit>"`, for example `"5s"`. Consul uses the `metav1.Duration` package to parse the value. Refer to the [Go documentation](https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration) for additional information about defining parseable values.
|
||||||
|
|
||||||
#### Values
|
#### Values
|
||||||
|
|
||||||
- Default: 0
|
- Default: ""
|
||||||
- Data type: Integer
|
- Data type: String
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue