github/repmgr
1
0
Fork 0
mirror of https://github.com/EnterpriseDB/repmgr.git synced 2026-03-22 22:56:29 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Various improvements and fixes to the pg-backup-api restore section on the docs

Browse Source 
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 <martin.marques@enterprisedb.com>
This commit is contained in:
Martín Marqués
2023-03-14 11:39:22 +01:00
parent 31af938354
commit 9a68206b4a
1 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/cloning-standbys.xml
View File

@@ -234,10 +234,17 @@ description = "Main cluster"
</indexterm>
<para>
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
<ulink url="https://www.enterprisedb.com/docs/supported-open-source/barman/pg-backup-api/">the pg-backup-api
documentation</ulink>.
</para>
<para>
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.
</para>
<para>
@@ -269,15 +276,15 @@ description = "Main cluster"
<note>
<simpara>
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.
</simpara>
</note>
<para>
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:
<programlisting>
$ repmgr -f ~/nodes/node_3/repmgr.conf standby clone -U repmgr -p 6001 -h localhost