chore: add documentation for the grcp buffer size configuration

This commit is contained in:
Ramon Silveira Borges 2024-03-24 21:45:17 +01:00
parent 3b59efaf95
commit a418d79481

View file

@ -26,7 +26,7 @@ data:
The following table shows a configuration option's name, type, and the default value:
|name| type | default |notes|
|:---|:---|:------|:----|
|:---|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----|
|[add-headers](#add-headers)| string | "" ||
|[allow-backend-server-header](#allow-backend-server-header)| bool | "false" ||
|[allow-cross-namespace-resources](#allow-cross-namespace-resources)| bool | "true" ||
@ -234,6 +234,7 @@ The following table shows a configuration option's name, type, and the default v
|[ssl-reject-handshake](#ssl-reject-handshake)| bool | "false" ||
|[debug-connections](#debug-connections)| []string | "127.0.0.1,1.1.1.1/24" ||
|[strict-validate-path-type](#strict-validate-path-type)| bool | "false" (v1.7.x) ||
|[grpc-buffer-size-kb](#grpc-buffer-size-kb)| int | 0 ||
## add-headers
@ -1432,3 +1433,10 @@ This means that Ingress objects that rely on paths containing regex characters s
The cluster admin should establish validation rules using mechanisms like [Open Policy Agent](https://www.openpolicyagent.org/) to
validate that only authorized users can use `ImplementationSpecific` pathType and that only the authorized characters can be used.
## grpc-buffer-size-kb
Sets the configuration for the GRPC Buffer Size parameter. If not set it will use the default from NGINX.
_References:_
[https://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_buffer_size](https://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_buffer_size)