Modules
This article lists available Pigsty modules and the current module planning.
Official Modules
| Module | Category | Status | Docs Path | Summary |
|---|---|---|---|---|
PGSQL | Core | GA | /docs/pgsql | High-availability PostgreSQL clusters with built-in backup, monitoring, SOP, and extension ecosystem. |
INFRA | Core | GA | /docs/infra | Local software repository + VictoriaMetrics/Logs/Traces + Grafana infrastructure stack. |
NODE | Core | GA | /docs/node | Node initialization and convergence: system tuning, admin, HAProxy, Vector, Keepalived, etc. |
ETCD | Core | GA | /docs/etcd | DCS for PostgreSQL HA (service discovery, config, leader-election metadata). |
MINIO | Extension | GA | /docs/minio | S3-compatible object storage, optionally used as PostgreSQL backup repository. |
REDIS | Extension | GA | /docs/redis | Redis standalone/sentinel/cluster deployment and monitoring. |
FERRET | Extension | GA | /docs/ferret | FerretDB module (MONGO API compatibility) for MongoDB protocol access over PG. |
DOCKER | Extension | GA | /docs/docker | Docker daemon and the runtime capability for containerized apps. |
JUICE | Extension | BETA | /docs/juice | JuiceFS distributed file system using PostgreSQL as metadata engine. |
VIBE | Extension | BETA | /docs/vibe | Browser-based dev environment with Code-Server, JupyterLab, Node.js, Claude Code, and Codex CLI. |
KAFKA | Extension | BETA | /docs/kafka | Apache Kafka 4.x dynamic KRaft cluster deployment, security baseline, and monitoring. |
Core Modules
Pigsty provides four core modules that are important for delivering complete highly available PostgreSQL services:
PGSQL: Self-healing PostgreSQL clusters with HA, PITR, IaC, SOP, monitoring, and 562 extensions.INFRA: Local software repository, VictoriaMetrics, VictoriaLogs, VictoriaTraces, Grafana, Alertmanager, Blackbox Exporter…NODE: Node convergence for hostname, timezone, NTP, SSH, sudo, HAProxy, Vector, and Keepalived.ETCD: Distributed key-value store used as DCS for HA PostgreSQL clusters: consensus leader election/config management/service discovery.
Although these four modules are usually installed together, separate use is still feasible. In practice, only the NODE module is usually mandatory.
Extension Modules
Pigsty provides seven extension modules. They are not mandatory for core functionality, but can enhance PostgreSQL capabilities:
MINIO: S3-compatible object storage, optional PostgreSQL backup repository, with production deployment and monitoring support.REDIS: Redis server with standalone/sentinel/cluster production deployment and full monitoring support.MONGO: Native FerretDB deployment support, adding MongoDB wire-protocol compatible APIs to PostgreSQL.DOCKER: Docker daemon service for one-click deployment of stateless software templates on Pigsty.JUICE: JuiceFS distributed filesystem module using PostgreSQL as metadata engine, providing shared POSIX storage.VIBE: Browser-based development environment with Code-Server, JupyterLab, Node.js, Claude Code, and Codex CLI.KAFKA: Apache Kafka 4.x dynamic KRaft clusters with TLS/SCRAM/ACL security baseline, declarative topics/users, and full monitoring.
Ecosystem Modules
The modules below are closely related to the PostgreSQL ecosystem. They are optional ecosystem capabilities and are not counted in the 11 official modules above:
SUPABASE,DUCKDB: peripheral ecosystem integration.MSSQL,IVORY,POLAR,CITUS,CLOUDBERRY,PGEDGE: kernel replacement, distributed, and MPP forms.MYSQL-compatible kernel (OpenHalo),ORIOLE,PGTDE,AGENS: protocol compatibility, storage engine, transparent encryption, and graph database kernels. Here,MYSQLmeans thepg_mode=mysqlPostgreSQL-compatible kernel, not a native MySQL service.GREENPLUM,NEON: historical docs retained, no longer default public capabilities.- Native
MYSQLpilot: the currentmysql.yml,mysql-rm.yml, androles/mysql*manage a fixed native MySQL 8.4 platform with either one node or a three-node single-primary InnoDB Cluster. It remains a PILOT and is not counted among the 11 official modules above. KUBE,VICTORIA,JUPYTER: other pilot modules, currently not open for public use.
Feedback
Was this page helpful?
Thanks for the feedback! Please let us know how we can improve.
Sorry to hear that. Please let us know how we can improve.