From 67090ae91395c94ab5918adcb4ae27ce33058abf Mon Sep 17 00:00:00 2001 From: "halil.cakal" Date: Wed, 9 Oct 2024 17:33:19 +0100 Subject: add documentaiton for cps-and-ncmp deployment - 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 --- docs/deployment.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'docs') 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 `_. @@ -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. | -- cgit 1.2.3-korg