From 9a68206b4a5750465ada5c7207fc12c2e406d940 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=C3=ADn=20Marqu=C3=A9s?= Date: Tue, 14 Mar 2023 11:39:22 +0100 Subject: [PATCH] Various improvements and fixes to the pg-backup-api restore section on the docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I added a paragraph at the beginning of the section on where to look for instructions on how to install the pg-backup-api rest API. Fixed typos and some gramatical changes. Also reworded the first paragraph (which is now the second one). Signed-off-by: Martín Marqués --- doc/cloning-standbys.xml | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/doc/cloning-standbys.xml b/doc/cloning-standbys.xml index 39321ad8..4f4d4b00 100644 --- a/doc/cloning-standbys.xml +++ b/doc/cloning-standbys.xml @@ -234,10 +234,17 @@ description = "Main cluster" - This mode (`pg-backupapi`) was introduced in v5.4.0 as a way to integrate further with Barman and let it - handle all writes. This also reduces the ssh keys you need to share because, as long as you have access to - the API service, you could start to perform recoveries right away. You just need to tell Barman what is - the backup you need and in which node to want it to be restored. + You can find information on how to install and setup pg-backup-api in + the pg-backup-api + documentation. + + + + This mode (`pg-backupapi`) was introduced in v5.4.0 as a way to further integrate with Barman letting Barman + handle the restore. This also reduces the ssh keys that need to share between the backup and postgres nodes. + As long as you have access to the API service by HTTP calls, you could perform recoveries right away. + You just need to instruct Barman through the API which backup you need and on which node the backup needs to + to be restored on. @@ -269,15 +276,15 @@ description = "Main cluster" - Despite in Barman you can define shortcuts ID like "lastest" or "oldest", they are not supported for the - time being in pg-backup-api. This shortcuts will be supported in a future release. + Despite in Barman you can define shortcuts like "lastest" or "oldest", they are not supported for the + time being in pg-backup-api. These shortcuts will be supported in a future release. This is a real example of repmgr's output cloning with the API. Note that during this operation, we stopped the service for a little while and repmgr had to retry but that doesn't affect the final outcome. The primary - is listening to port 6001 upon localhost: + is listening on localhost's port 6001: $ repmgr -f ~/nodes/node_3/repmgr.conf standby clone -U repmgr -p 6001 -h localhost