Welcome to pg_auto_failover’s documentation!

Contents:

• Introduction to pg_auto_failover
• pg_auto_failover Quick Start
  • Install the “pg_autoctl” executable
  • Run a monitor
  • Bring up the nodes
  • Watch the replication
  • Cause a failover
  • Resurrect node A
• pg_auto_failover Architecture
  • The pg_auto_failover Monitor
  • pg_auto_failover Glossary
  • Client-side HA
  • Monitoring protocol
  • Synchronous vs. asynchronous replication
  • Node recovery
  • Failover logic
  • pg_auto_failover keeper’s State Machine
• pg_auto_failover Fault Tolerance
  • Unhealthy Nodes
  • Network Partitions
  • Failure handling and network partition detection
• Installing pg_auto_failover
  • Ubuntu or Debian
    • Quick install
    • Manual Installation
  • Fedora, CentOS, or Red Hat
    • Quick install
    • Manual installation
  • Installing a pgautofailover Systemd unit
• pg_autoctl commands reference
  • pg_autoctl
    • pg_auto_failover Monitor
    • pg_autoctl show command
    • pg_auto_failover Postgres Node Initialization
    • pg_autoctl configuration and state files
    • Running the pg_auto_failover Keeper service
    • Removing a node from the pg_auto_failover monitor
  • pg_autoctl do
• Configuring pg_auto_failover
  • pg_auto_failover Monitor
  • pg_auto_failover Keeper Service
• Operating pg_auto_failover
  • Deployment
  • Provisioning
  • Security
  • Operations
    • Maintenance of a secondary node
    • Triggering a failover
    • Implementing a controlled switchover
  • Current state, last events
  • Monitoring pg_auto_failover in Production
  • Trouble-Shooting Guide
• The pg_auto_failover Finite State Machine
  • Introduction
  • Example of state transitions in a new cluster
  • State reference