repmgr 4.0.0 Documentation

2ndQuadrant Ltd

This is the official documentation of repmgr 4.0.0 for use with PostgreSQL 9.3 - PostgreSQL 10. It describes the functionality supported by the current version of repmgr.

repmgr was developed by 2ndQuadrant along with contributions from other individuals and companies. Contributions from the community are appreciated and welcome - get in touch via github or the mailing list/forum. Multiple 2ndQuadrant customers contribute funding to make repmgr development possible.

2ndQuadrant, a Platinum sponsor of the PostgreSQL project, continues to develop repmgr to meet internal needs and those of customers. Other companies as well as individual developers are welcome to participate in the efforts.


Table of Contents
I. Getting started
1. repmgr overview
2. Installation
3. Quick-start guide
II. repmgr administration manual
4. repmgr configuration
5. Cloning standbys
6. Promoting a standby server with repmgr
7. Following a new primary
8. Performing a switchover with repmgr
9. Using a witness server
10. Event Notifications
11. Upgrading repmgr
III. Using repmgrd
12. Automatic failover with repmgrd
13. repmgrd configuration
14. repmgrd demonstration
15. repmgrd and cascading replication
16. Handling network splits with repmgrd
17. Using a witness server with repmgrd
18. "degraded monitoring" mode
19. Monitoring with repmgrd
20. BDR failover with repmgrd
IV. repmgr command reference
repmgr primary register -- initialise a repmgr installation and register the primary node
repmgr primary unregister -- unregister an inactive primary node
repmgr standby clone -- clone a PostgreSQL standby node from another PostgreSQL node
repmgr standby register -- add a standby's information to the repmgr metadata
repmgr standby unregister -- remove a standby's information from the repmgr metadata
repmgr standby promote -- promote a standby to a primary
repmgr standby follow -- attach a standby to a new primary
repmgr standby switchover -- promote a standby to primary and demote the existing primary to a standby
repmgr witness register -- add a witness node's information to the repmgr metadata
repmgr witness unregister -- remove a witness node's information to the repmgr metadata
repmgr node status -- show overview of a node's basic information and replication status
repmgr node check -- performs some health checks on a node from a replication perspective
repmgr node rejoin -- rejoin a dormant (stopped) node to the replication cluster
repmgr cluster show -- display information about each registered node in the replication cluster
repmgr cluster matrix --  runs repmgr cluster show on each node and summarizes output
repmgr cluster crosscheck -- cross-checks connections between each combination of nodes
repmgr cluster event -- output a formatted list of cluster events
repmgr cluster cleanup -- purge monitoring history
A. Release notes
A.1. Release 4.0.0
B. Verifying digital signatures
B.1. repmgr source code signing key
B.2. repmgr RPM signing key
C. FAQ (Frequently Asked Questions)
C.1. General
C.2. repmgr
C.3. repmgrd
Index