summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPriyank Maheshwari <priyank.maheshwari@est.tech>2024-10-15 10:20:31 +0000
committerGerrit Code Review <gerrit@onap.org>2024-10-15 10:20:31 +0000
commitb442bc6d6833c855fb85f29ccffc775d80cc49a7 (patch)
tree5900e2c2317ddd6cc1d633df12e1bdc28b5e9b17
parent2e6504ce4fd8bb6f845883729be2b0d9385e71f7 (diff)
parent67090ae91395c94ab5918adcb4ae27ce33058abf (diff)
Merge "add documentaiton for cps-and-ncmp deployment"
-rw-r--r--docs/deployment.rst14
1 files changed, 12 insertions, 2 deletions
diff --git a/docs/deployment.rst b/docs/deployment.rst
index ba8fcd9347..e57acf140d 100644
--- a/docs/deployment.rst
+++ b/docs/deployment.rst
@@ -19,6 +19,18 @@ CPS uses PostgreSQL database. As per the `PostgreSQL documentation on resource c
parameter should be set between 25% and 40% of total memory. It has a default value of 128 megabytes, so this should be
set appropriately. For example, given a database with 2GB of memory, 512MB is a recommended value.
+CPS and NCMP Configuration
+==========================
+
+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.
+
+.. code-block:: yaml
+
+ JAVA_TOOL_OPTIONS: "-XX:InitialRAMPercentage=75.0 -XX:MaxRAMPercentage=75.0"
+
CPS OOM Charts
==============
The CPS kubernetes chart is located in the `OOM repository <https://github.com/onap/oom/tree/master/kubernetes/cps>`_.
@@ -330,8 +342,6 @@ Below are the list of distributed datastructures that we have.
+--------------+------------------------------------+-----------------------------------------------------------+
| Component | Datastructure name | Use |
+==============+====================================+===========================================================+
-| cps-core | anchorDataCache | Used to resolve prefix for the container name. |
-+--------------+------------------------------------+-----------------------------------------------------------+
| cps-ncmp | moduleSyncStartedOnCmHandles | Watchdog process to register cm handles. |
+--------------+------------------------------------+-----------------------------------------------------------+
| cps-ncmp | dataSyncSemaphores | Watchdog process to sync data from the nodes. |