Skip to content

Commit b1f2d90

Browse files
committed
docs: rephrased the ReadMe notes
Added grpc thread sharing note
1 parent 78c5b04 commit b1f2d90

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -347,9 +347,11 @@ Add the following to your project's pom.xml.
347347

348348
## Container Deployment
349349

350-
While deploying this client in [Google Kubernetes Engine(GKE)](https://cloud.google.com/kubernetes-engine) with [CoS](https://cloud.google.com/container-optimized-os/docs/). Please make sure to provide CPU configuration in your deployment file. If `resources` are not configured than JVM would detect only 1 CPU, which affects the channel creation, resulting in performance degradation.
350+
While deploying this client in [Google Kubernetes Engine(GKE)](https://cloud.google.com/kubernetes-engine) with [CoS](https://cloud.google.com/container-optimized-os/docs/). Please make sure to provide CPU configuration in your deployment file. With default configuration JVM detects only 1 CPU, which affects the number of channels with the client, resulting in performance repercussion.
351351

352-
For example when deploying this client on a cluster with 8 CPU nodes:
352+
Also, The number of `grpc-nio-worker-ELG-1-#` thread is same as number of CPUs. These are managed by a single `grpc-default-executor-#` thread, which is shared among multiple client instances.
353+
354+
For example:
353355
```yaml
354356
appVersion: v1
355357
...
@@ -358,7 +360,7 @@ spec:
358360
container:
359361
resources:
360362
requests:
361-
cpu: "1" # Here 1 represents 100% of single node CPUs(i.e. 8) whereas other than 1 represents the number of CPU it would use from a node.
363+
cpu: "1" # Here 1 represents 100% of single node CPUs whereas other than 1 represents the number of CPU it would use from a node.
362364
```
363365
see [Assign CPU Resources to Containers](https://kubernetes.io/docs/tasks/configure-pod-container/assign-cpu-resource/#specify-a-cpu-request-and-a-cpu-limit) for more information.
364366

0 commit comments

Comments
 (0)