Skip to content

Commit 57c2069

Browse files
authoredNov 7, 2024··
move the default upstream timeout page to global-timeouts (#1688)
* move the default upstream timeout page to global-timeouts * prettier * update link * fix heading style
1 parent 36180a8 commit 57c2069

File tree

4 files changed

+40
-58
lines changed

4 files changed

+40
-58
lines changed
 

‎content/docs/internals/connection.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Different timeouts apply at various stages of the connection lifecycle:
7070

7171
- **Request timeout**: This timeout applies to the total time a request can take, which includes connection establishment, request forwarding, processing at the upstream service, and response forwarding. If a complete response is not received within the set timeout, Pomerium will return an error to the client. This timeout can be configured via the [`timeout_write`](/docs/reference/global-timeouts) parameter. It may need adjustment, for instance, when handling large uploads.
7272

73-
- **Upstream timeout**: This timeout applies to the time a request takes to travel from Pomerium to the upstream service and back. It can be configured per-route via the [`timeout`](/docs/reference/routes/timeouts#route-timeout) parameter and is considered part of the request timeout. By default, it aligns with the global [`default_upstream_timeout`](/docs/reference/default-upstream-timeout) setting.
73+
- **Upstream timeout**: This timeout applies to the time a request takes to travel from Pomerium to the upstream service and back. It can be configured per-route via the [`timeout`](/docs/reference/routes/timeouts#route-timeout) parameter and is considered part of the request timeout. By default, it aligns with the global [`default_upstream_timeout`](/docs/reference/global-timeouts#default-upstream-timeout) setting.
7474

7575
![Example of HTTP request lifecycle and timeout settings](./img/timeouts-http-request/timeouts-http-diagram.png)
7676

‎content/docs/reference/default-upstream-timeout.mdx

-57
This file was deleted.

‎content/docs/reference/global-timeouts.mdx

+38
Original file line numberDiff line numberDiff line change
@@ -164,4 +164,42 @@ timeouts:
164164
</TabItem>
165165
</Tabs>
166166

167+
## Default Upstream Timeout
168+
169+
**Default Upstream Timeout** is the default timeout applied to a proxied route when no `timeout` key is specified by the policy.
170+
171+
### How to configure
172+
173+
<Tabs>
174+
<TabItem value="Core" label="Core">
175+
176+
| **Config file keys** | **Environment variables** | **Type** | **Default** |
177+
| :-- | :-- | :-- | :-- |
178+
| `default_upstream_timeout` | `DEFAULT_UPSTREAM_TIMEOUT` | [Go Duration] string | `30s` |
179+
180+
### Examples
181+
182+
```yaml
183+
default_upstream_timeout: 30s
184+
```
185+
186+
```bash
187+
DEFAULT_UPSTREAM_TIMEOUT=1h45m
188+
```
189+
190+
</TabItem>
191+
<TabItem value="Enterprise" label="Enterprise">
192+
193+
Set **Default Upstream Timeout** in the Console:
194+
195+
![Enterprise Console with default timeout setting](./img/timeouts/default-upstream-timeout.png)
196+
197+
</TabItem>
198+
<TabItem value="Kubernetes" label="Kubernetes">
199+
200+
Kubernetes does not support `default_upstream_timeout`
201+
202+
</TabItem>
203+
</Tabs>
204+
167205
[go duration]: https://golang.org/pkg/time/#Duration.String

‎static/_redirects

+1
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,7 @@ https://0-20-0.docs.pomerium.com/category/guides https://0-20-0.docs.pomerium.co
434434
/docs/reference/routes/set-authorization-header /docs/reference/routes/headers#set-authorization-header
435435

436436
# Timeouts
437+
/docs/reference/default-upstream-timeout /docs/reference/global-timeouts#default-upstream-timeout
437438
/docs/reference/routes/websocket-connections /docs/reference/routes/timeouts#websocket-connections
438439
/docs/reference/routes/spdy /docs/reference/routes/timeouts#spdy
439440
/docs/reference/routes/route-timeout /docs/reference/routes/timeouts#route-timeout

0 commit comments

Comments
 (0)
Please sign in to comment.