Skip to content

Commit ab85e25

Browse files
authored
Document the remaining timeout settings (#5954)
* document the remaining timeout settings * fix name
1 parent 2fc233e commit ab85e25

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed

docs/serving/configuration/config-defaults.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ metadata:
2020
data:
2121
revision-timeout-seconds: "300"
2222
max-revision-timeout-seconds: "600"
23+
revision-response-start-timeout-seconds: "300"
24+
revision-idle-timeout-seconds: "0" # infinite
2325
revision-cpu-request: "400m"
2426
revision-memory-request: "100M"
2527
revision-ephemeral-storage-request: "500M"
@@ -100,6 +102,83 @@ If this value is increased, the activator's `terminationGracePeriodSeconds` shou
100102
max-revision-timeout-seconds: "600"
101103
```
102104

105+
### Revision response start timeout seconds
106+
{% raw %}
107+
The revision response start timeout value determines the maximum duration in seconds that the request routing layer will wait for a request delivered to a container to begin sending any network traffic. If omitted, the system default is used (300 seconds).
108+
{% endraw %}
109+
110+
* **Global key:** `revision-response-start-timeout-seconds`
111+
* **Per-revision spec key:** `responseStartTimeoutSeconds`
112+
* **Possible values:** integer
113+
* **Default:** `"300"` (5 minutes)
114+
115+
**Example:**
116+
117+
=== "Global (ConfigMap)"
118+
```yaml
119+
apiVersion: v1
120+
kind: ConfigMap
121+
metadata:
122+
name: config-defaults
123+
namespace: knative-serving
124+
data:
125+
revision-response-start-timeout-seconds: "300"
126+
```
127+
128+
=== "Per Revision"
129+
```yaml
130+
apiVersion: serving.knative.dev/v1
131+
kind: Service
132+
metadata:
133+
name: helloworld-go
134+
namespace: default
135+
spec:
136+
template:
137+
spec:
138+
responseStartTimeoutSeconds: 300
139+
containers:
140+
- image: ghcr.io/knative/helloworld-go:latest
141+
```
142+
143+
144+
### Revision idle timeout seconds
145+
{% raw %}
146+
The revision idle timeout value determines the maximum duration in seconds a request will be allowed to stay open while not receiving any bytes from the user's application. If omitted, the system default is used (infinite).
147+
{% endraw %}
148+
149+
* **Global key:** `revision-idle-timeout-seconds`
150+
* **Per-revision spec key:** `idleTimeoutSeconds`
151+
* **Possible values:** integer
152+
* **Default:** `"0"` (infinite)
153+
154+
**Example:**
155+
156+
=== "Global (ConfigMap)"
157+
```yaml
158+
apiVersion: v1
159+
kind: ConfigMap
160+
metadata:
161+
name: config-defaults
162+
namespace: knative-serving
163+
data:
164+
revision-idle-timeout-seconds: "0"
165+
```
166+
167+
=== "Per Revision"
168+
```yaml
169+
apiVersion: serving.knative.dev/v1
170+
kind: Service
171+
metadata:
172+
name: helloworld-go
173+
namespace: default
174+
spec:
175+
template:
176+
spec:
177+
idleTimeoutSeconds: 0
178+
containers:
179+
- image: ghcr.io/knative/helloworld-go:latest
180+
```
181+
103182
### Revision CPU request
104183
{% raw %}
105184
The `revision-cpu-request` value determines the CPU allocation assigned to revisions by default. If this value is omitted, the system default is used. This key is not enabled by default for Knative.

0 commit comments

Comments
 (0)