From 757be2f6ad19c305c03360e77227a39783b168c4 Mon Sep 17 00:00:00 2001
From: Abhishek Kumar <abhishek.mrt22@gmail.com>
Date: Fri, 30 Aug 2024 17:16:10 +0530
Subject: [PATCH] tuning: note on db connection pool

Related to https://github.com/apache/cloudstack/pull/9518

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>
---
 source/adminguide/tuning.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/source/adminguide/tuning.rst b/source/adminguide/tuning.rst
index f304efd6e5..ae7450ef77 100644
--- a/source/adminguide/tuning.rst
+++ b/source/adminguide/tuning.rst
@@ -91,6 +91,25 @@ at `MySQL Reference
 Manual <http://dev.mysql.com/doc/refman/5.5/en/innodb-buffer-pool.html>`_.
 
 
+Selecting Database Connection Pool Library
+------------------------------------------
+
+CloudStack uses JDBC connection pool to manage and use database connections
+in an optimal manner. It allows using either
+`HikariCP <https://github.com/brettwooldridge/HikariCP>`_ or
+`DBCP 2 <https://commons.apache.org/dbcp/>`_ based on the preference for
+individual CloudStack databases - cloud, cloud_usage, simulator.
+
+The following settings can be configured in the db.properties configuration
+file for the management server or usage server:
+db.cloud.connectionPoolLib
+db.cloud_usage.connectionPoolLib
+db.simulator.connectionPoolLib
+
+To use DBCP 2, the value for the configuration must be set to 'dbcp'. An
+empty value or 'hikaricp' will allow using HikariCP.
+
+
 Monitor the Database Load
 -------------------------