Skip to content

Version v3.7.0 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.

Configuration

Describe your environment with config

Pigsty treats Infra & Database as Code. You can describe everything with declarative config Inventory. Which is usually an Ansible Inventory in YAML format: pigsty.yml. But CMDB can also be used as dynamic inventory.

The configure procedure will generate a config according to your environment and input. But it’s OPTIONAL: you can always edit the pigsty.yml file directly as tutorial shows. And there are plenty of templates for your reference.

Inventory
    The main config file of Pigsty, Describe your entire deployment
Configure
    Generate config file according to your input & environment
Tutorial
    Planning your deployment according to business requirements
Template
    Available configuration templates and examples
Security
    Security considerations and best practices for prod deployment
CMDB
    Use PostgreSQL as CMDB instead of local YAML config file

PGSQL
    PostgreSQL Cluster with HA, PITR, IaC, ACL, Monitoring, Pooling
INFRA
    Nginx, Repo, DNS, NTP, Prometheus and Grafana stack for Observability
NODE
    Enroll nodes into the desired state and monitor it, and VIP, HAProxy
ETCD
    Reliable distributed consensus storage (DCS), empowering PGSQL HA
MINIO
    S3 compatible object storage, optional backup storage
REDIS
    High-performance in-memory cache, optional data structure server

how to configure pigsty inventory file?

Forge a complex config from scratch

Configuration templates for Pigsty

Security considerations and best-practices

Use PostgreSQL as config inventory