Repository: zalando/patroni
Pull request #2889 (2023-09-27 17:58:02)

Enhancement to `tox` behave tests
This PR performs a couple changes to behave tests that are run through `tox`:

* Add `etcd3` as a possible DCS. Previously it only ran with `etcd`;
* Add a JSON report. That makes it easier to parse the results.

References: PAT-212.

coveralls: ## Pull Request Test Coverage Report for [Build 6329662716](https://coveralls.io/builds/62941261)

* **0** of **0**   changed or added relevant lines in **0** files are covered.
* No unchanged relevant lines lost coverage.
* Overall coverage remained the same at **99.863%**

---



|  Totals | [![Coverage Status](https://coveralls.io/builds/62941261/badge)](https://coveralls.io/builds/62941261) |
| :-- | --: |
| Change from base [Build 6326988093](https://coveralls.io/builds/62934642): |  0.0% |
| Covered Lines: | 13125 |
| Relevant Lines: | 13143 |

---
##### 💛  - [Coveralls](https://coveralls.io)


Patch:
diff --git a/docs/ENVIRONMENT.rst b/docs/ENVIRONMENT.rst
index e3762aca..f859649d 100644
--- a/docs/ENVIRONMENT.rst
+++ b/docs/ENVIRONMENT.rst
@@ -209,10 +209,10 @@ REST API
 CTL
 ---
 -  **PATRONICTL\_CONFIG\_FILE**: (optional) location of the configuration file.
--  **PATRONI\_CTL\_USERNAME**: (optional) Basic-auth username for accessing protected REST API endpoints. If not provided patronictl will use the value provided for REST API "username" parameter.
--  **PATRONI\_CTL\_PASSWORD**: (optional) Basic-auth password for accessing protected REST API endpoints. If not provided patronictl will use the value provided for REST API "password" parameter.
+-  **PATRONI\_CTL\_USERNAME**: (optional) Basic-auth username for accessing protected REST API endpoints. If not provided :ref:`patronictl` will use the value provided for REST API "username" parameter.
+-  **PATRONI\_CTL\_PASSWORD**: (optional) Basic-auth password for accessing protected REST API endpoints. If not provided :ref:`patronictl` will use the value provided for REST API "password" parameter.
 -  **PATRONI\_CTL\_INSECURE**: (optional) Allow connections to REST API without verifying SSL certs.
--  **PATRONI\_CTL\_CACERT**: (optional) Specifies the file with the CA_BUNDLE file or directory with certificates of trusted CAs to use while verifying REST API SSL certs. If not provided patronictl will use the value provided for REST API "cafile" parameter.
+-  **PATRONI\_CTL\_CACERT**: (optional) Specifies the file with the CA_BUNDLE file or directory with certificates of trusted CAs to use while verifying REST API SSL certs. If not provided :ref:`patronictl` will use the value provided for REST API "cafile" parameter.
 -  **PATRONI\_CTL\_CERTFILE**: (optional) Specifies the file with the client certificate in the PEM format.
 -  **PATRONI\_CTL\_KEYFILE**: (optional) Specifies the file with the client secret key in the PEM format.
 -  **PATRONI\_CTL\_KEYFILE\_PASSWORD**: (optional) Specifies a password for decrypting the client keyfile.
diff --git a/docs/citus.rst b/docs/citus.rst
index 030cf93e..084931df 100644
--- a/docs/citus.rst
+++ b/docs/citus.rst
@@ -57,7 +57,7 @@ clusters that are just logically groupped together using the
 PostgreSQL. Therefore in most cases it is not possible to manage them as a
 single entity.
 
-It results in two major differences in ``patronictl`` behaviour when
+It results in two major differences in :ref:`patronictl` behaviour when
 ``patroni.yaml`` has the ``citus`` section comparing with the usual:
 
 1. The ``list`` and the ``topology`` by default output all members of the Citus
@@ -65,12 +65,12 @@ It results in two major differences in ``patronictl`` behaviour when
    which Citus group they belong to.
 2. For all ``patronictl`` commands the new option is introduced, named
    ``--group``. For some commands the default value for the group might be
-   taken from the ``patroni.yaml``. For example, ``patronictl pause`` will
+   taken from the ``patroni.yaml``. For example, :ref:`patronictl_pause` will
    enable the maintenance mode by default for the ``group`` that is set in the
-   ``citus`` section, but for example for ``patronictl  switchover`` or
-   ``patronictl remove`` the group must be explicitly specified.
+   ``citus`` section, but for example for :ref:`patronictl_switchover` or
+   :ref:`patronictl_remove` the group must be explicitly specified.
 
-An example of ``patronictl list`` output for the Citus cluster::
+An example of :ref:`patronictl_list` output for the Citus cluster::
 
     postgres@coord1:~$ patronictl list demo
     + Citus cluster: demo ----------+--------------+---------+----+-----------+
@@ -115,7 +115,7 @@ the coordinator for the shards hosted on a worker node. The switchover then
 happens while the traffic is kept on the coordinator, and resumes as soon as a
 new primary worker node is ready to accept read-write queries.
 
-An example of ``patronictl switchover`` on the worker cluster::
+An example of :ref:`patronictl_switchover` on the worker cluster::
 
     postgres@coord1:~$ patronictl switchover demo
     + Citus cluster: demo ----------+--------------+---------+----+-----------+
@@ -343,7 +343,7 @@ Citus upgrades and PostgreSQL major upgrades
 
 First, please read about upgrading Citus version in the `documentation`__.
 There is one minor change in the process. When executing upgrade, you have to
-use ``patronictl restart`` instead of ``systemctl restart`` to restart
+use :ref:`patronictl_restart` instead of ``systemctl restart`` to restart
 PostgreSQL.
 
 __ https://docs.citusdata.com/en/latest/admin_guide/upgrading_citus.html
diff --git a/docs/dcs_failsafe_mode.rst b/docs/dcs_failsafe_mode.rst
index e4eb6061..e6ce363e 100644
--- a/docs/dcs_failsafe_mode.rst
+++ b/docs/dcs_failsafe_mode.rst
@@ -60,4 +60,4 @@ F.A.Q.
 
 - How to enable the Failsafe Mode?
 
-  Before enabling the ``failsafe_mode`` please make sure that Patroni version on all members is up-to-date. After that, you can use either the ``PATCH /config`` :ref:`REST API <rest_api>` or ``patronictl edit-config -s failsafe_mode=true``
+  Before enabling the ``failsafe_mode`` please make sure that Patroni version on all members is up-to-date. After that, you can use either the ``PATCH /config`` :ref:`REST API <rest_api>` or :ref:`patronictl edit-config -s failsafe_mode=true <patronictl_edit_config_parameters>`
diff --git a/docs/dynamic_configuration.rst b/docs/dynamic_configuration.rst
index 7f04ce33..a16a2a40 100644
--- a/docs/dynamic_configuration.rst
+++ b/docs/dynamic_configuration.rst
@@ -6,11 +6,20 @@ Dynamic Configuration Settings
 
 Dynamic configuration is stored in the DCS (Distributed Configuration Store) and applied on all cluster nodes.
 
-In order to change the dynamic configuration you can use either ``patronictl edit-config`` tool or Patroni :ref:`REST API <rest_api>`.
+In order to change the dynamic configuration you can use either :ref:`patronictl_edit_config` tool or Patroni :ref:`REST API <rest_api>`.
+
+-  **loop\_wait**: the number of seconds the loop will sleep. Default value: 10, minimum possible value: 1
+-  **ttl**: the TTL to acquire the leader lock (in seconds). Think of it as the length of time before initiation of the automatic failover process. Default value: 30, minimum possible value: 20
+-  **retry\_timeout**: timeout for DCS and PostgreSQL operation retries (in seconds). DCS or network issues shorter than this will not cause Patroni to demote the leader. Default value: 10, minimum possible value: 3
+
+.. warning::
+    when changing values of **loop_wait**, **retry_timeout**, or **ttl** you have to follow the rule:
+
+    .. code-block:: python
+
+        loop_wait + 2 * retry_timeout <= ttl
+
 
--  **loop\_wait**: the number of seconds the loop will sleep. Default value: 10
--  **ttl**: the TTL to acquire the leader lock (in seconds). Think of it as the length of time before initiation of the automatic failover process. Default value: 30
--  **retry\_timeout**: timeout for DCS and PostgreSQL operation retries (in seconds). DCS or network issues shorter than this will not cause Patroni to demote the leader. Default value: 10
 -  **maximum\_lag\_on\_failover**: the maximum bytes a follower may lag to be able to participate in leader election.
 -  **maximum\_lag\_on\_syncnode**: the maximum bytes a synchronous follower may lag before it is considered as an unhealthy candidate and swapped by healthy asynchronous follower. Patroni utilize the max replica lsn if there is more than one follower, otherwise it will use leader's current wal lsn. Default is -1, Patroni will not take action to swap synchronous unhealthy follower when the value is set to 0 or below. Please set the value high enough so Patroni won't swap synchrounous follower fequently during high transaction volume.
 -  **max\_timelines\_history**: maximum number of timeline history items kept in DCS.  Default value: 0. When set to 0, it keeps the full history in DCS.
diff --git a/docs/existing_data.rst b/docs/existing_data.rst
index cb07bfa9..442b0b1c 100644
--- a/docs/existing_data.rst
+++ b/docs/existing_data.rst
@@ -42,12 +42,12 @@ You can find below an overview of steps for converting an existing Postgres clus
 
    #. Start Patroni using the ``patroni`` systemd service unit. It automatically detects that Postgres is already running and starts monitoring the instance.
 
-#. Hand over Postgres "start up procedure" to Patroni. In order to do that you need to restart the cluster members through ``patronictl restart cluster-name member-name`` command. For minimal downtime you might want to split this step into:
+#. Hand over Postgres "start up procedure" to Patroni. In order to do that you need to restart the cluster members through :ref:`patronictl restart cluster-name member-name <patronictl_restart_parameters>` command. For minimal downtime you might want to split this step into:
 
    #. Immediate restart of the standby nodes.
    #. Scheduled restart of the primary node within a maintenance window.
 
-#. If you configured permanent slots in step ``1.2.``, then you should remove them from ``slots`` configuration through ``patronictl edit-config cluster-name member-name`` command once the ``restart_lsn`` of the slots created by Patroni is able to catch up with the ``restart_lsn`` of the original slots for the corresponding members. By removing the slots from ``slots`` configuration you will allow Patroni to drop the original slots from your cluster once they are not needed anymore. You can find below an example query to check the ``restart_lsn`` of a couple slots, so you can compare them:
+#. If you configured permanent slots in step ``1.2.``, then you should remove them from ``slots`` configuration through :ref:`patronictl edit-config cluster-name member-name <patronictl_edit_config_parameters>` command once the ``restart_lsn`` of the slots created by Patroni is able to catch up with the ``restart_lsn`` of the original slots for the corresponding members. By removing the slots from ``slots`` configuration you will allow Patroni to drop the original slots from your cluster once they are not needed anymore. You can find below an example query to check the ``restart_lsn`` of a couple slots, so you can compare them:
 
    .. code-block:: sql
 
@@ -73,7 +73,7 @@ The only possible way to do a major upgrade currently is:
 #. Stop Patroni
 #. Upgrade PostgreSQL binaries and perform `pg_upgrade <https://www.postgresql.org/docs/current/pgupgrade.html>`_ on the primary node
 #. Update patroni.yml
-#. Remove the initialize key from DCS or wipe complete cluster state from DCS. The second one could be achieved by running ``patronictl remove <cluster-name>``. It is necessary because pg_upgrade runs initdb which actually creates a new database with a new PostgreSQL system identifier.
+#. Remove the initialize key from DCS or wipe complete cluster state from DCS. The second one could be achieved by running :ref:`patronictl remove cluster-name <patronictl_remove_parameters>` . It is necessary because pg_upgrade runs initdb which actually creates a new database with a new PostgreSQL system identifier.
 #. If you wiped the cluster state in the previous step, you may wish to copy patroni.dynamic.json from old data dir to the new one.  It will help you to retain some PostgreSQL parameters you had set before.
 #. Start Patroni on the primary node.
 #. Upgrade PostgreSQL binaries, update patroni.yml and wipe the data_dir on standby nodes.
diff --git a/docs/index.rst b/docs/index.rst
index c8f94aaf..f5a4f2d4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -25,6 +25,7 @@ Currently supported PostgreSQL versions: 9.3 to 16.
    installation
    patroni_configuration
    rest_api
+   patronictl
    replica_bootstrap
    replication_modes
    watchdog
diff --git a/docs/patroni_configuration.rst b/docs/patroni_configuration.rst
index ef5ca020..3978e48d 100644
--- a/docs/patroni_configuration.rst
+++ b/docs/patroni_configuration.rst
@@ -15,7 +15,7 @@ There are 3 types of Patroni configuration:
 
 - Global :ref:`dynamic configuration <dynamic_configuration>`.
 	These options are stored in the DCS (Distributed Configuration Store) and applied on all cluster nodes.
-	Dynamic configuration can be set at any time using ``patronictl edit-config`` tool or Patroni :ref:`REST API <rest_api>`.
+	Dynamic configuration can be set at any time using :ref:`patronictl_edit_config` tool or Patroni :ref:`REST API <rest_api>`.
 	If the options changed are not part of the startup configuration, they are applied asynchronously (upon the next wake up cycle)
 	to every node, which gets subsequently reloaded.
 	If the node requires a restart to apply the configuration (for `PostgreSQL parameters <https://www.postgresql.org/docs/current/view-pg-settings.html>`__ with context postmaster, if their values
@@ -24,7 +24,7 @@ There are 3 types of Patroni configuration:
 
 - Local :ref:`configuration file <yaml_configuration>` (patroni.yml).
 	These options are defined in the configuration file and take precedence over dynamic configuration.
-	``patroni.yml`` can be changed and reloaded at runtime (without restart of Patroni) by sending SIGHUP to the Patroni process, performing ``POST /reload`` REST-API request or executing ``patronictl reload``. Local configuration can be either a single YAML file or a directory. When it is a directory, all YAML files in that directory are loaded one by one in sorted order. In case a key is defined in multiple files, the occurrence in the last file takes precedence.
+	``patroni.yml`` can be changed and reloaded at runtime (without restart of Patroni) by sending SIGHUP to the Patroni process, performing ``POST /reload`` REST-API request or executing :ref:`patronictl_reload`. Local configuration can be either a single YAML file or a directory. When it is a directory, all YAML files in that directory are loaded one by one in sorted order. In case a key is defined in multiple files, the occurrence in the last file takes precedence.
 
 - :ref:`Environment configuration <environment>`.
 	It is possible to set/override some of the "Local" configuration parameters with environment variables.
@@ -105,10 +105,10 @@ Changing these parameters require a PostgreSQL restart to take effect, and their
 
 As explained before, Patroni restrict changing their values through :ref:`dynamic configuration <dynamic_configuration>`, which usually consists of:
 
-1. Applying changes through ``patronictl edit-config`` (or via REST API ``/config`` endpoint)
-2. Restarting nodes through ``patronictl restart`` (or via REST API ``/restart`` endpoint)
+1. Applying changes through :ref:`patronictl_edit_config` (or via REST API ``/config`` endpoint)
+2. Restarting nodes through :ref:`patronictl_restart` (or via REST API ``/restart`` endpoint)
 
-**Note:** please keep in mind that you should perform a restart of the PostgreSQL nodes through ``patronictl restart`` command, or via REST API ``/restart`` endpoint. An attempt to restart PostgreSQL by restarting the Patroni daemon, e.g. by executing ``systemctl restart patroni``, can cause a failover to occur in the cluster, if you are restarting the primary node.
+**Note:** please keep in mind that you should perform a restart of the PostgreSQL nodes through :ref:`patronictl_restart` command, or via REST API ``/restart`` endpoint. An attempt to restart PostgreSQL by restarting the Patroni daemon, e.g. by executing ``systemctl restart patroni``, can cause a failover to occur in the cluster, if you are restarting the primary node.
 
 However, as those settings manage shared memory, some extra care should be taken when restarting the nodes:
 
diff --git a/docs/patronictl.rst b/docs/patronictl.rst
new file mode 100644
index 00000000..8b8cfb7e
--- /dev/null
+++ b/docs/patronictl.rst
@@ -0,0 +1,1975 @@
+.. _patronictl:
+
+patronictl
+==========
+
+Patroni has a command-line interface named ``patronictl``, which is used basically to interact with Patroni's REST API and with the DCS. It is intended to make it easier to perform operations in the cluster, and can easily be used by humans or scripts.
+
+.. _patronictl_configuration:
+
+Configuration
+-------------
+
+``patronictl`` uses 3 sections of the configuration:
+
+- **ctl**: how to authenticate against the Patroni REST API, and how to validate the server identity. Refer to :ref:`ctl settings <patronictl_settings>` for more details;
+- **restapi**: how to authenticate against the Patroni REST API, and how to validate the server identity. Only used if ``ctl`` configuration is not enough. ``patronictl`` is mainly interested in ``restapi.authentication`` section (in case ``ctl.authentication`` is missing) and ``restapi.cafile`` setting (in case ``ctl.cacert`` is missing). Refer to :ref:`REST API settings <restapi_settings>` for more details;
+- DCS (e.g. **etcd**): how to contact and authenticate against the DCS used by Patroni.
+
+Those configuration options can come either from environment variables or from a configuration file. Look for the above sections in :ref:`Environment Configuration Settings <environment>` or :ref:`YAML Configuration Settings <yaml_configuration>` to understand how you can set the options for them through environment variables or through a configuration file.
+
+If you opt for using environment variables, it's a straight forward approach. Patronictl will read the environment variables and use their values.
+
+If you opt for using a configuration file, you have different ways to inform ``patronictl`` about the file to be used. By default ``patronictl`` will attempt to load a configuration file named ``patronictl.yaml``, which is expected to be found under either of these paths, according to your system:
+
+- Mac OS X: ``~/Library/Application Support/patroni``
+- Mac OS X (POSIX): ``~/.patroni``
+- Unix: ``~/.config/patroni``
+- Unix (POSIX): ``~/.patroni``
+- Windows (roaming): ``C:\Users\<user>\AppData\Roaming\patroni``
+- Windows (not roaming): ``C:\Users\<user>\AppData\Local\patroni``
+
+You can override that behavior either by:
+
+- Setting the environment variable ``PATRONICTL_CONFIG_FILE`` with the path to a custom configuration file;
+- Using the ``-c`` / ``--config-file`` command-line argument of ``patronictl`` with the path to a custom configuration file.
+
+.. note::
+    If you are running ``patronictl`` in the same host as ``patroni`` daemon is running, you may just use the same configuration file if it contains all the configuration sections required by ``patronictl``.
+
+.. _patronictl_usage:
+
+Usage
+-----
+
+``patronictl`` exposes several handy operations. This section is intended to describe each of them.
+
+Before jumping into each of the sub-commands of ``patronictl``, be aware that ``patronictl`` itself has the following command-line arguments:
+
+``-c`` / ``--config-file``
+    As explained before, used to provide a path to a configuration file for ``patronictl``.
+
+``-d`` / ``--dcs-url`` / ``--dcs``
+    Provide a connection string to the DCS used by Patroni.
+
+    This argument can be used either to override the DCS settings from the ``patronictl`` configuration, or to define it if it's missing in the configuration.
+
+    The value should be in the format ``DCS://HOST:PORT``, e.g. ``etcd3://localhost:2379`` to connect to etcd v3 running on ``localhost``.
+
+``-k`` / ``--insecure``
+    Flag to bypass validation of REST API server SSL certificate.
+
+This is the synopsis for running a command from the ``patronictl``:
+
+.. code:: text
+
+    patronictl [ { -c | --config-file } CONFIG_FILE ]
+      [ { -d | --dcs-url | --dcs } DCS_URL ] 
+      [ { -k | --insecure } ]
+      SUBCOMMAND
+
+.. note::
+
+    This is the syntax for the synopsis:
+
+    - Options between square brackets are optional;
+    - Options between curly brackets represent a "choose one of set" operation;
+    - Options with ``[, ... ]`` can be specified multiple times;
+    - Things written in uppercase represent a literal that should be given a value to.
+
+    We will use this same syntax when describing ``patronictl`` sub-commands in the following sub-sections.
+    Also, when describing sub-commands in the following sub-sections, the commands' synposis should be seen as a replacement for the ``SUBCOMMAND`` in the above synopsis.
+
+In the following sub-sections you can find a description of each command implemented by ``patronictl``. For sake of example, we will use the configuration files present in the GitHub repository of Patroni (files ``postgres0.yml``, ``postgres1.yml`` and ``postgres2.yml``).
+
+.. _patronictl_dsn:
+
+patronictl dsn
+^^^^^^^^^^^^^^
+
+.. _patronictl_dsn_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    dsn
+      [ CLUSTER_NAME ]
+      [ { { -r | --role } { leader | primary | standby-leader | replica | standby | any } | { -m | --member } MEMBER_NAME } ]
+      [ --group CITUS_GROUP ]
+
+.. _patronictl_dsn_description:
+
+Description
+"""""""""""
+
+``patronictl dsn`` gets the connection string for one member of the Patroni cluster.
+
+If multiple members match the parameters of this command, one of them will be chosen, prioritizing the primary node.
+
+.. _patronictl_dsn_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+    If not given, ``patronictl`` will attempt to fetch that from the ``scope`` configuration, if it exists.
+
+``-r`` / ``--role``
+    Choose a member that has the given role.
+
+    Role can be one of:
+
+    - ``leader``: the leader of either a regular Patroni cluster or a standby Patroni cluster; or
+    - ``primary``: the leader of a regular Patroni cluster; or
+    - ``standby-leader``: the leader of a standby Patroni cluster; or
+    - ``replica``: a replica of a Patroni cluster; or
+    - ``standby``: same as ``replica``; or
+    - ``any``: any role. Same as omitting this parameter; or
+
+``-m`` / ``--member``
+    Choose a member of the cluster with the given name.
+
+    ``MEMBER_NAME`` is the name of the member.
+
+``--group``
+    Choose a member that is part of the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+.. _patronictl_dsn_examples:
+
+Examples
+""""""""
+
+Get DSN of the primary node:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml dsn batman -r primary
+    host=127.0.0.1 port=5432
+
+Get DSN of the node named ``postgresql1``:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml dsn batman --member postgresql1
+    host=127.0.0.1 port=5433
+
+.. _patronictl_edit_config:
+
+patronictl edit-config
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. _patronictl_edit_config_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    edit-config
+      [ CLUSTER_NAME ]
+      [ --group CITUS_GROUP ]
+      [ { -q | --quiet } ]
+      [ { -s | --set } CONFIG="VALUE" [, ... ] ]
+      [ { -p | --pg } PG_CONFIG="PG_VALUE" [, ... ] ]
+      [ { --apply | --replace } CONFIG_FILE ]
+      [ --force ]
+
+.. _patronictl_edit_config_description:
+
+Description
+"""""""""""
+
+``patronictl edit-config`` changes the dynamic configuration of the cluster and updates the DCS with that.
+
+.. note::
+    When invoked through a TTY the command attempts to show a diff of the dynamic configuration through a pager. By default, it attempts to use either ``less`` or ``more``. If you want a different pager, set the ``PAGER`` environment variable with the desired one.
+
+.. _patronictl_edit_config_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+    If not given, ``patronictl`` will attempt to fetch that from the ``scope`` configuration, if it exists.
+
+``--group``
+    Change dynamic configuration of the given Citus group.
+    
+    If not given, ``patronictl`` will attempt to fetch that from the ``citus.group`` configuration, if it exists.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+``-q`` / ``--quiet``
+    Flag to skip showing the configuration diff.
+
+``-s`` / ``--set``
+    Set a given dynamic configuration option with a given value.
+
+    ``CONFIG`` is the name of the dynamic configuration path in the YAML tree, with levels joined by ``.`` .
+
+    ``VALUE`` is the value for ``CONFIG``. If it is ``null``, then ``CONFIG`` will be removed from the dynamic configuration.
+
+``-p`` / ``--pg``
+    Set a given dynamic Postgres configuration option with the given value.
+
+    It is essentially a shorthand for ``--s`` / ``--set`` with ``CONFIG`` prepended with ``postgresql.parameters.``.
+
+    ``PG_CONFIG`` is the name of the Postgres configuration to be set.
+
+    ``PG_VALUE`` is the value for ``PG_CONFIG``. If it is ``nulll``, then ``PG_CONFIG`` will be removed from the dynamic configuration.
+
+``--apply``
+    Apply dynamic configuration from the given file.
+
+    It is similar to specifying multiple ``-s`` / ``--set`` options, one for each configuration from ``CONFIG_FILE``.
+
+    ``CONFIG_FILE`` is the path to a file containing the dynamic configuration to be applied, in YAML format. Use ``-`` if you want to read from ``stdin``.
+
+``--replace``
+    Replace the dynamic configuration in the DCS with the dynamic configuration specified in the given file.
+
+    ``CONFIG_FILE`` is the path to a file containing the new dynamic configuration to take effect, in YAML format. Use ``-`` if you want to read from ``stdin``.
+
+``--force``
+    Flag to skip confirmation prompts when changing the dynamic configuration.
+
+    Useful for scripts.
+
+.. _patronictl_edit_config_examples:
+
+Examples
+""""""""
+
+Change ``max_connections`` Postgres GUC:
+
+.. code:: diff
+
+    patronictl -c postgres0.yml edit-config batman --pg max_connections="150" --force
+    ---
+    +++
+    @@ -1,6 +1,8 @@
+    loop_wait: 10
+    maximum_lag_on_failover: 1048576
+    postgresql:
+    +  parameters:
+    +    max_connections: 150
+      pg_hba:
+      - host replication replicator 127.0.0.1/32 md5
+      - host all all 0.0.0.0/0 md5
+
+    Configuration changed
+
+Change ``loop_wait`` and ``ttl`` settings:
+
+.. code:: diff
+
+    patronictl -c postgres0.yml edit-config batman --set loop_wait="15" --set ttl="45" --force
+    ---
+    +++
+    @@ -1,4 +1,4 @@
+    -loop_wait: 10
+    +loop_wait: 15
+    maximum_lag_on_failover: 1048576
+    postgresql:
+      pg_hba:
+    @@ -6,4 +6,4 @@
+      - host all all 0.0.0.0/0 md5
+      use_pg_rewind: true
+    retry_timeout: 10
+    -ttl: 30
+    +ttl: 45
+
+    Configuration changed
+
+Remove ``maximum_lag_on_failover`` setting from dynamic configuration:
+
+.. code:: diff
+
+    patronictl -c postgres0.yml edit-config batman --set maximum_lag_on_failover="null" --force
+    ---
+    +++
+    @@ -1,5 +1,4 @@
+    loop_wait: 10
+    -maximum_lag_on_failover: 1048576
+    postgresql:
+      pg_hba:
+      - host replication replicator 127.0.0.1/32 md5
+
+    Configuration changed
+
+.. _patronictl_failover:
+
+patronictl failover
+^^^^^^^^^^^^^^^^^^^
+
+.. _patronictl_failover_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    failover
+      [ CLUSTER_NAME ]
+      [ --group CITUS_GROUP ]
+      [ { --leader | --primary } LEADER_NAME ]
+      --candidate CANDIDATE_NAME
+      [ --force ]
+
+.. _patronictl_failover_description:
+
+Description
+"""""""""""
+
+``patronictl failover`` performs a manual failover in the cluster.
+
+It is designed to be used when the cluster is not healthy, e.g.:
+
+- There is no leader; or
+- There is no synchronous standby available in a synchronous cluster.
+
+It also allows to fail over to an asynchronous node if synchronous mode is enabled.
+
+.. note::
+    Nothing prevents you from running ``patronictl failover`` in a healthy cluster. However, we recommend using ``patronictl switchover`` in those cases.
+
+.. warning::
+    Triggering a failover can cause data loss depending on how up-to-date the promoted replica is in comparison to the primary.
+
+.. _patronictl_failover_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+    If not given, ``patronictl`` will attempt to fetch that from the ``scope`` configuration, if it exists.
+
+``--group``
+    Perform a failover in the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+``--leader`` / ``--primary``
+    Indicate who is the expected leader at failover time.
+
+    If given, a switchover is performed instead of a failover.
+
+    ``LEADER_NAME`` should match the name of the current leader in the cluster.
+
+    .. warning::
+        This argument is deprecated and will be removed in a future release.
+
+``--candidate``
+    The node to be promoted on failover.
+
+    ``CANDIDATE_NAME`` is the name of the node to be promoted.
+
+``--force``
+    Flag to skip confirmation prompts when performing the failover.
+
+    Useful for scripts.
+
+.. _patronictl_failover_examples:
+
+Examples
+""""""""
+
+Fail over to node ``postgresql2``:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml failover batman --candidate postgresql2 --force
+    Current cluster topology
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB |
+    +-------------+----------------+---------+-----------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  3 |           |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  3 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  3 |         0 |
+    +-------------+----------------+---------+-----------+----+-----------+
+    2023-09-12 11:52:27.50978 Successfully failed over to "postgresql2"
+    + Cluster: batman (7277694203142172922) -+---------+----+-----------+
+    | Member      | Host           | Role    | State   | TL | Lag in MB |
+    +-------------+----------------+---------+---------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Replica | stopped |    |   unknown |
+    | postgresql1 | 127.0.0.1:5433 | Replica | running |  3 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Leader  | running |  3 |           |
+    +-------------+----------------+---------+---------+----+-----------+
+
+.. _patronictl_flush:
+
+patronictl flush
+^^^^^^^^^^^^^^^^
+
+.. _patronictl_flush_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    flush
+      CLUSTER_NAME
+      [ MEMBER_NAME [, ... ] ]
+      { restart | switchover }
+      [ --group CITUS_GROUP ]
+      [ { -r | --role } { leader | primary | standby-leader | replica | standby | any } ]
+      [ --force ]
+
+.. _patronictl_flush_description:
+
+Description
+"""""""""""
+
+``patronictl flush`` discards scheduled events, if any.
+
+.. _patronictl_flush_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+``MEMBER_NAME``
+    Discard scheduled events for the given Patroni member(s).
+
+    Multiple members can be specified. If no members are specified, all of them are considered.
+
+    .. note::
+        Only used if discarding scheduled restart events.
+
+``restart``
+    Discard scheduled restart events.
+
+``switchover``
+    Discard scheduled switchover event.
+
+``--group``
+    Discard scheduled events from the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+``-r`` / ``--role``
+    Discard scheduled events for members that have the given role.
+
+    Role can be one of:
+
+    - ``leader``: the leader of either a regular Patroni cluster or a standby Patroni cluster; or
+    - ``primary``: the leader of a regular Patroni cluster; or
+    - ``standby-leader``: the leader of a standby Patroni cluster; or
+    - ``replica``: a replica of a Patroni cluster; or
+    - ``standby``: same as ``replica``; or
+    - ``any``: any role. Same as omitting this parameter.
+
+    .. note::
+        Only used if discarding scheduled restart events.
+
+``--force``
+    Flag to skip confirmation prompts when performing the flush.
+
+    Useful for scripts.
+
+.. _patronictl_flush_examples:
+
+Examples
+""""""""
+
+Discard a scheduled switchover event:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml flush batman switchover --force
+    Success: scheduled switchover deleted
+
+Discard scheduled restart of all standby nodes:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml flush batman restart -r replica --force
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+---------------------------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB | Scheduled restart         |
+    +-------------+----------------+---------+-----------+----+-----------+---------------------------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  5 |           | 2023-09-12T17:17:00+00:00 |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  5 |         0 | 2023-09-12T17:17:00+00:00 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  5 |         0 | 2023-09-12T17:17:00+00:00 |
+    +-------------+----------------+---------+-----------+----+-----------+---------------------------+
+    Success: flush scheduled restart for member postgresql1
+    Success: flush scheduled restart for member postgresql2
+
+Discard scheduled restart of nodes ``postgresql0`` and ``postgresql1``:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml flush batman postgresql0 postgresql1 restart --force
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+---------------------------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB | Scheduled restart         |
+    +-------------+----------------+---------+-----------+----+-----------+---------------------------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  5 |           | 2023-09-12T17:17:00+00:00 |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  5 |         0 | 2023-09-12T17:17:00+00:00 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  5 |         0 | 2023-09-12T17:17:00+00:00 |
+    +-------------+----------------+---------+-----------+----+-----------+---------------------------+
+    Success: flush scheduled restart for member postgresql0
+    Success: flush scheduled restart for member postgresql1
+
+.. _patronictl_history:
+
+patronictl history
+^^^^^^^^^^^^^^^^^^
+
+.. _patronictl_history_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    history
+      [ CLUSTER_NAME ]
+      [ --group CITUS_GROUP ]
+      [ { -f | --format } { pretty | tsv | json | yaml } ]
+
+.. _patronictl_history_description:
+
+Description
+"""""""""""
+
+``patronictl history`` shows a history of failover and switchover events from the cluster, if any.
+
+The following information is included in the output:
+
+``TL``
+    Postgres timeline at which the event occurred.
+
+``LSN``
+    Postgres LSN at which the event occurred.
+
+``Reason``
+    Reason fetched from the Postgres ``.history`` file.
+
+``Timestamp``
+    Time when the event occurred.
+
+``New Leader``
+    Patroni member that has been promoted during the event.
+
+.. _patronictl_history_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+    If not given, ``patronictl`` will attempt to fetch that from the ``scope`` configuration, if it exists.
+
+``--group``
+    Show history of events from the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+    
+    If not given, ``patronictl`` will attempt to fetch that from the ``citus.group`` configuration, if it exists.
+
+``-f`` / ``--format``
+    How to format the list of events in the output.
+
+    Format can be one of:
+
+    - ``pretty``: prints history as a pretty table; or
+    - ``tsv``: prints history as tabular information, with columns delimited by ``\t``; or
+    - ``json``: prints history in JSON format; or
+    - ``yaml``: prints history in YAML format.
+
+    The default is ``pretty``.
+
+``--force``
+    Flag to skip confirmation prompts when performing the flush.
+
+    Useful for scripts.
+
+.. _patronictl_history_examples:
+
+Examples
+""""""""
+
+Show the history of events:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml history batman
+    +----+----------+------------------------------+----------------------------------+-------------+
+    | TL |      LSN | Reason                       | Timestamp                        | New Leader  |
+    +----+----------+------------------------------+----------------------------------+-------------+
+    |  1 | 24392648 | no recovery target specified | 2023-09-11T22:11:27.125527+00:00 | postgresql0 |
+    |  2 | 50331864 | no recovery target specified | 2023-09-12T11:34:03.148097+00:00 | postgresql0 |
+    |  3 | 83886704 | no recovery target specified | 2023-09-12T11:52:26.948134+00:00 | postgresql2 |
+    |  4 | 83887280 | no recovery target specified | 2023-09-12T11:53:09.620136+00:00 | postgresql0 |
+    +----+----------+------------------------------+----------------------------------+-------------+
+
+Show the history of events in YAML format:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml history batman -f yaml
+    - LSN: 24392648
+      New Leader: postgresql0
+      Reason: no recovery target specified
+      TL: 1
+      Timestamp: '2023-09-11T22:11:27.125527+00:00'
+    - LSN: 50331864
+      New Leader: postgresql0
+      Reason: no recovery target specified
+      TL: 2
+      Timestamp: '2023-09-12T11:34:03.148097+00:00'
+    - LSN: 83886704
+      New Leader: postgresql2
+      Reason: no recovery target specified
+      TL: 3
+      Timestamp: '2023-09-12T11:52:26.948134+00:00'
+    - LSN: 83887280
+      New Leader: postgresql0
+      Reason: no recovery target specified
+      TL: 4
+      Timestamp: '2023-09-12T11:53:09.620136+00:00'
+
+.. _patronictl_list:
+
+patronictl list
+^^^^^^^^^^^^^^^
+
+.. _patronictl_list_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    list
+      [ CLUSTER_NAME [, ... ] ]
+      [ --group CITUS_GROUP ]
+      [ { -e | --extended } ]
+      [ { -t | --timestamp } ]
+      [ { -f | --format } { pretty | tsv | json | yaml } ]
+      [ { -W | { -w | --watch } TIME } ]
+
+.. _patronictl_list_description:
+
+Description
+"""""""""""
+
+``patronictl list`` shows information about Patroni cluster and its members.
+
+The following information is included in the output:
+
+``Cluster``
+    Name of the Patroni cluster.
+
+``Member``
+    Name of the Patroni member.
+
+``Host``
+    Host where the member is located.
+
+``Role``
+    Current role of the member.
+
+    Can be one among:
+
+    * ``Leader``: the current leader of a regular Patroni cluster; or
+    * ``Standby Leader``: the current leader of a Patroni standby cluster; or
+    * ``Sync Standby``: a synchronous standby of a Patroni cluster with synchronous mode enabled; or
+    * ``Replica``: a regular standby of a Patroni cluster.
+
+``State``
+    Current state of Postgres in the Patroni member.
+
+    Some examples among the possible states:
+
+    * ``running``: if Postgres is currently up and running;
+    * ``streaming``: if a replica and Postgres is currently streaming WALs from the primary node;
+    * ``in archive recovery``: if a replica and Postgres is currently fetching WALs from the archive;
+    * ``stopped``: if Postgres had been shut down;
+    * ``crashed``: if Postgres has crashed.
+
+``TL``
+    Current Postgres timeline in the Patroni member.
+
+``Lag in MB``
+    Amount worth of replication lag in megabytes between the Patroni member and its upstream.
+
+Besides that, the following information may be included in the output:
+
+``System identifier``
+    Postgres system identifier.
+
+    .. note::
+        Shown in the table header.
+
+        Only shown if output format is ``pretty``.
+
+``Group``
+    Citus group ID.
+
+    .. note::
+        Shown in the table header.
+
+        Only shown if a Citus cluster.
+
+``Pending restart``
+    ``*`` indicates that the node needs a restart for some Postgres configuration to take effect. An empty value indicates the node does not require a restart.
+
+    .. note::
+        Shown as a member attribute.
+
+        Shown if:
+
+        - Printing in ``pretty`` or ``tsv`` format and with extended output enabled; or
+        - If node requires a restart.
+
+``Scheduled restart``
+    Timestamp at which a restart has been scheduled for the Postgres instance managed by the Patroni member. An empty value indicates there is no scheduled restart for the member.
+
+    .. note::
+        Shown as a member attribute.
+
+        Shown if:
+
+        - Printing in ``pretty`` or ``tsv`` format and with extended output enabled; or
+        - If node has a scheduled restart.
+
+``Tags``
+    Contains tags set for the Patroni member. An empty value indicates that either no tags have been configured, or that they have been configured with default values.
+
+    .. note::
+        Shown as a member attribute.
+
+        Shown if:
+
+        - Printing in ``pretty`` or ``tsv`` format and with extended output enabled; or
+        - If node has any custom tags, or any default tags with non-default values.
+
+``Scheduled switchover``
+    Timestamp at which a switchover has been scheduled for the Patroni cluster, if any.
+
+    .. note::
+        Shown in the table footer.
+
+        Only shown if there is a scheduled switchover, and output format is ``pretty``.
+
+``Maintenance mode``
+
+    If the cluster monitoring is currently paused.
+
+    .. note::
+        Shown in the table footer.
+
+        Only shown if the cluster is paused, and output format is ``pretty``.
+
+.. _patronictl_list_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+    If not given, ``patronictl`` will attempt to fetch that from the ``scope`` configuration, if it exists.
+
+``--group``
+    Show information about members from the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+``-e`` / ``--extended``
+    Show extended information.
+
+    Force showing ``Pending restart``, ``Scheduled restart`` and ``Tags`` attributes, even if their value is empty.
+
+    .. note::
+        Only applies to ``pretty`` and ``tsv`` output formats.
+
+``-t`` / ``--timestamp``
+    Print timestamp before printing information about the cluster and its members.
+
+``-f`` / ``--format``
+    How to format the list of events in the output.
+
+    Format can be one of:
+
+    - ``pretty``: prints history as a pretty table; or
+    - ``tsv``: prints history as tabular information, with columns delimited by ``\t``; or
+    - ``json``: prints history in JSON format; or
+    - ``yaml``: prints history in YAML format.
+
+    The default is ``pretty``.
+
+``-W``
+    Automatically refresh information every 2 seconds.
+
+``-w`` / ``--watch``
+    Automatically refresh information at the specified interval.
+
+    ``TIME`` is the interval between refreshes, in seconds.
+
+.. _patronictl_list_examples:
+
+Examples
+""""""""
+
+Show information about the cluster in pretty format:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml list batman
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB |
+    +-------------+----------------+---------+-----------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  5 |           |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  5 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  5 |         0 |
+    +-------------+----------------+---------+-----------+----+-----------+
+
+Show information about the cluster in pretty format with extended columns:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml list batman -e
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+-----------------+-------------------+------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB | Pending restart | Scheduled restart | Tags |
+    +-------------+----------------+---------+-----------+----+-----------+-----------------+-------------------+------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  5 |           |                 |                   |      |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  5 |         0 |                 |                   |      |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  5 |         0 |                 |                   |      |
+    +-------------+----------------+---------+-----------+----+-----------+-----------------+-------------------+------+
+
+Show information about the cluster in YAML format, with timestamp of execution:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml list batman -f yaml -t
+    2023-09-12 13:30:48
+    - Cluster: batman
+      Host: 127.0.0.1:5432
+      Member: postgresql0
+      Role: Leader
+      State: running
+      TL: 5
+    - Cluster: batman
+      Host: 127.0.0.1:5433
+      Lag in MB: 0
+      Member: postgresql1
+      Role: Replica
+      State: streaming
+      TL: 5
+    - Cluster: batman
+      Host: 127.0.0.1:5434
+      Lag in MB: 0
+      Member: postgresql2
+      Role: Replica
+      State: streaming
+      TL: 5
+
+.. _patronictl_pause:
+
+patronictl pause
+^^^^^^^^^^^^^^^^
+
+.. _patronictl_pause_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    pause
+      [ CLUSTER_NAME ]
+      [ --group CITUS_GROUP ]
+      [ --wait ]
+
+.. _patronictl_pause_description:
+
+Description
+"""""""""""
+
+``patronictl pause`` temporarily puts the Patroni cluster in maintenance mode and disables automatic failover.
+
+.. _patronictl_pause_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+    If not given, ``patronictl`` will attempt to fetch that from the ``scope`` configuration, if it exists.
+
+``--group``
+    Pause the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+    
+    If not given, ``patronictl`` will attempt to fetch that from the ``citus.group`` configuration, if it exists.
+
+``--wait``
+    Wait until all Patroni members are paused before returning control to the caller.
+
+.. _patronictl_pause_examples:
+
+Examples
+""""""""
+
+Put the cluster in maintenance mode, and wait until all nodes have been paused:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml pause batman --wait
+    'pause' request sent, waiting until it is recognized by all nodes
+    Success: cluster management is paused
+
+.. _patronictl_query:
+
+patronictl query
+^^^^^^^^^^^^^^^^
+
+.. _patronictl_query_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    query
+      [ CLUSTER_NAME ]
+      [ --group CITUS_GROUP ]
+      [ { { -r | --role } { leader | primary | standby-leader | replica | standby | any } | { -m | --member } MEMBER_NAME } ]
+      [ { -d | --dbname } DBNAME ]
+      [ { -U | --username } USERNAME ]
+      [ --password ]
+      [ --format { pretty | tsv | json | yaml } ]
+      [ { { -f | --file } FILE_NAME | { -c | --command } SQL_COMMAND } ]
+      [ --delimiter ]
+      [ { -W | { -w | --watch } TIME } ]
+
+.. _patronictl_query_description:
+
+Description
+"""""""""""
+
+``patronictl query`` executes a SQL command or script against a member of the Patroni cluster.
+
+.. _patronictl_query_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+    If not given, ``patronictl`` will attempt to fetch that from the ``scope`` configuration, if it exists.
+
+``--group``
+    Query the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+``-r`` / ``--role``
+    Choose a member that has the given role.
+
+    Role can be one of:
+
+    - ``leader``: the leader of either a regular Patroni cluster or a standby Patroni cluster; or
+    - ``primary``: the leader of a regular Patroni cluster; or
+    - ``standby-leader``: the leader of a standby Patroni cluster; or
+    - ``replica``: a replica of a Patroni cluster; or
+    - ``standby``: same as ``replica``; or
+    - ``any``: any role. Same as omitting this parameter.
+
+``-m`` / ``--member``
+    Choose a member that has the given name.
+
+    ``MEMBER_NAME`` is the name of the member to be picked.
+
+``-d`` / ``--dbname``
+    Database to connect and run the query.
+
+    ``DBNAME`` is the name of the database. If not given, defaults to ``USERNAME``.
+
+``-U`` / ``--username``
+    User to connect to the database.
+
+    ``USERNAME`` name of the user. If not given, defaults to the operating system user running ``patronictl query``.
+
+``--password``
+    Prompt for the password of the connecting user.
+
+    As Patroni uses ``libpq``, alternatively you can create a ``~/.pgpass`` file or set the ``PGPASSWORD`` environment variable.
+
+``--format``
+    How to format the output of the query.
+
+    Format can be one of:
+
+    - ``pretty``: prints query output as a pretty table; or
+    - ``tsv``: prints query output as tabular information, with columns delimited by ``\t``; or
+    - ``json``: prints query output in JSON format; or
+    - ``yaml``: prints query output in YAML format.
+
+    The default is ``tsv``.
+
+``-f`` / ``--file``
+    Use a file as source of commands to run queries.
+
+    ``FILE_NAME`` is the path to the source file.
+
+``-c`` / ``--command``
+    Run the given SQL command in the query.
+
+    ``SQL_COMMAND`` is the SQL command to be executed.
+
+``--delimiter``
+    The delimiter when printing information in ``tsv`` format, or ``\t`` if omitted.
+
+``-W``
+    Automatically re-run the query every 2 seconds.
+
+``-w`` / ``--watch``
+    Automatically re-run the query at the specified interval.
+
+    ``TIME`` is the interval between re-runs, in seconds.
+
+.. _patronictl_query_examples:
+
+Examples
+""""""""
+
+Run a SQL command as ``postgres`` user, and ask for its password:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml query batman -U postgres --password -c "SELECT now()"
+    Password:
+    now
+    2023-09-12 18:10:53.228084+00:00
+
+Run a SQL command as ``postgres`` user, and take password from ``libpq`` environment variable:
+
+.. code:: bash
+
+    $ PGPASSWORD=zalando patronictl -c postgres0.yml query batman -U postgres -c "SELECT now()"
+    now
+    2023-09-12 18:11:37.639500+00:00
+
+Run a SQL command and print in ``pretty`` format every 2 seconds:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml query batman -c "SELECT now()" --format pretty -W
+    +----------------------------------+
+    | now                              |
+    +----------------------------------+
+    | 2023-09-12 18:12:16.716235+00:00 |
+    +----------------------------------+
+    +----------------------------------+
+    | now                              |
+    +----------------------------------+
+    | 2023-09-12 18:12:18.732645+00:00 |
+    +----------------------------------+
+    +----------------------------------+
+    | now                              |
+    +----------------------------------+
+    | 2023-09-12 18:12:20.750573+00:00 |
+    +----------------------------------+
+
+Run a SQL command on database ``test`` and print the output in YAML format:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml query batman -d test -c "SELECT now() AS column_1, 'test' AS column_2" --format yaml
+    - column_1: 2023-09-12 18:14:22.052060+00:00
+      column_2: test
+
+Run a SQL command on member ``postgresql2``:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml query batman -m postgresql2 -c "SHOW port"
+    port
+    5434
+
+Run a SQL command on any of the standbys:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml query batman -r replica -c "SHOW port"
+    port
+    5433
+
+.. _patronictl_reinit:
+
+patronictl reinit
+^^^^^^^^^^^^^^^^^
+
+.. _patronictl_reinit_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    reinit
+      CLUSTER_NAME
+      [ MEMBER_NAME [, ... ] ]
+      [ --group CITUS_GROUP ]
+      [ --wait ]
+      [ --force ]
+
+.. _patronictl_reinit_description:
+
+Description
+"""""""""""
+
+``patronictl reinit`` rebuilds a Postgres standby instance managed by a replica member of the Patroni cluster.
+
+.. _patronictl_reinit_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+``MEMBER_NAME``
+    Name of the replica member for which the Postgres instance will be rebuilt.
+
+    Multiple replica members can be specified. If no members are specified, the command does nothing.
+
+``--group``
+    Rebuild a replica member of the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+``--wait``
+    Wait until the reinitialization of the Postgres standby node(s) is finished.
+
+``--force``
+    Flag to skip confirmation prompts when rebuilding Postgres standby instances.
+
+    Useful for scripts.
+
+.. _patronictl_reinit_examples:
+
+Examples
+""""""""
+
+Request a rebuild of all replica members of the Patroni cluster and immediately return control to the caller:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml reinit batman postgresql1 postgresql2 --force
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB |
+    +-------------+----------------+---------+-----------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  5 |           |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  5 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  5 |         0 |
+    +-------------+----------------+---------+-----------+----+-----------+
+    Success: reinitialize for member postgresql1
+    Success: reinitialize for member postgresql2
+
+Request a rebuild of ``postgresql2`` and wait for it to complete:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml reinit batman postgresql2 --wait --force
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB |
+    +-------------+----------------+---------+-----------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  5 |           |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  5 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  5 |         0 |
+    +-------------+----------------+---------+-----------+----+-----------+
+    Success: reinitialize for member postgresql2
+    Waiting for reinitialize to complete on: postgresql2
+    Reinitialize is completed on: postgresql2
+
+.. _patronictl_reload:
+
+patronictl reload
+^^^^^^^^^^^^^^^^^
+
+.. _patronictl_reload_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    reload
+      CLUSTER_NAME
+      [ MEMBER_NAME [, ... ] ]
+      [ --group CITUS_GROUP ]
+      [ { -r | --role } { leader | primary | standby-leader | replica | standby | any } ]
+      [ --force ]
+
+.. _patronictl_reload_description:
+
+Description
+"""""""""""
+
+``patronictl reload`` requests a reload of local configuration for one or more Patroni members.
+
+It also triggers ``pg_ctl reload`` on the managed Postgres instance, even if nothing has changed.
+
+.. _patronictl_reload_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+``MEMBER_NAME``
+    Request a reload of local configuration for the given Patroni member(s).
+
+    Multiple members can be specified. If no members are specified, all of them are considered.
+
+``--group``
+    Request a reload of members of the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+``-r`` / ``--role``
+    Select members that have the given role.
+
+    Role can be one of:
+
+    - ``leader``: the leader of either a regular Patroni cluster or a standby Patroni cluster; or
+    - ``primary``: the leader of a regular Patroni cluster; or
+    - ``standby-leader``: the leader of a standby Patroni cluster; or
+    - ``replica``: a replica of a Patroni cluster; or
+    - ``standby``: same as ``replica``; or
+    - ``any``: any role. Same as omitting this parameter.
+
+``--force``
+    Flag to skip confirmation prompts when requesting a reload of the local configuration.
+
+    Useful for scripts.
+
+.. _patronictl_reload_examples:
+
+Examples
+""""""""
+
+Request a reload of the local configuration of all members of the Patroni cluster:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml reload batman --force
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB |
+    +-------------+----------------+---------+-----------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  5 |           |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  5 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  5 |         0 |
+    +-------------+----------------+---------+-----------+----+-----------+
+    Reload request received for member postgresql0 and will be processed within 10 seconds
+    Reload request received for member postgresql1 and will be processed within 10 seconds
+    Reload request received for member postgresql2 and will be processed within 10 seconds
+
+.. _patronictl_remove:
+
+patronictl remove
+^^^^^^^^^^^^^^^^^
+
+.. _patronictl_remove_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    remove
+      CLUSTER_NAME
+      [ --group CITUS_GROUP ]
+      [ { -f | --format } { pretty | tsv | json | yaml } ]
+
+.. _patronictl_remove_description:
+
+Description
+"""""""""""
+
+``patronictl remove`` removes information of the cluster from the DCS.
+
+It is an interactive action.
+
+.. warning::
+    This operation will destroy the information of the Patroni cluster from the DCS.
+
+.. _patronictl_remove_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+``--group``
+    Remove information about the Patroni cluster related with the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+``-f`` / ``--format``
+    How to format the list of members in the output when prompting for confirmation.
+
+    Format can be one of:
+
+    - ``pretty``: prints members as a pretty table; or
+    - ``tsv``: prints members as tabular information, with columns delimited by ``\t``; or
+    - ``json``: prints members in JSON format; or
+    - ``yaml``: prints members in YAML format.
+
+    The default is ``pretty``.
+
+.. _patronictl_remove_examples:
+
+Examples
+""""""""
+
+Remove information about Patroni cluster ``batman`` from the DCS:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml remove batman
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB |
+    +-------------+----------------+---------+-----------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  5 |           |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  5 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  5 |         0 |
+    +-------------+----------------+---------+-----------+----+-----------+
+    Please confirm the cluster name to remove: batman
+    You are about to remove all information in DCS for batman, please type: "Yes I am aware": Yes I am aware
+    This cluster currently is healthy. Please specify the leader name to continue: postgresql0
+
+.. _patronictl_restart:
+
+patronictl restart
+^^^^^^^^^^^^^^^^^^
+
+.. _patronictl_restart_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    restart
+      CLUSTER_NAME
+      [ MEMBER_NAME [, ...] ]
+      [ --group CITUS_GROUP ]
+      [ { -r | --role } { leader | primary | standby-leader | replica | standby | any } ]
+      [ --any ]
+      [ --pg-version PG_VERSION ]
+      [ --pending ]
+      [ --timeout TIMEOUT ]
+      [ --scheduled TIMESTAMP ]
+      [ --force ]
+
+.. _patronictl_restart_description:
+
+Description
+"""""""""""
+
+``patronictl restart`` requests a restart of the Postgres instance managed by a member of the Patroni cluster.
+
+The restart can be performed immediately or scheduled for later.
+
+.. _patronictl_restart_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+``--group``
+    Restart the Patroni cluster related with the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+``-r`` / ``--role``
+    Choose members that have the given role.
+
+    Role can be one of:
+
+    - ``leader``: the leader of either a regular Patroni cluster or a standby Patroni cluster; or
+    - ``primary``: the leader of a regular Patroni cluster; or
+    - ``standby-leader``: the leader of a standby Patroni cluster; or
+    - ``replica``: a replica of a Patroni cluster; or
+    - ``standby``: same as ``replica``; or
+    - ``any``: any role. Same as omitting this parameter.
+
+``--any``
+    Restart a single random node among the ones which match the given filters.
+
+``--pg-version``
+    Select only members which version of the managed Postgres instance is older than the given version.
+
+    ``PG_VERSION`` is the Postgres version to be compared.
+
+``--pending``
+    Select only members which are flagged as ``Pending restart``.
+
+``timeout``
+    Abort the restart if it takes more than the specified timeout, and fail over to a replica if the issue is on the primary.
+
+    ``TIMEOUT`` is the amount of seconds to wait before aborting the restart.
+
+``--scheduled``
+    Schedule a restart to occur at the given timestamp.
+
+    ``TIMESTAMP`` is the timestamp when the restart should occur. Specify it in unambiguous format, preferrably with time zone. You can also use the literal ``now`` for the restart to be executed immediately.
+
+``--force``
+    Flag to skip confirmation prompts when requesting the restart operations.
+
+    Useful for scripts.
+
+.. _patronictl_restart_examples:
+
+Examples
+""""""""
+
+Restart all members of the cluster immediately:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml restart batman --force
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB |
+    +-------------+----------------+---------+-----------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  6 |           |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  6 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  6 |         0 |
+    +-------------+----------------+---------+-----------+----+-----------+
+    Success: restart on member postgresql0
+    Success: restart on member postgresql1
+    Success: restart on member postgresql2
+
+Restart a random member of the cluster immediately:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml restart batman --any --force
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB |
+    +-------------+----------------+---------+-----------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  6 |           |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  6 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  6 |         0 |
+    +-------------+----------------+---------+-----------+----+-----------+
+    Success: restart on member postgresql1
+
+Schedule a restart to occur at ``2023-09-13T18:00-03:00``:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml restart batman --scheduled 2023-09-13T18:00-03:00 --force
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB |
+    +-------------+----------------+---------+-----------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  6 |           |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  6 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  6 |         0 |
+    +-------------+----------------+---------+-----------+----+-----------+
+    Success: restart scheduled on member postgresql0
+    Success: restart scheduled on member postgresql1
+    Success: restart scheduled on member postgresql2
+
+.. _patronictl_resume:
+
+patronictl resume
+^^^^^^^^^^^^^^^^^
+
+.. _patronictl_resume_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    resume
+      [ CLUSTER_NAME ]
+      [ --group CITUS_GROUP ]
+      [ --wait ]
+
+.. _patronictl_resume_description:
+
+Description
+"""""""""""
+
+``patronictl resume`` takes the Patroni cluster out of maintenance mode and re-enables automatic failover.
+
+.. _patronictl_resume_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+    If not given, ``patronictl`` will attempt to fetch that from the ``scope`` configuration, if it exists.
+
+``--group``
+    Resume the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+    
+    If not given, ``patronictl`` will attempt to fetch that from the ``citus.group`` configuration, if it exists.
+
+``--wait``
+    Wait until all Patroni members are unpaused before returning control to the caller.
+
+.. _patronictl_resume_examples:
+
+Examples
+""""""""
+
+Put the cluster out of maintenance mode:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml resume batman --wait
+    'resume' request sent, waiting until it is recognized by all nodes
+    Success: cluster management is resumed
+
+.. _patronictl_show_config:
+
+patronictl show-config
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. _patronictl_show_config_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    show-config
+      [ CLUSTER_NAME ]
+      [ --group CITUS_GROUP ]
+
+.. _patronictl_show_config_description:
+
+Description
+"""""""""""
+
+``patronictl show-config`` shows the dynamic configuration of the cluster that is stored in the DCS.
+
+.. _patronictl_show_config_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+    If not given, ``patronictl`` will attempt to fetch that from the ``scope`` configuration, if it exists.
+
+``--group``
+    Show dynamic configuration of the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+    
+    If not given, ``patronictl`` will attempt to fetch that from the ``citus.group`` configuration, if it exists.
+
+.. _patronictl_show_config_examples:
+
+Examples
+""""""""
+
+Show dynamic configuration of cluster ``batman``:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml show-config batman
+    loop_wait: 10
+    postgresql:
+      parameters:
+        max_connections: 250
+      pg_hba:
+      - host replication replicator 127.0.0.1/32 md5
+      - host all all 0.0.0.0/0 md5
+      use_pg_rewind: true
+    retry_timeout: 10
+    ttl: 30
+
+.. _patronictl_switchover:
+
+patronictl switchover
+^^^^^^^^^^^^^^^^^^^^^
+
+.. _patronictl_switchover_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    switchover
+      [ CLUSTER_NAME ]
+      [ --group CITUS_GROUP ]
+      [ { --leader | --primary } LEADER_NAME ]
+      --candidate CANDIDATE_NAME
+      [ --force ]
+
+.. _patronictl_switchover_description:
+
+Description
+"""""""""""
+
+``patronictl switchover`` performs a switchover in the cluster.
+
+It is designed to be used when the cluster is healthy, e.g.:
+
+- There is a leader;
+- There are synchronous standbys available in a synchronous cluster.
+
+.. note::
+    If your cluster is unhealthy you might be interested in ``patronictl failover`` instead.
+
+.. _patronictl_switchover_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+    If not given, ``patronictl`` will attempt to fetch that from the ``scope`` configuration, if it exists.
+
+``--group``
+    Perform a switchover in the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+``--leader`` / ``--primary``
+    Indicate who is the leader to be demoted at switchover time.
+
+    ``LEADER_NAME`` should match the name of the current leader in the cluster.
+
+``--candidate``
+    The node to be promoted on switchover, and take the primary role.
+
+    ``CANDIDATE_NAME`` is the name of the node to be promoted.
+
+``--scheduled``
+    Schedule a switchover to occur at the given timestamp.
+
+    ``TIMESTAMP`` is the timestamp when the switchover should occur. Specify it in unambiguous format, preferrably with time zone. You can also use the literal ``now`` for the switchover to be executed immediately.
+
+``--force``
+    Flag to skip confirmation prompts when performing the switchover.
+
+    Useful for scripts.
+
+.. _patronictl_switchover_examples:
+
+Examples
+""""""""
+
+Switch over with node ``postgresql2``:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml switchover batman --leader postgresql0 --candidate postgresql2 --force
+    Current cluster topology
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB |
+    +-------------+----------------+---------+-----------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  6 |           |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  6 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  6 |         0 |
+    +-------------+----------------+---------+-----------+----+-----------+
+    2023-09-13 14:15:23.07497 Successfully switched over to "postgresql2"
+    + Cluster: batman (7277694203142172922) -+---------+----+-----------+
+    | Member      | Host           | Role    | State   | TL | Lag in MB |
+    +-------------+----------------+---------+---------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Replica | stopped |    |   unknown |
+    | postgresql1 | 127.0.0.1:5433 | Replica | running |  6 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Leader  | running |  6 |           |
+    +-------------+----------------+---------+---------+----+-----------+
+
+Schedule a switchover between ``postgresql0`` and ``postgresql2`` to occur at ``2023-09-13T18:00:00-03:00``:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml switchover batman --leader postgresql0 --candidate postgresql2 --scheduled 2023-09-13T18:00-03:00 --force
+    Current cluster topology
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB |
+    +-------------+----------------+---------+-----------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  8 |           |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  8 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  8 |         0 |
+    +-------------+----------------+---------+-----------+----+-----------+
+    2023-09-13 14:18:11.20661 Switchover scheduled
+    + Cluster: batman (7277694203142172922) -+-----------+----+-----------+
+    | Member      | Host           | Role    | State     | TL | Lag in MB |
+    +-------------+----------------+---------+-----------+----+-----------+
+    | postgresql0 | 127.0.0.1:5432 | Leader  | running   |  8 |           |
+    | postgresql1 | 127.0.0.1:5433 | Replica | streaming |  8 |         0 |
+    | postgresql2 | 127.0.0.1:5434 | Replica | streaming |  8 |         0 |
+    +-------------+----------------+---------+-----------+----+-----------+
+    Switchover scheduled at: 2023-09-13T18:00:00-03:00
+                        from: postgresql0
+                        to: postgresql2
+
+.. _patronictl_topology:
+
+patronictl topology
+^^^^^^^^^^^^^^^^^^^
+
+.. _patronictl_topology_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    topology
+      [ CLUSTER_NAME [, ... ] ]
+      [ --group CITUS_GROUP ]
+      [ { -W | { -w | --watch } TIME } ]
+
+.. _patronictl_topology_description:
+
+Description
+"""""""""""
+
+``patronictl topology`` shows information about the Patroni cluster and its members with a tree view approach.
+
+The following information is included in the output:
+
+``Cluster``
+    Name of the Patroni cluster.
+
+    .. note::
+        Shown in the table header.
+
+``System identifier``
+    Postgres system identifier.
+
+    .. note::
+        Shown in the table header.
+
+``Member``
+    Name of the Patroni member.
+
+    .. note::
+        Information in this column is shown as a tree view of members in terms of replication connections.
+
+``Host``
+    Host where the member is located.
+
+``Role``
+    Current role of the member.
+
+    Can be one among:
+
+    * ``Leader``: the current leader of a regular Patroni cluster; or
+    * ``Standby Leader``: the current leader of a Patroni standby cluster; or
+    * ``Sync Standby``: a synchronous standby of a Patroni cluster with synchronous mode enabled; or
+    * ``Replica``: a regular standby of a Patroni cluster.
+
+``State``
+    Current state of Postgres in the Patroni member.
+
+    Some examples among the possible states:
+
+    * ``running``: if Postgres is currently up and running;
+    * ``streaming``: if a replica and Postgres is currently streaming WALs from the primary node;
+    * ``in archive recovery``: if a replica and Postgres is currently fetching WALs from the archive;
+    * ``stopped``: if Postgres had been shut down;
+    * ``crashed``: if Postgres has crashed.
+
+``TL``
+    Current Postgres timeline in the Patroni member.
+
+``Lag in MB``
+    Amount worth of replication lag in megabytes between the Patroni member and its upstream.
+
+Besides that, the following information may be included in the output:
+
+``Group``
+    Citus group ID.
+
+    .. note::
+        Shown in the table header.
+
+        Only shown if a Citus cluster.
+
+``Pending restart``
+    ``*`` indicates the node needs a restart for some Postgres configuration to take effect. An empty value indicates the node does not require a restart.
+
+    .. note::
+        Shown as a member attribute.
+
+        Shown if node requires a restart.
+
+``Scheduled restart``
+    Timestamp at which a restart has been scheduled for the Postgres instance managed by the Patroni member. An empty value indicates there is no scheduled restart for the member.
+
+    .. note::
+        Shown as a member attribute.
+
+        Shown if node has a scheduled restart.
+
+``Tags``
+    Contains tags set for the Patroni member. An empty value indicates that either no tags have been configured, or that they have been configured with default values.
+
+    .. note::
+        Shown as a member attribute.
+
+        Shown if node has any custom tags, or any default tags with non-default values.
+
+``Scheduled switchover``
+    Timestamp at which a switchover has been scheduled for the Patroni cluster, if any.
+
+    .. note::
+        Shown in the table footer.
+
+        Only shown if there is a scheduled switchover.
+
+``Maintenance mode``
+
+    If the cluster monitoring is currently paused.
+
+    .. note::
+        Shown in the table footer.
+
+        Only shown if the cluster is paused.
+
+.. _patronictl_topology_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+    If not given, ``patronictl`` will attempt to fetch that from the ``scope`` configuration, if it exists.
+
+``--group``
+    Show information about members from the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+``-W``
+    Automatically refresh information every 2 seconds.
+
+``-w`` / ``--watch``
+    Automatically refresh information at the specified interval.
+
+    ``TIME`` is the interval between refreshes, in seconds.
+
+.. _patronictl_topology_examples:
+
+Examples
+""""""""
+
+Show topology of the cluster ``batman`` -- ``postgresql1`` and ``postgresql2`` are replicating from ``postgresql0``:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml topology batman
+    + Cluster: batman (7277694203142172922) ---+-----------+----+-----------+
+    | Member        | Host           | Role    | State     | TL | Lag in MB |
+    +---------------+----------------+---------+-----------+----+-----------+
+    | postgresql0   | 127.0.0.1:5432 | Leader  | running   |  8 |           |
+    | + postgresql1 | 127.0.0.1:5433 | Replica | streaming |  8 |         0 |
+    | + postgresql2 | 127.0.0.1:5434 | Replica | streaming |  8 |         0 |
+    +---------------+----------------+---------+-----------+----+-----------+
+
+.. _patronictl_version:
+
+patronictl version
+^^^^^^^^^^^^^^^^^^
+
+.. _patronictl_version_synopsis:
+
+Synopsis
+""""""""
+
+.. code:: text
+
+    version
+      [ CLUSTER_NAME [, ... ] ]
+      [ MEMBER_NAME [, ... ] ]
+      [ --group CITUS_GROUP ]
+
+.. _patronictl_version_description:
+
+Description
+"""""""""""
+
+``patronictl version`` gets the version of ``patronictl`` application. Besides that it may also include version information about Patroni clusters and their members.
+
+.. _patronictl_version_parameters:
+
+Parameters
+""""""""""
+
+``CLUSTER_NAME``
+    Name of the Patroni cluster.
+
+``MEMBER_NAME``
+    Name of the member of the Patroni cluster.
+
+``--group``
+    Consider a Patroni cluster with the given Citus group.
+
+    ``CITUS_GROUP`` is the ID of the Citus group.
+
+.. _patronictl_version_examples:
+
+Examples
+""""""""
+
+Get version of ``patronictl`` only:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml version
+    patronictl version 3.1.0
+
+Get version of ``patronictl`` and of all members of cluster ``batman``:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml version batman
+    patronictl version 3.1.0
+
+    postgresql0: Patroni 3.1.0 PostgreSQL 15.2
+    postgresql1: Patroni 3.1.0 PostgreSQL 15.2
+    postgresql2: Patroni 3.1.0 PostgreSQL 15.2
+
+Get version of ``patronictl`` and of members ``postgresql1`` and ``postgresql2`` of cluster ``batman``:
+
+.. code:: bash
+
+    $ patronictl -c postgres0.yml version batman postgresql1 postgresql2
+    patronictl version 3.1.0
+
+    postgresql1: Patroni 3.1.0 PostgreSQL 15.2
+    postgresql2: Patroni 3.1.0 PostgreSQL 15.2
diff --git a/docs/pause.rst b/docs/pause.rst
index 60a01a4c..9a74a2e0 100644
--- a/docs/pause.rst
+++ b/docs/pause.rst
@@ -32,6 +32,6 @@ When Patroni runs in a paused mode, it does not change the state of PostgreSQL,
 User guide
 ----------
 
-``patronictl`` supports ``pause`` and ``resume`` commands.
+``patronictl`` supports :ref:`pause <patronictl_pause>` and :ref:`resume <patronictl_resume>` commands.
 
 One can also issue a ``PATCH`` request to the ``{namespace}/{cluster}/config`` key with ``{"pause": true/false/null}``
diff --git a/docs/replica_bootstrap.rst b/docs/replica_bootstrap.rst
index 42a7d3b0..5ae53103 100644
--- a/docs/replica_bootstrap.rst
+++ b/docs/replica_bootstrap.rst
@@ -191,7 +191,7 @@ There is no further relationship between the standby cluster and the primary
 cluster it replicates from, in particular, they must not share the same DCS
 scope if they use the same DCS. They do not know anything else from each other
 apart from replication information. Also, the standby cluster is not being
-displayed in ``patronictl list`` or ``patronictl topology`` output on the
+displayed in :ref:`patronictl_list` or :ref:`patronictl_topology` output on the
 primary cluster.
 
 For the sake of flexibility, you can specify methods of creating a replica and
diff --git a/docs/rest_api.rst b/docs/rest_api.rst
index 52d417ec..00272100 100644
--- a/docs/rest_api.rst
+++ b/docs/rest_api.rst
@@ -3,7 +3,7 @@
 Patroni REST API
 ================
 
-Patroni has a rich REST API, which is used by Patroni itself during the leader race, by the ``patronictl`` tool in order to perform failovers/switchovers/reinitialize/restarts/reloads, by HAProxy or any other kind of load balancer to perform HTTP health checks, and of course could also be used for monitoring. Below you will find the list of Patroni REST API endpoints.
+Patroni has a rich REST API, which is used by Patroni itself during the leader race, by the :ref:`patronictl` tool in order to perform failovers/switchovers/reinitialize/restarts/reloads, by HAProxy or any other kind of load balancer to perform HTTP health checks, and of course could also be used for monitoring. Below you will find the list of Patroni REST API endpoints.
 
 Health check endpoints
 ----------------------
@@ -619,9 +619,9 @@ In the JSON body of the ``POST`` request you must specify the ``candidate`` fiel
 	:ref:`Be very careful <failover_healthcheck>` when using this endpoint, as this can cause data loss in certain situations. In most cases, :ref:`the switchover endpoint <switchover_api>` satisfies the administrator's needs. 
 
 
-``POST /switchover`` and ``POST /failover`` endpoints are used by ``patronictl switchover`` and ``patronictl failover``, respectively.
+``POST /switchover`` and ``POST /failover`` endpoints are used by :ref:`patronictl_switchover` and :ref:`patronictl_failover`, respectively.
 
-``DELETE /switchover`` is used by ``patronictl flush <cluster-name> switchover``.
+``DELETE /switchover`` is used by :ref:`patronictl flush cluster-name switchover <patronictl_flush_parameters>`.
 
 .. list-table:: Failover/Switchover comparison
    :widths: 25 25 25
@@ -680,15 +680,15 @@ Restart endpoint
 
 - ``DELETE /restart``: delete the scheduled restart
 
-``POST /restart`` and ``DELETE /restart`` endpoints are used by ``patronictl restart`` and ``patronictl flush <cluster-name> restart`` respectively.
+``POST /restart`` and ``DELETE /restart`` endpoints are used by :ref:`patronictl_restart` and :ref:`patronictl flush cluster-name restart <patronictl_flush_parameters>` respectively.
 
 
 Reload endpoint
 ---------------
 
-The ``POST /reload`` call will order Patroni to re-read and apply the configuration file. This is the equivalent of sending the ``SIGHUP`` signal to the Patroni process. In case you changed some of the Postgres parameters which require a restart (like **shared_buffers**), you still have to explicitly do the restart of Postgres by either calling the ``POST /restart`` endpoint or with the help of ``patronictl restart``.
+The ``POST /reload`` call will order Patroni to re-read and apply the configuration file. This is the equivalent of sending the ``SIGHUP`` signal to the Patroni process. In case you changed some of the Postgres parameters which require a restart (like **shared_buffers**), you still have to explicitly do the restart of Postgres by either calling the ``POST /restart`` endpoint or with the help of :ref:`patronictl_restart`.
 
-The reload endpoint is used by ``patronictl reload``.
+The reload endpoint is used by :ref:`patronictl_reload`.
 
 
 Reinitialize endpoint
@@ -698,4 +698,4 @@ Reinitialize endpoint
 
 The call might fail if Patroni is in a loop trying to recover (restart) a failed Postgres. In order to overcome this problem one can specify ``{"force":true}`` in the request body.
 
-The reinitialize endpoint is used by ``patronictl reinit``.
+The reinitialize endpoint is used by :ref:`patronictl_reinit`.
diff --git a/docs/security.rst b/docs/security.rst
index cddefe0c..24af168e 100644
--- a/docs/security.rst
+++ b/docs/security.rst
@@ -9,7 +9,7 @@ A Patroni cluster has two interfaces to be protected from unauthorized access: t
 Protecting DCS
 ==============
 
-Patroni and patronictl both store and retrieve data to/from the DCS.
+Patroni and :ref:`patronictl` both store and retrieve data to/from the DCS.
 
 Despite DCS doesn't contain any sensitive information, it allows changing some of Patroni/Postgres configuration. Therefore the very first thing that should be protected is DCS itself.
 
@@ -22,7 +22,7 @@ Protecting the REST API
 
 Protecting the REST API is a more complicated task.
 
-The Patroni REST API is used by Patroni itself during the leader race, by the ``patronictl`` tool in order to perform failovers/switchovers/reinitialize/restarts/reloads, by HAProxy or any other kind of load balancer to perform HTTP health checks, and of course could also be used for monitoring.
+The Patroni REST API is used by Patroni itself during the leader race, by the :ref:`patronictl` tool in order to perform failovers/switchovers/reinitialize/restarts/reloads, by HAProxy or any other kind of load balancer to perform HTTP health checks, and of course could also be used for monitoring.
 
 From the point of view of security, REST API contains safe (``GET`` requests, only retrieve information) and unsafe (``PUT``, ``POST``, ``PATCH`` and ``DELETE`` requests, change the state of nodes) endpoints.
 
@@ -32,6 +32,6 @@ When TLS for the REST API is enabled and a PKI is established, mutual authentica
 
 The ``restapi`` section parameters enable TLS client authentication to the server. Depending on the value of the ``verify_client`` parameter, the API server requires a successful client certificate verification for both safe and unsafe API calls (``verify_client: required``), or only for unsafe API calls (``verify_client: optional``), or for no API calls (``verify_client: none``).
 
-The ``ctl`` section parameters enable TLS server authentication to the client (the ``patronictl`` tool which uses the same config as patroni). Set ``insecure: true`` to disable the server certificate verification by the client. See :ref:`settings <patronictl_settings>` for a detailed description of the TLS client parameters.
+The ``ctl`` section parameters enable TLS server authentication to the client (the :ref:`patronictl` tool which uses the same config as patroni). Set ``insecure: true`` to disable the server certificate verification by the client. See :ref:`settings <patronictl_settings>` for a detailed description of the TLS client parameters.
 
 Protecting the PostgreSQL database proper from unauthorized access is beyond the scope of this document and is covered in https://www.postgresql.org/docs/current/client-authentication.html
diff --git a/docs/yaml_configuration.rst b/docs/yaml_configuration.rst
index d9283192..4c2ed7c0 100644
--- a/docs/yaml_configuration.rst
+++ b/docs/yaml_configuration.rst
@@ -34,7 +34,7 @@ Bootstrap configuration
 .. note::
     Once Patroni has initialized the cluster for the first time and settings have been stored in the DCS, all future
     changes to the ``bootstrap.dcs`` section of the YAML configuration will not take any effect! If you want to change
-    them please use either ``patronictl edit-config`` or the Patroni :ref:`REST API <rest_api>`.
+    them please use either :ref:`patronictl_edit_config` or the Patroni :ref:`REST API <rest_api>`.
 
 -  **bootstrap**:
 
@@ -366,10 +366,10 @@ CTL
 
    -  **authentication**:
 
-      -  **username**: Basic-auth username for accessing protected REST API endpoints. If not provided patronictl will use the value provided for REST API "username" parameter.
-      -  **password**: Basic-auth password for accessing protected REST API endpoints. If not provided patronictl will use the value provided for REST API "password" parameter.
+      -  **username**: Basic-auth username for accessing protected REST API endpoints. If not provided :ref:`patronictl` will use the value provided for REST API "username" parameter.
+      -  **password**: Basic-auth password for accessing protected REST API endpoints. If not provided :ref:`patronictl` will use the value provided for REST API "password" parameter.
    -  **insecure**: Allow connections to REST API without verifying SSL certs.
-   -  **cacert**: Specifies the file with the CA_BUNDLE file or directory with certificates of trusted CAs to use while verifying REST API SSL certs. If not provided patronictl will use the value provided for REST API "cafile" parameter.
+   -  **cacert**: Specifies the file with the CA_BUNDLE file or directory with certificates of trusted CAs to use while verifying REST API SSL certs. If not provided :ref:`patronictl` will use the value provided for REST API "cafile" parameter.
    -  **certfile**: Specifies the file with the client certificate in the PEM format.
    -  **keyfile**: Specifies the file with the client secret key in the PEM format.
    -  **keyfile\_password**: Specifies a password for decrypting the client keyfile.
@@ -397,4 +397,4 @@ In addition to these predefined tags, you can also add your own ones:
 -  **key3**: ``1.4``
 -  **key4**: ``"RandomString"``
 
-Tags are visible in the :ref:`REST API <rest_api>` and ``patronictl list`` You can also check for an instance health using these tags. If the tag isn't defined for an instance, or if the respective value doesn't match the querying value, it will return HTTP Status Code 503.
+Tags are visible in the :ref:`REST API <rest_api>` and :ref:`patronictl_list` You can also check for an instance health using these tags. If the tag isn't defined for an instance, or if the respective value doesn't match the querying value, it will return HTTP Status Code 503.
diff --git a/features/dcs_failsafe_mode.feature b/features/dcs_failsafe_mode.feature
index 4a34b754..8345d8ea 100644
--- a/features/dcs_failsafe_mode.feature
+++ b/features/dcs_failsafe_mode.feature
@@ -4,8 +4,8 @@ Feature: dcs failsafe mode
   Scenario: check failsafe mode can be successfully enabled
     Given I start postgres0
     And postgres0 is a leader after 10 seconds
-    And I sleep for 3 seconds
-    When I issue a PATCH request to http://127.0.0.1:8008/config with {"loop_wait": 2, "ttl": 20, "retry_timeout": 5, "failsafe_mode": true}
+    Then "config" key in DCS has ttl=30 after 10 seconds
+    When I issue a PATCH request to http://127.0.0.1:8008/config with {"loop_wait": 2, "ttl": 20, "retry_timeout": 3, "failsafe_mode": true}
     Then I receive a response code 200
     And Response on GET http://127.0.0.1:8008/failsafe contains postgres0 after 10 seconds
     When I issue a GET request to http://127.0.0.1:8008/failsafe
@@ -28,7 +28,6 @@ Feature: dcs failsafe mode
     When I do a backup of postgres0
     And I shut down postgres0
     When I start postgres1 in a cluster batman from backup with no_leader
-    And I sleep for 2 seconds
     Then postgres1 role is the replica after 12 seconds
 
   Scenario: check leader and replica are both in /failsafe key after leader is back
@@ -59,12 +58,12 @@ Feature: dcs failsafe mode
     Given DCS is down
     And I kill postgres1
     And I kill postmaster on postgres1
-    And I sleep for 2 seconds
     Then postgres0 role is the replica after 12 seconds
 
   @dcs-failsafe
   Scenario: check known replica is promoted when leader is down and DCS is up
-    Given I shut down postgres0
+    Given I kill postgres0
+    And I shut down postmaster on postgres0
     And DCS is up
     When I start postgres1
     Then "members/postgres1" key in DCS has state=running after 10 seconds
diff --git a/features/environment.py b/features/environment.py
index e3c21252..79db5d16 100644
--- a/features/environment.py
+++ b/features/environment.py
@@ -162,9 +162,10 @@ class PatroniController(AbstractController):
 
     def stop(self, kill=False, timeout=15, postgres=False):
         if postgres:
-            return subprocess.call(['pg_ctl', '-D', self._data_dir, 'stop', '-mi', '-w'])
+            mode = 'i' if kill else 'f'
+            return subprocess.call(['pg_ctl', '-D', self._data_dir, 'stop', '-m' + mode, '-w'])
         super(PatroniController, self).stop(kill, timeout)
-        if isinstance(self._context.dcs_ctl, KubernetesController):
+        if isinstance(self._context.dcs_ctl, KubernetesController) and not kill:
             self._context.dcs_ctl.delete_pod(self._name[8:])
         if self.watchdog:
             self.watchdog.stop()
diff --git a/features/standby_cluster.feature b/features/standby_cluster.feature
index 7ff07679..ac6bbb85 100644
--- a/features/standby_cluster.feature
+++ b/features/standby_cluster.feature
@@ -53,15 +53,22 @@ Feature: standby cluster
     And I receive a response replication_state streaming
     And postgres1 does not have a logical replication slot named test_logical
 
+  Scenario: check switchover
+    When I run patronictl.py switchover batman1 --force
+    And I issue a GET request to http://127.0.0.1:8010/standby_leader
+    Then I receive a response code 200
+    And I receive a response role standby_leader
+    And postgres1 is replicating from postgres2 after 32 seconds
+
   Scenario: check failover
-    When I kill postgres1
-    And I kill postmaster on postgres1
-    Then postgres2 is replicating from postgres0 after 32 seconds
-    When I issue a GET request to http://127.0.0.1:8010/primary
+    When I kill postgres2
+    And I kill postmaster on postgres2
+    Then postgres1 is replicating from postgres0 after 32 seconds
+    When I issue a GET request to http://127.0.0.1:8009/primary
     Then I receive a response code 503
     And I sleep for 3 seconds
-    When I issue a GET request to http://127.0.0.1:8010/standby_leader
+    When I issue a GET request to http://127.0.0.1:8009/standby_leader
     Then I receive a response code 200
     And I receive a response role standby_leader
-    And replication works from postgres0 to postgres2 after 15 seconds
-    And there is a postgres2_cb.log with "on_start replica batman1\non_role_change standby_leader batman1" in postgres2 data directory
+    And replication works from postgres0 to postgres1 after 15 seconds
+    And there is a postgres1_cb.log with "on_start replica batman1\non_role_change standby_leader batman1" in postgres1 data directory
diff --git a/features/steps/basic_replication.py b/features/steps/basic_replication.py
index 6718cb01..5977eb61 100644
--- a/features/steps/basic_replication.py
+++ b/features/steps/basic_replication.py
@@ -35,11 +35,16 @@ def kill_patroni(context, name):
     return context.pctl.stop(name, kill=True)
 
 
-@step('I kill postmaster on {name:w}')
+@step('I shut down postmaster on {name:w}')
 def stop_postgres(context, name):
     return context.pctl.stop(name, postgres=True)
 
 
+@step('I kill postmaster on {name:w}')
+def kill_postgres(context, name):
+    return context.pctl.stop(name, kill=True, postgres=True)
+
+
 @step('I add the table {table_name:w} to {pg_name:w}')
 def add_table(context, table_name, pg_name):
     # parse the configuration file and get the port
diff --git a/features/steps/cascading_replication.py b/features/steps/cascading_replication.py
index 9783fbae..c6b43f31 100644
--- a/features/steps/cascading_replication.py
+++ b/features/steps/cascading_replication.py
@@ -28,7 +28,7 @@ def check_member(context, name, key, value, time_limit):
     while time.time() < max_time:
         try:
             response = json.loads(context.dcs_ctl.query(name))
-            dcs_value = response.get(key)
+            dcs_value = str(response.get(key))
             if dcs_value == value:
                 return
         except Exception:
diff --git a/features/steps/standby_cluster.py b/features/steps/standby_cluster.py
index 17d635b8..a428130c 100644
--- a/features/steps/standby_cluster.py
+++ b/features/steps/standby_cluster.py
@@ -34,6 +34,7 @@ def start_patroni_standby_cluster(context, name, cluster_name, name2):
                 "ttl": 20,
                 "loop_wait": 2,
                 "retry_timeout": 5,
+                "synchronous_mode": True,  # should be completely ignored
                 "standby_cluster": {
                     "host": "localhost",
                     "port": port,
diff --git a/patroni/config.py b/patroni/config.py
index fee2147a..5779aaac 100644
--- a/patroni/config.py
+++ b/patroni/config.py
@@ -96,8 +96,8 @@ class GlobalConfig(object):
 
     @property
     def is_synchronous_mode(self) -> bool:
-        """``True`` if synchronous replication is requested."""
-        return self.check_mode('synchronous_mode')
+        """``True`` if synchronous replication is requested and it is not a standby cluster config."""
+        return self.check_mode('synchronous_mode') and not self.is_standby_cluster
 
     @property
     def is_synchronous_mode_strict(self) -> bool:
@@ -400,6 +400,66 @@ class Config(object):
                     except Exception:
                         logger.error('Can not remove temporary file %s', tmpfile)
 
+    def __get_and_maybe_adjust_int_value(self, config: Dict[str, Any], param: str, min_value: int) -> int:
+        """Get, validate and maybe adjust a *param* integer value from the *config* :class:`dict`.
+
+        .. note:
+            If the value is smaller than provided *min_value* we update the *config*.
+
+            This method may raise an exception if value isn't :class:`int` or cannot be casted to :class:`int`.
+
+        :param config: :class:`dict` object with new global configuration.
+        :param param: name of the configuration parameter we want to read/validate/adjust.
+        :param min_value: the minimum possible value that a given *param* could have.
+
+        :returns: an integer value which corresponds to a provided *param*.
+        """
+        value = int(config.get(param, self.__DEFAULT_CONFIG[param]))
+        if value < min_value:
+            logger.warning("%s=%d can't be smaller than %d, adjusting...", param, value, min_value)
+            value = config[param] = min_value
+        return value
+
+    def _validate_and_adjust_timeouts(self, config: Dict[str, Any]) -> None:
+        """Validate and adjust ``loop_wait``, ``retry_timeout``, and ``ttl`` values if necessary.
+
+        Minimum values:
+
+            * ``loop_wait``: 1 second;
+            * ``retry_timeout``: 3 seconds.
+            * ``ttl``: 20 seconds;
+
+        Maximum values:
+        In case if values don't fulfill the following rule, ``retry_timeout`` and ``loop_wait``
+        are reduced so that the rule is fulfilled:
+
+            .. code-block:: python
+
+                loop_wait + 2 * retry_timeout <= ttl
+
+        .. note:
+            We prefer to reduce ``loop_wait`` and will reduce ``retry_timeout`` only if ``loop_wait``
+            is already set to a minimal possible value.
+
+        :param config: :class:`dict` object with new global configuration.
+        """
+
+        min_loop_wait = 1
+        loop_wait = self. __get_and_maybe_adjust_int_value(config, 'loop_wait', min_loop_wait)
+        retry_timeout = self. __get_and_maybe_adjust_int_value(config, 'retry_timeout', 3)
+        ttl = self. __get_and_maybe_adjust_int_value(config, 'ttl', 20)
+
+        if min_loop_wait + 2 * retry_timeout > ttl:
+            config['loop_wait'] = min_loop_wait
+            config['retry_timeout'] = (ttl - min_loop_wait) // 2
+            logger.warning('Violated the rule "loop_wait + 2*retry_timeout <= ttl", where ttl=%d. '
+                           'Adjusting loop_wait from %d to %d and retry_timeout from %d to %d',
+                           ttl, loop_wait, min_loop_wait, retry_timeout, config['retry_timeout'])
+        elif loop_wait + 2 * retry_timeout > ttl:
+            config['loop_wait'] = ttl - 2 * retry_timeout
+            logger.warning('Violated the rule "loop_wait + 2*retry_timeout <= ttl", where ttl=%d and retry_timeout=%d.'
+                           ' Adjusting loop_wait from %d to %d', ttl, retry_timeout, loop_wait, config['loop_wait'])
+
     # configuration could be either ClusterConfig or dict
     def set_dynamic_configuration(self, configuration: Union[ClusterConfig, Dict[str, Any]]) -> bool:
         """Set dynamic configuration values with given *configuration*.
@@ -417,6 +477,7 @@ class Config(object):
 
         if not deep_compare(self._dynamic_configuration, configuration):
             try:
+                self._validate_and_adjust_timeouts(configuration)
                 self.__effective_configuration = self._build_effective_configuration(configuration,
                                                                                      self._local_configuration)
                 self._dynamic_configuration = configuration
diff --git a/tox.ini b/tox.ini
index bf66caef..21688937 100644
--- a/tox.ini
+++ b/tox.ini
@@ -125,10 +125,11 @@ commands =
         --file features/Dockerfile
 allowlist_externals = docker
 
-[testenv:pg{12,13,14,15,16}-docker-behave-{etcd}-{lin,mac}]
+[testenv:pg{12,13,14,15,16}-docker-behave-{etcd,etcd3}-{lin,mac}]
 description = Run behaviour tests in patroni-dev docker container
 setenv =
     etcd: DCS=etcd
+    etcd3: DCS=etcd3
     {[common]postgres_matrix}
     CONTAINER_NAME = tox-{env_name}-{env:PYTHONHASHSEED}
 labels =
@@ -149,7 +150,7 @@ commands =
         --tty \
         {env:PATRONI_DEV_IMAGE:patroni-dev:{env:PG_MAJOR}} \
         tox run -x 'tox.env_list=py{[common]python_matrix}-behave-{env:DCS}-lin' \
-        -- --format plain {posargs}
+        -- {posargs}
 
 allowlist_externals =
     docker
@@ -159,7 +160,7 @@ platform =
 ;    win: win32
     mac: darwin
 
-[testenv:py{36,38,39,310,311}-behave-{etcd}-{lin,win,mac}]
+[testenv:py{36,38,39,310,311}-behave-{etcd,etcd3}-{lin,win,mac}]
 description = Run behaviour tests (locally with tox)
 deps =
     -r requirements.txt
@@ -167,11 +168,15 @@ deps =
     coverage
     {[common]psycopg_deps}
 setenv =
-    DCS = {env:DCS:etcd}
+    etcd: DCS = {env:DCS:etcd}
+    etcd3: DCS = {env:DCS:etcd3}
 passenv =
     ETCD_UNSUPPORTED_ARCH
 commands =
-    python3 -m behave {posargs}
+    python3 -m behave --format json --format plain --outfile result.json {posargs}
+    mv result.json features/output
+allowlist_externals =
+    mv
 platform =
     {[common]platforms}
 


Test patch:
diff --git a/tests/test_config.py b/tests/test_config.py
index f0a780bc..2b21f589 100644
--- a/tests/test_config.py
+++ b/tests/test_config.py
@@ -5,7 +5,7 @@ import io
 
 from copy import deepcopy
 from mock import MagicMock, Mock, patch
-from patroni.config import Config, ConfigParseError
+from patroni.config import Config, ConfigParseError, GlobalConfig
 
 
 class TestConfig(unittest.TestCase):
@@ -173,3 +173,32 @@ class TestConfig(unittest.TestCase):
         input_params['max_connections'] = 10
         expected_params.pop('max_connections')
         self.assertEqual(self.config._process_postgresql_parameters(input_params), expected_params)
+
+    def test__validate_and_adjust_timeouts(self):
+        with patch('patroni.config.logger.warning') as mock_logger:
+            self.config._validate_and_adjust_timeouts({'ttl': 15})
+            self.assertEqual(mock_logger.call_args_list[0][0],
+                             ("%s=%d can't be smaller than %d, adjusting...", 'ttl', 15, 20))
+        with patch('patroni.config.logger.warning') as mock_logger:
+            self.config._validate_and_adjust_timeouts({'loop_wait': 0})
+            self.assertEqual(mock_logger.call_args_list[0][0],
+                             ("%s=%d can't be smaller than %d, adjusting...", 'loop_wait', 0, 1))
+        with patch('patroni.config.logger.warning') as mock_logger:
+            self.config._validate_and_adjust_timeouts({'retry_timeout': 1})
+            self.assertEqual(mock_logger.call_args_list[0][0],
+                             ("%s=%d can't be smaller than %d, adjusting...", 'retry_timeout', 1, 3))
+        with patch('patroni.config.logger.warning') as mock_logger:
+            self.config._validate_and_adjust_timeouts({'ttl': 20, 'loop_wait': 11, 'retry_timeout': 5})
+            self.assertEqual(mock_logger.call_args_list[0][0],
+                             ('Violated the rule "loop_wait + 2*retry_timeout <= ttl", where ttl=%d '
+                              'and retry_timeout=%d. Adjusting loop_wait from %d to %d', 20, 5, 11, 10))
+        with patch('patroni.config.logger.warning') as mock_logger:
+            self.config._validate_and_adjust_timeouts({'ttl': 20, 'loop_wait': 10, 'retry_timeout': 10})
+            self.assertEqual(mock_logger.call_args_list[0][0],
+                             ('Violated the rule "loop_wait + 2*retry_timeout <= ttl", where ttl=%d. Adjusting'
+                              ' loop_wait from %d to %d and retry_timeout from %d to %d', 20, 10, 1, 10, 9))
+
+    def test_global_config_is_synchronous_mode(self):
+        # we should ignore synchronous_mode setting in a standby cluster
+        config = {'standby_cluster': {'host': 'some_host'}, 'synchronous_mode': True}
+        self.assertFalse(GlobalConfig(config).is_synchronous_mode)