Configuration reference of pigsty

Pigsty uses [declarative configuration] (../reference/config/): the user configuration describes the state, while Pigsty is responsible for tuning the real component to the expected state.

Pigsty configuration files follow Ansible rules in YAML format, see Config Files for details .

Pigsty have 156 parameters, divided into 10 categories and five levels. see Config Entry for details.

Most parameters are optional. There are only 3 mandatory identity parameters to define a new database cluster.

No Category Type Args Function
1 connect Infra 1 Proxy settings, connect information
2 repo Infra 10 local yum repo
3 node Infra 29 node provision (ntp, dns, tuned, etc…)
4 meta Infra 21 setup infrastructure on meta node
5 dcs Infra 8 setup DCS (consul)
6 pg-install PgSQL 11 install postgres (repo, pkgs, extensions,users,dirs)
7 pg-provision PgSQL 27 pull up pg clusters (identity assignment)
8 pg-template PgSQL 19 customize cluster content and template
9 monitor PgSQL 13 install monitor components
10 service PgSQL 17 expose service via haproxy and vip

Config File

Structure, content, merge and split methods of Pigsty configuration files.

Config Entry

Introduction to 156 config entries about pigsty


parameters about connection info and proxy settings

Local Repo

Parameters about local yum repo: content, where to download, etc

Node Provision

Parameters about os, machine, infrastructure on all nodes


Parameteres about infrastructures


Parameters about distributed configuration storage

PG Install

Parameters about postgres installation

PG Provision

Parameters about how to pull up new clusters and assign identity to entities

PG Template

Parameters about customize template and other database content.


Parameters about monitoring components

Service Provision

Parameters about exposing cluster’s service

Last modified 2021-03-28: update en docs (f994b54)