From: danielhanrahan <daniel.hanrahan@est.tech>
Date: Tue, 19 Mar 2024 15:28:32 +0000 (+0000)
Subject: Update deployment docs for Postgres shared_buffers value
X-Git-Tag: 3.4.7~9^2
X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=1ace2e651edb89d042bfbc80861dedfc83f44caf;hp=-c;p=cps.git

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
---

1ace2e651edb89d042bfbc80861dedfc83f44caf
diff --git a/docs/deployment.rst b/docs/deployment.rst
index de276ce28..ba8fcd934 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>`_.