From b74f965f548a0be6058a04202c269bbf937ffca3 Mon Sep 17 00:00:00 2001 From: Ian Barwick Date: Fri, 18 Oct 2019 14:44:57 +0900 Subject: [PATCH] standby clone: rename --recovery-conf-only to --replication-conf-only A more generic option name to cover pre- and post-Pg12 replication configuration methods. --recovery-conf-only is retained as an alias for backwards compatibility. --- doc/appendix-faq.xml | 2 +- doc/appendix-release-notes.xml | 30 ++++++++++++++++++++++++++++++ doc/cloning-standbys.xml | 5 +++-- doc/repmgr-standby-clone.xml | 14 +++++++------- doc/repmgr-standby-register.xml | 2 +- repmgr-action-standby.c | 8 ++++---- repmgr-client-global.h | 2 +- repmgr-client.c | 6 +++--- repmgr-client.h | 6 ++++-- 9 files changed, 54 insertions(+), 21 deletions(-) diff --git a/doc/appendix-faq.xml b/doc/appendix-faq.xml index 4e5c46e4..0f98b21f 100644 --- a/doc/appendix-faq.xml +++ b/doc/appendix-faq.xml @@ -245,7 +245,7 @@ For a standby which has been manually cloned or recovered from an external backup manager such as Barman, the command - repmgr standby clone --recovery-conf-only + repmgr standby clone --replication-conf-only can be used to create the correct recovery.conf file for use with &repmgr; (and will create a replication slot if required). Once this has been done, register the node as usual. diff --git a/doc/appendix-release-notes.xml b/doc/appendix-release-notes.xml index c5a2e0e5..b3a4e377 100644 --- a/doc/appendix-release-notes.xml +++ b/doc/appendix-release-notes.xml @@ -17,6 +17,36 @@ + + Release 5.1.0 + ?? ?? ??, 20?? + + + &repmgr; 5.1.0 is a major release. + + + For details on how to upgrade an existing &repmgr; installation, see + documentation section Upgrading a major version release. + + + If &repmgrd; is in use, a PostgreSQL restart is required; + in that case we suggest combining this &repmgr; upgrade with the next PostgreSQL + minor release, which will require a PostgreSQL restart in any case. + + + + + Compatibility changes + + The repmgr standby clone + option has been renamed to + . will + still be accepted as an alias. + + + + + Release 5.0 Tue 15 October, 2019 diff --git a/doc/cloning-standbys.xml b/doc/cloning-standbys.xml index b01cf59b..b99fbda7 100644 --- a/doc/cloning-standbys.xml +++ b/doc/cloning-standbys.xml @@ -64,8 +64,9 @@ Barman's parallel restore facility can be used by executing it manually on - the Barman server and integrating the resulting cloned standby using - repmgr standby clone --recovery-conf-only. + the Barman server and configuring replication on the resulting cloned + standby using + repmgr standby clone --replication-conf-only. diff --git a/doc/repmgr-standby-clone.xml b/doc/repmgr-standby-clone.xml index 4aecc331..11d274e1 100644 --- a/doc/repmgr-standby-clone.xml +++ b/doc/repmgr-standby-clone.xml @@ -188,18 +188,18 @@ - + Using a standby cloned by another method - recovery.conf + replication configuration generating for a standby cloned by another method - replication configuration + recovery.conf generating for a standby cloned by another method @@ -224,7 +224,7 @@ - Then execute the command repmgr standby clone --recovery-conf-only. + Then execute the command repmgr standby clone --replication-conf-only. This will create the recovery.conf file needed to attach the node to its upstream (in PostgreSQL 12 and later: append replication configuration to postgresql.auto.conf), and will also create a replication slot on the @@ -236,7 +236,7 @@ option is provided. - Execute repmgr standby clone --recovery-conf-only --dry-run + Execute repmgr standby clone --replication-conf-only --dry-run 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. @@ -266,7 +266,7 @@ Check prerequisites but don't actually clone the standby. - If specified, the contents of + If specified, the contents of the generated recovery configuration will be displayed but not written. @@ -312,7 +312,7 @@ - + Create recovery configuration for a previously cloned instance. diff --git a/doc/repmgr-standby-register.xml b/doc/repmgr-standby-register.xml index 40f9f75f..74ea9c38 100644 --- a/doc/repmgr-standby-register.xml +++ b/doc/repmgr-standby-register.xml @@ -111,7 +111,7 @@ barman recover command), register the node as detailed in section then execute - repmgr standby clone --recovery-conf-only + repmgr standby clone --replication-conf-only to generate the appropriate replication configuration. diff --git a/repmgr-action-standby.c b/repmgr-action-standby.c index 99ebbb2c..de3c3530 100644 --- a/repmgr-action-standby.c +++ b/repmgr-action-standby.c @@ -142,7 +142,7 @@ static bool parse_data_directory_config(const char *node_check_output); * -R/--remote-user * --replication-user (only required if no upstream record) * --without-barman - * --recovery-conf-only + * --replication-conf-only (--recovery-conf-only) */ void @@ -159,9 +159,9 @@ do_standby_clone(void) initialize_conninfo_params(&recovery_conninfo, false); /* - * --recovery-conf-only provided - we'll handle that separately + * --replication-conf-only provided - we'll handle that separately */ - if (runtime_options.recovery_conf_only == true) + if (runtime_options.replication_conf_only == true) { return _do_create_recovery_conf(); } @@ -7908,7 +7908,7 @@ do_standby_help(void) " when the intended upstream server does not yet exist\n")); printf(_(" --upstream-node-id ID of the upstream node to replicate from (optional, defaults to primary node)\n")); printf(_(" --without-barman do not use Barman even if configured\n")); - printf(_(" --recovery-conf-only generate replication configuration for a previously cloned instance\n")); + printf(_(" --replication-conf-only generate replication configuration for a previously cloned instance\n")); puts(""); diff --git a/repmgr-client-global.h b/repmgr-client-global.h index c9e262b2..1a5884b5 100644 --- a/repmgr-client-global.h +++ b/repmgr-client-global.h @@ -85,7 +85,7 @@ typedef struct char replication_user[MAXLEN]; char upstream_conninfo[MAXLEN]; bool without_barman; - bool recovery_conf_only; + bool replication_conf_only; /* "standby clone"/"standby follow" options */ int upstream_node_id; diff --git a/repmgr-client.c b/repmgr-client.c index 6c7e84d9..646a5259 100644 --- a/repmgr-client.c +++ b/repmgr-client.c @@ -431,8 +431,8 @@ main(int argc, char **argv) runtime_options.without_barman = true; break; - case OPT_RECOVERY_CONF_ONLY: - runtime_options.recovery_conf_only = true; + case OPT_REPLICATION_CONF_ONLY: + runtime_options.replication_conf_only = true; break; @@ -1705,7 +1705,7 @@ check_cli_parameters(const int action) } } - if (runtime_options.recovery_conf_only == true) + if (runtime_options.replication_conf_only == true) { switch (action) { diff --git a/repmgr-client.h b/repmgr-client.h index 96208491..d054739b 100644 --- a/repmgr-client.h +++ b/repmgr-client.h @@ -89,7 +89,7 @@ #define OPT_WAIT_START 1034 #define OPT_REPL_CONN 1035 #define OPT_REMOTE_NODE_ID 1036 -#define OPT_RECOVERY_CONF_ONLY 1037 +#define OPT_REPLICATION_CONF_ONLY 1037 #define OPT_NO_WAIT 1038 #define OPT_MISSING_SLOTS 1039 #define OPT_REPMGRD_NO_PAUSE 1040 @@ -157,7 +157,9 @@ static struct option long_options[] = {"upstream-conninfo", required_argument, NULL, OPT_UPSTREAM_CONNINFO}, {"upstream-node-id", required_argument, NULL, OPT_UPSTREAM_NODE_ID}, {"without-barman", no_argument, NULL, OPT_WITHOUT_BARMAN}, - {"recovery-conf-only", no_argument, NULL, OPT_RECOVERY_CONF_ONLY}, + {"replication-conf-only", no_argument, NULL, OPT_REPLICATION_CONF_ONLY}, + /* deprecate this once Pg11 and earlier are unsupported */ + {"recovery-conf-only", no_argument, NULL, OPT_REPLICATION_CONF_ONLY}, /* "standby register" options */ {"wait-start", required_argument, NULL, OPT_WAIT_START},