repmgr 5.3.0 Documentation

EnterpriseDB Corporation

Legal Notice

Abstract

This is the official documentation of repmgr 5.3.0 for use with PostgreSQL 9.4 - PostgreSQL 14.

repmgr is being continually developed and we strongly recommend using the latest version. Please check the repmgr website for details about the current repmgr version as well as the current repmgr documentation.

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

repmgr is fully supported by 2ndQuadrant (EDB)'s 24/7 Production Support. EnterpriseDB Corporation, a Major Sponsor of the PostgreSQL project, continues to maintain repmgr. We welcome participation from other organisations and individual developers.


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. Event Notifications
10. Upgrading repmgr
III. Using repmgrd
11. repmgrd overview
12. Automatic failover with repmgrd
13. repmgrd setup and configuration
14. repmgrd operation
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 running standby to a new upstream node
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 node service — show or execute the system service command to stop/start/restart/reload/promote a node
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
repmgr service status — display information about the status of repmgrd on each node in the cluster
repmgr service pause — Instruct all repmgrd instances in the replication cluster to pause failover operations
repmgr service unpause — Instruct all repmgrd instances in the replication cluster to resume failover operations
repmgr daemon start — Start the repmgrd daemon on the local node
repmgr daemon stop — Stop the repmgrd daemon on the local node
A. Release notes
A.1. Release 5.3.0
A.2. Release 5.2.1
A.3. Release 5.2.0
A.4. Release 5.1.0
A.5. Release 5.0
A.6. Release 4.4
A.7. Release 4.3
A.8. Release 4.2
A.9. Release 4.1.1
A.10. Release 4.1.0
A.11. Release 4.0.6
A.12. Release 4.0.5
A.13. Release 4.0.4
A.14. Release 4.0.3
A.15. Release 4.0.2
A.16. Release 4.0.1
A.17. Release 4.0.0
B. Verifying digital signatures
B.1. repmgr source code signing key
C. FAQ (Frequently Asked Questions)
C.1. General
C.2. repmgr
C.3. repmgrd
D. repmgr package details
D.1. CentOS Packages
D.2. Debian/Ubuntu Packages
D.3. Snapshot packages
D.4. Installing old package versions
D.5. Information for packagers
E. repmgr support
E.1. Reporting Issues
Index