From 588df5da05d9631d6df5465fc90033c792916e70 Mon Sep 17 00:00:00 2001 From: Chris Bandy Date: Wed, 11 Oct 2023 01:41:11 -0500 Subject: [PATCH] Refine the documentation about custom_conf (#2901) some back icks in this section needed to be balanced. --- docs/patroni_configuration.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/patroni_configuration.rst b/docs/patroni_configuration.rst index 3978e48d..e18c118e 100644 --- a/docs/patroni_configuration.rst +++ b/docs/patroni_configuration.rst @@ -70,15 +70,16 @@ There also are some parameters like **postgresql.listen**, **postgresql.data_dir When applying the local or dynamic configuration options, the following actions are taken: -- The node first checks if there is a `postgresql.base.conf` or if the ``custom_conf`` parameter is set. -- If the ``custom_conf`` parameter is set, it will take the file specified on it as a base configuration, ignoring `postgresql.base.conf` and `postgresql.conf`. -- If the ``custom_conf`` parameter is not set and `postgresql.base.conf` exists, it contains the renamed "original" configuration and it will be used as a base configuration. -- If there is no ``custom_conf``` nor `postgresql.base.conf`, the original `postgresql.conf`` is taken and renamed to postgresql.base.conf. -- The dynamic options (with the exceptions above) are dumped into the `postgresql.conf`` and an include is set in - postgresql.conf to the used base configuration (either `postgresql.base.conf` or what is on ``custom_conf``). Therefore, we would be able to apply new options without re-reading the configuration file to check if the include is present not. +- The node first checks if there is a `postgresql.base.conf` file or if the ``custom_conf`` parameter is set. +- If the ``custom_conf`` parameter is set, the file it specifies is used as the base configuration, ignoring `postgresql.base.conf` and `postgresql.conf`. +- If the ``custom_conf`` parameter is not set and `postgresql.base.conf` exists, it contains the renamed "original" configuration and is used as the base configuration. +- If there is no ``custom_conf`` nor `postgresql.base.conf`, the original `postgresql.conf` is renamed to `postgresql.base.conf` and used as the base configuration. +- The dynamic options (with the exceptions above) are dumped into the `postgresql.conf` and an include is set in + `postgresql.conf` to the base configuration (either `postgresql.base.conf` or the file at ``custom_conf``). + Therefore, we would be able to apply new options without re-reading the configuration file to check if the include is present or not. - Some parameters that are essential for Patroni to manage the cluster are overridden using the command line. -- If some of the options that require restart are changed (we should look at the context in pg_settings and at the actual - values of those options), a pending_restart flag of a given node is set. This flag is reset on any restart. +- If an option that requires restart is changed (we should look at the context in pg_settings and at the actual + values of those options), a pending_restart flag is set on that node. This flag is reset on any restart. The parameters would be applied in the following order (run-time are given the highest priority):