Parameters

Pigsty v4.x configuration overview and module parameter navigation

This is the parameter navigation page for Pigsty v4.x, without repeating full explanations for each parameter. For parameter details, please read each module’s param page.

According to current documentation scope, official modules contain about 360 parameters across 10 modules.

Module Parameter Navigation

ModuleGroupsCountDescription
PGSQL9125PostgreSQL HA cluster configuration
INFRA1072Software repository and Victoria-based observability infra
NODE1173Node initialization, system tuning, and ops baseline
ETCD213ETCD cluster and removal safeguard parameters
MINIO221MinIO deployment and removal parameters
REDIS221Redis deployment and removal parameters
FERRET19FerretDB (Mongo API) parameters
DOCKER18Docker engine parameters
JUICE12JuiceFS instance and cache parameters
VIBE116Code/Jupyter/Node.js/Claude configuration

Parameter Group Quick View

ModuleMajor Groups
PGSQLPG_ID, PG_BUSINESS, PG_INSTALL, PG_BOOTSTRAP, PG_PROVISION, PG_BACKUP, PG_ACCESS, PG_MONITOR, PG_REMOVE
INFRAMETA, CA, INFRA_ID, REPO, INFRA_PACKAGE, NGINX, DNS, VICTORIA, PROMETHEUS, GRAFANA
NODENODE_ID, NODE_DNS, NODE_PACKAGE, NODE_TUNE, NODE_SEC, NODE_ADMIN, NODE_TIME, NODE_VIP
HAPROXY, NODE_EXPORTER, VECTOR
ETCDETCD, ETCD_REMOVE
MINIOMINIO, MINIO_REMOVE
REDISREDIS, REDIS_REMOVE
FERRETFERRET
DOCKERDOCKER
JUICEJUICE
VIBEVIBE

Recommendations

  • Read in this order for first deployment: NODE, INFRA, PGSQL
  • In production, always review: *_safeguard, password credentials, ports, and network exposure
  • Validate changes on one cluster first, then roll out globally in batches

Last Modified 2026-02-14: docs(juice): refine JuiceFS config semantics and metric names (0510c97)