Skip to content

Commit

Permalink
docs: rephrased the ReadMe notes
Browse files Browse the repository at this point in the history
Added grpc thread sharing note
  • Loading branch information
rahulKQL committed Jan 31, 2020
1 parent 78c5b04 commit b1f2d90
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Expand Up @@ -347,9 +347,11 @@ Add the following to your project's pom.xml.

## Container Deployment

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.
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.

For example when deploying this client on a cluster with 8 CPU nodes:
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.

For example:
```yaml
appVersion: v1
...
Expand All @@ -358,7 +360,7 @@ spec:
container:
resources:
requests:
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.
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.
```
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.

Expand Down

0 comments on commit b1f2d90

Please sign in to comment.