Welcome to pg_auto_failover’s documentation!¶
The pg_auto_failover project is an Open Source Software project. The development happens at https://github.com/citusdata/pg_auto_failover and is public: everyone is welcome to participate by opening issues or pull requests, giving feedback, etc.
Remember that the first steps are to actually play with the pg_autoctl command, then read the entire available documentation (after all, I took the time to write it), and then to address the community in a kind and polite way — the same way you would expect people to use when addressing you.
Note
The development of pg_auto_failover has been driven by Citus Data, since then a team at Microsoft. The Citus Data team at Microsoft generously maintains the pg_auto_failover Open Source Software so that its users may continue using it in production.
For enhancements, improvements, and new features, consider contributing to the project. Pull Requests are reviewed as part of the offered maintenance.
Note
Assistance is provided as usual with Open Source projects, on a voluntary basis. If you need help to cook a patch, enhance the documentation, or even to use the software, you’re welcome to ask questions and expect some level of free guidance.
- Introduction to pg_auto_failover
- Main pg_autoctl commands
- pg_auto_failover Tutorial
- Azure VMs Tutorial
- Architecture Basics
- Multi-node Architectures
- Citus Support
- Citus Cluster Quick Start
- Failover State Machine
- Failover and Fault Tolerance
- Installing pg_auto_failover
- Security settings for pg_auto_failover
- Manual Pages
- pg_autoctl
- pg_autoctl create
- pg_autoctl drop
- pg_autoctl config
- pg_autoctl show
- pg_autoctl enable
- pg_autoctl disable
- pg_autoctl get
- pg_autoctl set
- pg_autoctl perform
- pg_autoctl do
- pg_autoctl run
- pg_autoctl watch
- pg_autoctl stop
- pg_autoctl reload
- pg_autoctl status
- pg_autoctl activate
- Configuring pg_auto_failover
- Operating pg_auto_failover
- Deployment
- Provisioning
- Postgres configuration management
- Upgrading pg_auto_failover, from versions 1.4 onward
- Upgrading from previous pg_auto_failover versions
- Extension dependencies when upgrading the monitor
- Cluster Management and Operations
- Current state, last events
- Monitoring pg_auto_failover in Production
- Replacing the monitor online
- Trouble-Shooting Guide
- Frequently Asked Questions
- I stopped the primary and no failover is happening for 20s to 30s, why?
- The secondary is blocked in the CATCHING_UP state, what should I do?
- Should I read the logs? Where are the logs?
- The state of the system is blocked, what should I do?
- Impossible / unresolveable state after crash - How to recover?
- The monitor is a SPOF in pg_auto_failover design, how should we handle that?