aboutsummaryrefslogtreecommitdiffstats
path: root/docs/deployment.rst
diff options
context:
space:
mode:
authordanielhanrahan <daniel.hanrahan@est.tech>2025-02-05 16:36:14 +0000
committerdanielhanrahan <daniel.hanrahan@est.tech>2025-02-05 16:36:14 +0000
commit05305b747336ef9ce98dfa36364663387e1ac5c9 (patch)
tree0ac4efcf2d62d488ea44bf8269e79c0b9c6598c0 /docs/deployment.rst
parent505998edb6c65d26e81070068d9279b46234a1d0 (diff)
Update deployment docs with minimum requirements
- Add minimum CPU and Memory Requirements for NCMP to the deployment documentation, for both 20K and 50K use-cases. - Updated recommended heap allocation to 70%, based on analysis of JVM Process Memory metric in Grafana. Issue-ID: CPS-2584 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Idb056eabf7529f1bc2288a3e07975f080f413c3f
Diffstat (limited to 'docs/deployment.rst')
-rw-r--r--docs/deployment.rst16
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/deployment.rst b/docs/deployment.rst
index 2af0dd0cd5..840ab8e116 100644
--- a/docs/deployment.rst
+++ b/docs/deployment.rst
@@ -22,14 +22,24 @@ set appropriately. For example, given a database with 2GB of memory, 512MB is a
CPS and NCMP Configuration
==========================
+CPU and Memory Requirements
+---------------------------
+
+The following are minimum requirements for NCMP:
+
+* For 20,000 CM-handles: 2 CPUs and 2 GB RAM per instance, with 70% heap allocation.
+* For 50,000 CM-handles: 3 CPUs and 3 GB RAM per instance, with 70% heap allocation.
+
JVM Memory Allocation
+^^^^^^^^^^^^^^^^^^^^^
-Allocating 75% of the container's memory to the JVM heap ensures efficient memory management.
-This helps the JVM make the best use of the allocated resources while leaving enough memory for other processes.
+When running with 2 GB or more memory per instance, allocating 70% of the JVM memory to the heap ensures efficient
+memory management. It is not recommended to go above 70%.
.. code-block:: yaml
- JAVA_TOOL_OPTIONS: "-XX:InitialRAMPercentage=75.0 -XX:MaxRAMPercentage=75.0"
+ JAVA_TOOL_OPTIONS: "-XX:InitialRAMPercentage=70.0 -XX:MaxRAMPercentage=70.0"
+
Load balancer configuration
===========================