summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authordanielhanrahan <daniel.hanrahan@est.tech>2024-03-19 15:28:32 +0000
committerdanielhanrahan <daniel.hanrahan@est.tech>2024-03-19 15:28:32 +0000
commit1ace2e651edb89d042bfbc80861dedfc83f44caf (patch)
tree00716c530b060803b912b4a3d06fce78cd20db38 /docs
parent4e2c927201143795748e599d205ebe46679c7e05 (diff)
Update deployment docs for Postgres shared_buffers value
- update deployment.rst to include info on Postgres shared_buffers Issue-ID: CPS-2156 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Ia6e896e066227477a4824c03336de270800698d2
Diffstat (limited to 'docs')
-rw-r--r--docs/deployment.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/deployment.rst b/docs/deployment.rst
index de276ce28f..ba8fcd9347 100644
--- a/docs/deployment.rst
+++ b/docs/deployment.rst
@@ -12,6 +12,13 @@ CPS Deployment
.. contents::
:depth: 2
+Database configuration
+======================
+CPS uses PostgreSQL database. As per the `PostgreSQL documentation on resource consumption
+<https://www.postgresql.org/docs/current/runtime-config-resource.html#GUC-SHARED-BUFFERS>`_, the *shared_buffers*
+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 OOM Charts
==============
The CPS kubernetes chart is located in the `OOM repository <https://github.com/onap/oom/tree/master/kubernetes/cps>`_.