From 2ec761a979e3c7ce0f9b816a0bfa09f11863d9fc Mon Sep 17 00:00:00 2001 From: Ian Barwick Date: Thu, 15 Aug 2019 18:07:38 +0900 Subject: [PATCH] doc: update "repmgr standby clone" reference for PostgreSQL 12 Mainly replace "recovery.conf" with the more generic "replication configuration". --- doc/repmgr-standby-clone.xml | 44 ++++++++++++++++++++++++++---------- 1 file changed, 32 insertions(+), 12 deletions(-) diff --git a/doc/repmgr-standby-clone.xml b/doc/repmgr-standby-clone.xml index dcdfe163..e7babc00 100644 --- a/doc/repmgr-standby-clone.xml +++ b/doc/repmgr-standby-clone.xml @@ -18,7 +18,7 @@ repmgr standby clone clones a PostgreSQL node from another PostgreSQL node, typically the primary, but optionally from any other node in - the cluster or from Barman. It creates the recovery.conf file required + the cluster or from Barman. It creates the replication configuration required to attach the cloned node to the primary node (or another standby, if cascading replication is in use). @@ -85,15 +85,20 @@ - Customising recovery.conf + Customising replication configuration recovery.conf customising with "repmgr standby clone" + + replication configuration + customising with "repmgr standby clone" + + - By default, &repmgr; will create a minimal recovery.conf + By default, &repmgr; will create a minimal replication configuration containing following parameters: @@ -119,7 +124,7 @@ The following additional parameters can be specified in repmgr.conf - for inclusion in recovery.conf: + for inclusion in the replication configuration: @@ -193,6 +198,11 @@ generating for a standby cloned by another method + + replication configuration + generating for a standby cloned by another method + + &repmgr; supports standbys cloned by another method (e.g. using barman's barman recover command). @@ -204,18 +214,20 @@ repmgr standby register. Then execute the command repmgr standby clone --recovery-conf-only. This will create the recovery.conf file needed to attach - the node to its upstream, and will also create a replication slot on the + the node to its upstream (in PostgreSQL 12 and later: write replication configuration + to postgresql.auto.conf), and will also create a replication slot on the upstream node if required. - Note that the upstream node must be running. An existing + Note that the upstream node must be running. In PostgreSQL 11 and earlier, an existing recovery.conf will not be overwritten unless the option is provided. Execute repmgr standby clone --recovery-conf-only --dry-run - to check the prerequisites for creating the recovery.conf file, - and display the contents of the file without actually creating it. + to check the prerequisites for creating the recovery configuration, + and display the contents of the configuration which would be added without actually + making any changes. @@ -249,8 +261,8 @@ If specified, the contents of - the generated recovery.conf file will be displayed - but the file itself not written. + the generated recovery configuration will be displayed + but not written. @@ -297,8 +309,16 @@ - Create recovery.conf file for a previously cloned instance. &repmgr; 4.0.4 and later. + Create recovery configuration for a previously cloned instance. &repmgr; 4.0.4 and later. + + In PostgreSQL 11 and earlier, the replication configuration will be + written to recovery.conf. + + + In PostgreSQL 12 and later, the replication configuration will be + written to postgresql.auto.conf. + @@ -326,7 +346,7 @@ - primary_conninfo value to write in recovery.conf + primary_conninfo value to include in the recovery configuration when the intended upstream server does not yet exist.