PIGSTY

Template

Configuration templates for Pigsty

This directory conf contains pigsty config templates, which will be used during configure procedure.

Config templates can be designated using ./configure -c <conf>, where the conf is a relative path to conf directory (with or without .yml suffix). e.g. the ~/pigsty/conf/rich.yml can be specified as rich

./configure                     # use the meta.yml config template by default
./configure -c meta             # use the meta.yml 1-node template explicitly
./configure -c rich             # use the 1-node template with all extensions & minio
./configure -c slim             # use the minimal 1-node template
./configure -c app/supa         # use the supabase 1-node template

If no -c|--conf is given, the single-node meta config template will be automatically selected by default.


Basic Templates

Here are one-node templates, which provide different features and configurations.

TemplateNodeDescription
meta.yml1Default 1-node config, pgsql, infra, node, etcd, minimal ext
rich.yml1meta + minio + all extensions
slim.yml1meta - infra - node monitor, minimal install
pg18.yml1PostgreSQL 18 cluster (beta)

Exotic Kernel

Using exotic Postgres kernel forks:

TemplateNodeDescription
mssql.yml1WiltonDB & Babelfish with MSSQL wire-compatibility
polar.yml1PolarDB for PostgreSQL with Aurora RAC Flavor
ivory.yml1IvorySQL cluster with Oracle compatibility
mysql.yml1Halo cluster with MySQL wire-compatibility
mongo.yml1FerretDB & DocumentDB with Mongo wire-compatibility
oriole.yml1OrioleDB cluster with OLTP enhancement

Multi Node

TemplateNodeDescription
dual.yml2Semi-HA deployment
trio.yml3Standard HA deployment
full.yml4Sandbox deployment
safe.yml4Security enhancement with delayed replica
simu.yml36Production simulation

Applications

TemplateDescription
app/supa.ymlLaunch 1-node supabase
app/odoo.ymlLaunch the odoo ERP system
app/dify.ymlLaunch the dify AI workflow system
app/electric.ymlLaunch the electric sync engine app

Demo Templates

TemplateDescription
demo/el.ymlConfig file with all default parameters for EL 8/9 systems
demo/debian.ymlConfig file with all default parameters for debian/ubuntu systems
demo/remote.ymlExample config for monitoring a remote pgsql cluster or RDS PG
demo/redis.ymlExample config for redis clusters
demo/minio.ymlExample config for a 3-node minio clusters
demo/demo.ymlConfig file for the pigsty public demo
demo/citus.ymlCitus cluster example: 1 coordinator and 3 data nodes (4-node)

Build Templates

TemplateDescription
build/oss.ymlBuilding config for EL 8, 9, Debian 12, and Ubuntu 22.04/24.04 OSS
build/pro.ymlBuilding config for EL 7-9, Ubuntu, Debian pro version