Skip to content

PIGSTY v5.0 · DOCUMENTATION PREVIEW

PostgreSQL In Great STYle

A free, open-source, battery-included, local-first enterprise PostgreSQL distribution and RDS alternative.

Built with OINK 0.6.0 and focused on Pigsty foundations and first-party module manuals.

Read the Docs Quick Start

DOCUMENTATION SCOPE

An engineering knowledge base for Pigsty itself

4Core Modules
7Optional Modules
575Packaged PG Extensions
0.6.0Pinned OINK Version

CORE CAPABILITIES

A complete delivery path from hosts to database services

The documentation follows real operational workflows, explaining the system design while providing executable configuration, playbooks, and runbooks.

01 / INFRASTRUCTURE AS CODE

Declarative Delivery

◇ Describe the desired state in inventory and converge it with repeatable playbooks

  • Scale smoothly from a single-node sandbox to multi-node production
  • Keep configuration, identity, services, and access policies reviewable
  • Align change procedures with day-to-day administration manuals

Turn database infrastructure into a versioned, reproducible engineering asset.

pigsty.yml
# declare the desired state
$ ./configure -c rich
$ ./deploy.yml
✓ PostgreSQL service ready

02 / HIGH AVAILABILITY

High Availability and PITR

◇ Put failover, backup, archiving, and recovery drills in one coherent system

  • Automatic failure detection and primary failover for PostgreSQL clusters
  • Continuous WAL archiving to local or S3-compatible repositories
  • Recovery workflows for nodes, clusters, and exact points in time

Document failure modes, RTO, RPO, and operating boundaries—not just components.

03 / OBSERVABILITY

Built-in Observability

◇ Organize metrics, logs, alerts, and management interfaces around one resource model

  • Unified monitoring for PostgreSQL, hosts, middleware, and applications
  • Integrated VictoriaMetrics, VictoriaLogs, and Grafana
  • Drill down from fleet summaries to instances, queries, and database objects

Make the system explainable and diagnosable from its first minute in production.

MODULE MANUALS

Compose your data infrastructure by capability

The core PINE modules provide the PostgreSQL RDS foundation; optional modules add storage, caching, messaging, databases, and development environments as needed.

CORE

PGSQL

Highly available PostgreSQL clusters and complete lifecycle management.

Open Manual

CORE

INFRA

Observability, portals, and infrastructure services.

Open Manual

CORE

NODE

Host management, logs, networking, and load balancing.

Open Manual

CORE

ETCD

Distributed configuration storage for high availability.

Open Manual

STORAGE

MINIO / Silo

S3-compatible object storage and backup repository.

Open Manual

CACHE

REDIS / Valkey

Primary-replica, Sentinel, and native clusters.

Open Manual

FILESYSTEM

JUICE

Shared POSIX storage powered by JuiceFS.

Open Manual

MESSAGING

KAFKA

Dynamic KRaft with security and observability.

Open Manual

DEVELOPMENT

VIBE

Browser-based development and AI coding sandbox.

Open Manual

MIGRATION PRINCIPLES

Focused, traceable, and ready to evolve

01

Keep Only Essential Content

Pigsty foundations and module manuals move here; standalone component manuals remain on the existing site.

02

Preserve References

Required references to excluded content become links to the existing site instead of broken internal routes.

03

Separate Version Facts

The v5 documentation preview, current stable release, and historical release records remain distinct.

FAQ

About this documentation migration

Is this the final Pigsty v5.0 release documentation?

This is the v5.0 documentation-site baseline and content migration preview. Installation examples still reference the published stable version, while the v5.0.0 release page remains a draft placeholder until release facts are available.

Why are Pig, Patroni, pgBackRest, and other standalone manuals absent?

This site focuses on Pigsty foundations and first-party modules. Pigsty integration, configuration, and operations remain in the relevant module manuals; standalone component manuals are linked on the existing site.

Why does every release use an x.y.z version?

The Release column follows real Git tags and consistently uses complete semantic version numbers, avoiding ambiguity between forms such as 4.5 and 4.5.0.

Start exploring Pigsty v5.0 with the Quick Start.Understand the architecture and configuration model, then continue into production deployment and module manuals.

Open Documentation