Getting Started with pgraft (pgElephant Suite)¶

Welcome! This section will help you get up and running with pgraft, part of the unified pgElephant high-availability suite (see also: RAM, RALE, FauxDB).

What is pgraft?¶

pgraft is a PostgreSQL extension that brings production-grade Raft consensus, automatic leader election, crash-safe log replication, and 100% split-brain prevention to distributed PostgreSQL clusters. All configuration and monitoring is unified with the rest of the pgElephant suite.

Quick Navigation¶

• Install pgraft
• Quick Start Guide
• Complete Tutorial
• Configuration Reference
• Cluster Operations

Prerequisites¶

• PostgreSQL 17+ with development headers
• Go 1.21+ for building
• GCC or compatible C compiler
• Basic knowledge of PostgreSQL and distributed systems

Learning Path¶

1. Installation — Get pgraft installed on your system
2. Quick Start — Create your first 3-node cluster
3. Tutorial — Learn all features in depth
4. Configuration — Understand all available settings
5. Operations — Learn monitoring and maintenance

System Requirements¶

Minimum: - CPU: 2 cores per node - RAM: 4GB per node - Disk: 10GB free space per node - Network: Reliable connectivity between nodes

Recommended for Production: - CPU: 4+ cores per node - RAM: 16GB+ per node - Disk: SSD or NVMe storage - Network: 1 Gbps with <10ms latency between nodes

Next Steps¶

• New to pgraft? Start with Installation
• Want to test quickly? Jump to Quick Start
• Need detailed guidance? Check the Complete Tutorial

Support & Community¶

• Documentation: You're reading it!
• Issues: GitHub Issues
• Source Code: GitHub Repository