Parameters

Use inventory parameters to customize infrastructure settings and database configuration.

Parameter List

The current source and reference pages list 373 public parameters across 10 official modules. See Reference - Parameter List for the complete list. The native MySQL 8.4 pilot module has 13 additional public parameters. They are listed separately and excluded from this total.

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.

all:                            # <------- Top-level object: all
  vars:
    admin_ip: 10.10.10.10       # <------- Global configuration parameter
  children:
    pg-meta:                    # <------- pg-meta group
      vars:
        pg_cluster: pg-meta     # <------- Cluster-level parameter
      hosts:
        10.10.10.10:            # <------- Host node IP
          pg_seq: 1
          pg_role: primary      # <------- Instance-level parameter

Parameter Priority

Set parameters at these levels, listed from highest to lowest priority:

These examples show parameter priority:

• Set -e grafana_clean=true on the playbook command line to erase Grafana data.
• Set host variable pg_role to override the PostgreSQL instance role.
• Set group variable pg_cluster to override the PostgreSQL cluster name.
• Set global variable node_ntp_servers to specify NTP servers.
• If you do not set pg_version, Pigsty uses the pgsql role 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.

etcd_cluster is an exception. It defaults to etcd. Set minio_cluster explicitly in each object storage cluster’s variables. It no longer has a default. Do not set it in all.vars: this marks every host as a MINIO module member.