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 | Deploys Silo S3-compatible object storage, suitable for PostgreSQL backups. |
REDIS | Extension | GA | /docs/redis | Redis by default, or Valkey, in standalone, Sentinel, or native-cluster mode with monitoring. |
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. Together, they deliver complete, highly available PostgreSQL services:
PGSQL: Self-healing PostgreSQL clusters with HA, PITR, IaC, SOP, monitoring, and 600 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.
These four modules are usually installed together. You can also use them separately. In practice, only the NODE module is usually mandatory.
Extension Modules
Pigsty provides six extension modules. They add capabilities to PostgreSQL. Core functions do not require them:
MINIO: An S3-compatible object-storage module that deploys Silo and provides PostgreSQL backup integration and monitoring.REDIS: Redis server with standalone/sentinel/cluster production deployment and full monitoring support.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 provide optional PostgreSQL ecosystem capabilities. The count of 10 official modules above does not include them:
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. It supports one node or a three-node single-primary InnoDB Cluster. It remains a PILOT and is not counted among the 10 official modules above. KUBE,VICTORIA,JUPYTER: other pilot modules, currently not open for public use.
Was this page helpful?
Thanks—your feedback helps us improve this page.
What got in the way? (optional)