Skip to content

Commit ef6af53

Browse files
authored
add client body timeout to annotations.md
Client body timeout is currently documented only as configmap but it is supported as nginx ingress annotation
1 parent 57b4a14 commit ef6af53

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/user-guide/nginx-configuration/annotations.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ You can add these Kubernetes annotations to specific Ingress objects to customiz
4848
|[nginx.ingress.kubernetes.io/canary-weight](#canary)|number|
4949
|[nginx.ingress.kubernetes.io/canary-weight-total](#canary)|number|
5050
|[nginx.ingress.kubernetes.io/client-body-buffer-size](#client-body-buffer-size)|string|
51+
|[nginx.ingress.kubernetes.io/client-body-timeout](#custom-timeouts)[number]:
5152
|[nginx.ingress.kubernetes.io/configuration-snippet](#configuration-snippet)|string|
5253
|[nginx.ingress.kubernetes.io/custom-http-errors](#custom-http-errors)|[]int|
5354
|[nginx.ingress.kubernetes.io/custom-headers](#custom-headers)|string|
@@ -676,8 +677,16 @@ If you indicate [Backend Protocol](#backend-protocol) as `GRPC` or `GRPCS`, the
676677
- [`grpc_send_timeout=60s`](https://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_send_timeout), from `nginx.ingress.kubernetes.io/proxy-send-timeout`
677678
- [`grpc_read_timeout=60s`](https://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_read_timeout), from `nginx.ingress.kubernetes.io/proxy-read-timeout`
678679

680+
- `nginx.ingress.kubernetes.io/client-body-timeout`
681+
682+
Defines a timeout for reading client request body, in seconds.
683+
679684
Note: All timeout values are unitless and in seconds e.g. `nginx.ingress.kubernetes.io/proxy-read-timeout: "120"` sets a valid 120 seconds proxy read timeout.
680685

686+
687+
688+
689+
681690
### Proxy redirect
682691

683692
The annotations `nginx.ingress.kubernetes.io/proxy-redirect-from` and `nginx.ingress.kubernetes.io/proxy-redirect-to` will set the first and second parameters of NGINX's proxy_redirect directive respectively. It is possible to

0 commit comments

Comments
 (0)