Pigsty v5.0 Documentation

From core concepts and quick start to production deployment, module references, and day-to-day operations.

Reference

PIGSTY

The Pigsty v5.0 documentation focuses on Pigsty itself: architecture, installation, deployment, configuration, operations, and the complete manual for every first-party module.

v5.0 Docs Preview OINK 0.6.0 Local First

Press ⌘ with K on macOS, or Ctrl with K, to open offline search and the command palette anywhere on the site.

Get Started

About Pigsty

Learn about Pigsty’s features, architecture, design principles, use cases, and project background.

Features · Core Concepts · Architecture · High Availability · Backup & Recovery

Quick Start

Start with a fresh Linux host, configure Pigsty, and complete your first deployment.

Install · Configure · Run Playbooks · Offline Install · Web UI

Production Deployment

Plan capacity, prepare resources, harden security, and deliver a multi-node production environment.

Planning · Preparation · Install · Security · Sandbox

Configuration & Reference

Look up configuration templates, modules, parameters, playbooks, ports, and filesystem conventions.

Config Templates · Modules · Parameters · Playbooks · Ports · File Hierarchy

Core Modules

PGSQLCORE

Highly available PostgreSQL clusters, services, backup, monitoring, security, and daily administration.

INFRACORE

VictoriaMetrics, VictoriaLogs, Grafana, Nginx, and infrastructure services.

NODECORE

Host management, software baselines, log collection, VIP, and HAProxy load balancing.

ETCDCORE

Reliable distributed configuration storage for PostgreSQL high availability.

Optional Modules

MINIO / SiloSTORAGE

S3-compatible object storage and a PostgreSQL backup repository.

REDIS / ValkeyCACHE

Primary-replica, Sentinel, and native cluster modes.

JUICEFILESYSTEM

JuiceFS backed by PostgreSQL metadata and object storage.

KAFKAMESSAGING

Dynamic KRaft, TLS, ACL, and complete observability.

MYSQLDATABASE

MySQL 8.4 LTS and InnoDB Cluster.

DOCKERRUNTIME

A managed Docker service and container runtime.

VIBEDEVELOPMENT

Code-Server, Jupyter, and an AI coding sandbox.

Content Scope

This site does not duplicate the standalone manuals for Pig, Patroni, pg_exporter, pgBackRest, PgBouncer, the software repository, application templates, or pilot projects. When these components must be referenced, the documentation links to the existing site; Pigsty’s own integration, configuration, and operational guidance remains in the relevant module manual.