From 0e5fc013ee1489c8650da4ffa616d9b0d99a168e Mon Sep 17 00:00:00 2001 From: Dorian Hoxha Date: Tue, 28 Oct 2025 11:27:22 +0100 Subject: [PATCH] [docs] Add example on how to start YSQL Connection Manager in yugabyted reference page --- .../preview/reference/configuration/yugabyted.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/content/preview/reference/configuration/yugabyted.md b/docs/content/preview/reference/configuration/yugabyted.md index 335742c167e5..e79c7ca1c316 100644 --- a/docs/content/preview/reference/configuration/yugabyted.md +++ b/docs/content/preview/reference/configuration/yugabyted.md @@ -1959,6 +1959,22 @@ docker run -d --name yugabytedb-node3 --hostname yugabytedb-node3 --net yb-netwo --base_dir=/home/yugabyte/yb_data --background=false ``` +### Enable YSQL Connection Manager + +To start a YugabyteDB cluster with YSQL Connection Manager, set the [yb-tserver](../../../reference/configuration/yb-tserver/) flag `enable_ysql_conn_mgr` to true. + +When `enable_ysql_conn_mgr` is set, each YB-TServer starts the YSQL Connection Manager process along with the PostgreSQL process. You should see one YSQL Connection Manager process per YB-TServer. + +Because `enable_ysql_conn_mgr` is a preview flag, to use it, add the flag to the [allowed_preview_flags_csv](../../../reference/configuration/yb-tserver/#allowed-preview-flags-csv) list (that is, `allowed_preview_flags_csv=enable_ysql_conn_mgr`). + +For example, to create a single-node cluster with YSQL Connection Manager using [yugabyted](../../../reference/configuration/yugabyted/), use the following command: + +```sh +./bin/yugabyted start --tserver_flags "enable_ysql_conn_mgr=true,allowed_preview_flags_csv={enable_ysql_conn_mgr}" +``` + +To learn more, see the [YSQL Connection Manager](../../../additional-features/connection-manager-ysql/) documentation. + ## Create and manage read replica clusters To create a read replica cluster, you first need an existing YugabyteDB universe; this example assumes a 3-node universe is deployed. Refer to [Create a local multi-node universe](#create-a-local-multi-node-universe).