diff --git a/README.md b/README.md index 9c9270a7a3..9f6ca33a20 100644 --- a/README.md +++ b/README.md @@ -345,6 +345,23 @@ 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. + +For example when deploying this client on a cluster with 8 CPU nodes: +```yaml +appVersion: v1 +... +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. +``` +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. + ## Troubleshooting To get help, follow the instructions in the [shared Troubleshooting