From f00826d6e60d2d3dc57141e88654471896715303 Mon Sep 17 00:00:00 2001 From: RMT Date: Wed, 10 Jul 2024 14:16:03 +0800 Subject: [PATCH] Make ``postgresql.parameter`` documentation more clear (#3092) --- docs/dynamic_configuration.rst | 2 +- docs/yaml_configuration.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dynamic_configuration.rst b/docs/dynamic_configuration.rst index b12aac20..44cf4c2b 100644 --- a/docs/dynamic_configuration.rst +++ b/docs/dynamic_configuration.rst @@ -33,7 +33,7 @@ In order to change the dynamic configuration you can use either :ref:`patronictl - **use\_pg\_rewind**: whether or not to use pg_rewind. Defaults to `false`. Note that either the cluster must be initialized with ``data page checksums`` (``--data-checksums`` option for ``initdb``) and/or ``wal_log_hints`` must be set to ``on``, or ``pg_rewind`` will not work. - **use\_slots**: whether or not to use replication slots. Defaults to `true` on PostgreSQL 9.4+. - **recovery\_conf**: additional configuration settings written to recovery.conf when configuring follower. There is no recovery.conf anymore in PostgreSQL 12, but you may continue using this section, because Patroni handles it transparently. - - **parameters**: list of configuration settings for Postgres. + - **parameters**: configuration parameters (GUCs) for Postgres in format ``{max_connections: 100, wal_level: "replica", max_wal_senders: 10, wal_log_hints: "on"}``. Many of these are required for replication to work. - **pg\_hba**: list of lines that Patroni will use to generate ``pg_hba.conf``. Patroni ignores this parameter if ``hba_file`` PostgreSQL parameter is set to a non-default value. diff --git a/docs/yaml_configuration.rst b/docs/yaml_configuration.rst index adedc00f..d90a43fc 100644 --- a/docs/yaml_configuration.rst +++ b/docs/yaml_configuration.rst @@ -300,7 +300,7 @@ PostgreSQL - **pgpass**: path to the `.pgpass `__ password file. Patroni creates this file before executing pg\_basebackup, the post_init script and under some other circumstances. The location must be writable by Patroni. - **recovery\_conf**: additional configuration settings written to recovery.conf when configuring follower. - **custom\_conf** : path to an optional custom ``postgresql.conf`` file, that will be used in place of ``postgresql.base.conf``. The file must exist on all cluster nodes, be readable by PostgreSQL and will be included from its location on the real ``postgresql.conf``. Note that Patroni will not monitor this file for changes, nor backup it. However, its settings can still be overridden by Patroni's own configuration facilities - see :ref:`dynamic configuration ` for details. - - **parameters**: list of configuration settings for Postgres. Many of these are required for replication to work. + - **parameters**: configuration parameters (GUCs) for Postgres in format ``{ssl: "on", ssl_cert_file: "cert_file"}``. - **pg\_hba**: list of lines that Patroni will use to generate ``pg_hba.conf``. Patroni ignores this parameter if ``hba_file`` PostgreSQL parameter is set to a non-default value. Together with :ref:`dynamic configuration ` this parameter simplifies management of ``pg_hba.conf``. - **- host all all 0.0.0.0/0 md5**