add documentaiton for cps-and-ncmp deployment 81/139181/5
authorhalil.cakal <halil.cakal@est.tech>
Wed, 9 Oct 2024 16:33:19 +0000 (17:33 +0100)
committerhalil.cakal <halil.cakal@est.tech>
Tue, 15 Oct 2024 08:31:07 +0000 (09:31 +0100)
- the optimum percentage of the JVM allocation documented
- remove anchorDataCache from the documentation
  since no more used

Issue-ID: CPS-2180

Change-Id: Ie1b8c43136a38f8da5a865493bed1df030a497d6
Signed-off-by: halil.cakal <halil.cakal@est.tech>
docs/deployment.rst

index ba8fcd9..e57acf1 100644 (file)
@@ -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.             |