Skip to content

Commit 044d125

Browse files
committed
📝 docs: grpc timeouts example
1 parent 7ade80e commit 044d125

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

‎docs/examples/grpc/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,11 +166,9 @@ This example demonstrates how to route traffic to a gRPC service through the Ing
166166
167167
### Notes on using response/request streams
168168

169+
> `grpc_read_timeout` and `grpc_send_timeout` will be set as `proxy_read_timeout` and `proxy_send_timeout` when you set backend protocol to `GRPC` or `GRPCS`.
170+
169171
1. If your server only does response streaming and you expect a stream to be open longer than 60 seconds, you will have to change the `grpc_read_timeout` to accommodate this.
170172
2. If your service only does request streaming and you expect a stream to be open longer than 60 seconds, you have to change the
171173
`grpc_send_timeout` and the `client_body_timeout`.
172174
3. If you do both response and request streaming with an open stream longer than 60 seconds, you have to change all three timeouts: `grpc_read_timeout`, `grpc_send_timeout` and `client_body_timeout`.
173-
174-
Values for the timeouts must be specified as e.g. `"1200s"`.
175-
176-
> On the most recent versions of ingress-nginx, changing these timeouts requires using the `nginx.ingress.kubernetes.io/server-snippet` annotation. There are plans for future releases to allow using the Kubernetes annotations to define each timeout separately.

0 commit comments

Comments
 (0)