Skip to content

Commit b43137b

Browse files
committed
📝 docs: Documentation only changes
1 parent 2db4731 commit b43137b

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -700,6 +700,14 @@ In some scenarios is required to have different values. To allow this we provide
700700
- `nginx.ingress.kubernetes.io/proxy-next-upstream-tries`
701701
- `nginx.ingress.kubernetes.io/proxy-request-buffering`
702702

703+
If you indicate [Backend Protocol](#backend-protocol) as `GRPC` or `GRPCS`, the following values will be applied to gRPC connection as well:
704+
705+
```
706+
grpc_connect_timeout {{ proxy_connect_timeout }}
707+
grpc_send_timeout {{ proxy_send_timeout }}
708+
grpc_read_timeout {{ proxy_read_timeout }}
709+
```
710+
703711
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.
704712
705713
### Proxy redirect

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1142,14 +1142,20 @@ See NGINX [client_max_body_size](https://nginx.org/en/docs/http/ngx_http_core_mo
11421142

11431143
Sets the timeout for [establishing a connection with a proxied server](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_connect_timeout). It should be noted that this timeout cannot usually exceed 75 seconds.
11441144

1145+
It will also set the [grpc_connect_timeout](https://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_connect_timeout) for gRPC connections.
1146+
11451147
## proxy-read-timeout
11461148

11471149
Sets the timeout in seconds for [reading a response from the proxied server](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_read_timeout). The timeout is set only between two successive read operations, not for the transmission of the whole response.
11481150

1151+
It will also set the [grpc_read_timeout](https://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_read_timeout) for gRPC connections.
1152+
11491153
## proxy-send-timeout
11501154

11511155
Sets the timeout in seconds for [transmitting a request to the proxied server](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_send_timeout). The timeout is set only between two successive write operations, not for the transmission of the whole request.
11521156

1157+
It will also set the [grpc_send_timeout](https://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_send_timeout) for gRPC connections.
1158+
11531159
## proxy-buffers-number
11541160

11551161
Sets the number of the buffer used for [reading the first part of the response](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffers) received from the proxied server. This part usually contains a small response header.

0 commit comments

Comments
 (0)