Parameters
Use inventory parameters to customize infrastructure settings and database configuration.
Parameter List
The files/cmdb.sql defaults define 399 public configuration parameters across 12 Pigsty modules. See Parameter Reference for the complete list.
| Module | Groups | Params | Description |
|---|---|---|---|
| PGSQL | 10 | 125 | PostgreSQL HA clusters, backups, and PITR |
| INFRA | 10 | 73 | Software repositories and Victoria observability infrastructure |
| NODE | 11 | 73 | Node initialization, system tuning, and operations baseline |
| ETCD | 2 | 13 | ETCD cluster and removal protection parameters |
| VAULT | 2 | 8 | OpenBao secrets clusters and removal safeguards |
| 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 | 6 | 68 | Code/Jupyter/Node.js/Claude/Codex configuration |
| KAFKA | 2 | 19 | Kafka deployment and removal-protection parameters |
| MYSQL | 6 | 16 | Native MySQL 8.4 deployment, backups, monitoring, and removal |
| Total | 55 | 399 | Default parameter records in files/cmdb.sql |
cmdb.sqlcombinesINFRA_IDandINFRA_PACKAGEinto one group, giving INFRA 9 groups; documentation splits them into 10 for navigation. NODE also has the platform-derivednode_tuned_profile_dirindefaults/main.yml, so the NODE parameter page lists 74 entries.
Parameter Form
Parameters are key-value pairs that describe entities. A key is a string. A value can be a boolean, string, number, array, or object.
Parameter Priority
Set parameters at these levels, listed from highest to lowest priority:
| Level | Location | Description | Priority |
|---|---|---|---|
| CLI | -e command line argument | Passed via command line | Highest (5) |
| Host/Instance | <group>.hosts.<host> | Parameters specific to a single host | Higher (4) |
| Group/Cluster | <group>.vars | Parameters shared by hosts in group/cluster | Medium (3) |
| Global | all.vars | Parameters shared by all hosts | Lower (2) |
| Default | <roles>/default/main.yml | Role implementation defaults | Lowest (1) |
These examples show parameter priority:
- Set
-e grafana_clean=trueon the playbook command line to erase Grafana data. - Set host variable
pg_roleto override the PostgreSQL instance role. - Set group variable
pg_clusterto override the PostgreSQL cluster name. - Set global variable
node_ntp_serversto specify NTP servers. - If you do not set
pg_version, Pigsty uses thepgsqlrole default,18.
Except for identity parameters, all parameters have defaults. You do not need to set them explicitly.
Identity Parameters
Identity parameters identify entities. They have no defaults and must be set explicitly, with the exception below.
| Module | Identity Parameters |
|---|---|
PGSQL | pg_cluster, pg_seq, pg_role, … |
NODE | nodename, node_cluster |
ETCD | etcd_cluster, etcd_seq |
VAULT | vault_cluster, vault_seq |
MINIO | minio_cluster, minio_seq |
REDIS | redis_cluster, redis_node, redis_instances |
KAFKA | kafka_cluster, kafka_seq |
MYSQL | mysql_cluster, mysql_seq |
INFRA | infra_seq |
Exceptions are etcd_cluster and vault_cluster, which run on fixed groups and default to etcd and vault. Instance sequences etcd_seq and vault_seq still require explicit values.
Object storage minio_cluster no longer has a default; define it in each object storage cluster’s variables.
Do not set it in all.vars, which would mark every host as a MINIO member.
Was this page helpful?
Thanks—your feedback helps us improve this page.
What got in the way? (optional)