Parameters

Pigsty v4.x configuration overview and module parameter navigation

Use this page to find Pigsty v4.x parameters. For full explanations, read each module’s param page.

The parameter reference pages for the 10 modules below list 375 parameters, including deployment and removal settings and the development addition kafka_jmx_exporter_enabled. See Modules for maturity levels. The 13 native MySQL 8.4 parameters are listed separately.

Module	Groups	Count	Description
`PGSQL`	9	124	PostgreSQL HA cluster configuration
`INFRA`	10	73	Software repository and Victoria-based observability infra
`NODE`	11	74	Node initialization, system tuning, and ops baseline
`ETCD`	2	13	ETCD cluster and removal safeguard parameters
`MINIO`	2	22	Silo deployment, observability, and removal parameters
`REDIS`	2	22	Redis/Valkey deployment and removal parameters
`DOCKER`	1	8	Docker engine parameters
`JUICE`	1	2	JuiceFS instance and cache parameters
`VIBE`	1	18	Code/Jupyter/Node.js/Claude/Codex configuration
`KAFKA`	2	19	Kafka deployment and removal safeguard parameters

Pilot module: native MYSQL 8.4 currently exposes 13 public parameters: 11 for deployment and 2 for protected removal. Fixed ports, paths, software versions, and timers are not public parameters.

Parameter Group Quick View

Module	Major Groups
`PGSQL`	`PG_ID`, `PG_BUSINESS`, `PG_INSTALL`, `PG_BOOTSTRAP`, `PG_PROVISION`, `PG_BACKUP`, `PG_ACCESS`, `PG_MONITOR`, `PG_REMOVE`
`INFRA`	`META`, `CA`, `INFRA_ID`, `REPO`, `INFRA_PACKAGE`, `NGINX`, `DNS`, `VICTORIA`, `PROMETHEUS`, `GRAFANA`
`NODE`	`NODE_ID`, `NODE_DNS`, `NODE_PACKAGE`, `NODE_TUNE`, `NODE_SEC`, `NODE_ADMIN`, `NODE_TIME`, `NODE_VIP` `HAPROXY`, `NODE_EXPORTER`, `VECTOR`
`ETCD`	`ETCD`, `ETCD_REMOVE`
`MINIO`	`MINIO`, `MINIO_REMOVE`
`REDIS`	`REDIS`, `REDIS_REMOVE`
`DOCKER`	`DOCKER`
`JUICE`	`JUICE`
`VIBE`	`VIBE`
`KAFKA`	`KAFKA`, `KAFKA_REMOVE`

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 apply them globally in batches.

Was this page helpful?