From f0b12b7e2e5c045d8fc84eee61026a5fb74766bd Mon Sep 17 00:00:00 2001 From: Maxim Ivanov Date: Wed, 30 Jan 2019 11:36:24 +0000 Subject: [PATCH] Document create_replicas_methods in standby_cluster section (#939) Fixes https://github.com/zalando/patroni/issues/935 --- docs/replica_bootstrap.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/replica_bootstrap.rst b/docs/replica_bootstrap.rst index 59006711..cb891a7e 100644 --- a/docs/replica_bootstrap.rst +++ b/docs/replica_bootstrap.rst @@ -177,9 +177,15 @@ standby nodes replicating from some remote master. This type of clusters has: Standby leader holds and updates a leader lock in DCS. If the leader lock expires, cascade replicas will perform an election to choose another leader -from the standbys. For the sake of flexibility, you can specify different -methods of creating a replica and recovery WAL records when a cluster is in the -"standby mode", and after it was detached to function as a normal cluster. +from the standbys. + +For the sake of flexibility, you can specify methods of creating a replica and +recovery WAL records when a cluster is in the "standby mode" by providing +`create_replica_methods` key in `standby_cluster` section. It is distinct from +creating replicas, when cluster is detached and functions as a normal cluster, +which is controlled by `create_replica_methods` in `postgresql` section. Both +"standby" and "normal" `create_replica_methods` reference keys in `postgresql` +section. To configure such cluster you need to specify the section ``standby_cluster`` in a patroni configuration: @@ -192,6 +198,8 @@ in a patroni configuration: host: 1.2.3.4 port: 5432 primary_slot_name: patroni + create_replica_methods: + - basebackup Note, that these options will be applied only once during cluster bootstrap, and the only way to change them afterwards is through DCS.