PIGSTY

What is etcd’s role in Pigsty? etcd is a distributed, reliable key-value store for critical system data. Pigsty uses etcd as the DCS (Distributed Config Store) for Patroni. It stores PostgreSQL HA status. Patroni uses etcd for cluster failure …

What components are included in the INFRA module? The current infra role directly manages these components: Nginx: Exposes Grafana, VictoriaMetrics (VMUI), Alertmanager, and other WebUIs, and hosts local YUM/APT repositories. DNSMasq: Provides DNS …

Getting Started Path Order Question Entry 1 What modules does Pigsty include? Modular Architecture, PGSQL Architecture, PGSQL Cluster Model 2 How do I get it running first? Quick Start, Web UI, PostgreSQL Quick Start 3 How should I read the config …

Use -c with configure to select a template. Specify its path relative to conf/, without the .yml suffix. If you omit -c, Pigsty uses the meta template. Category Templates Solo Templates meta, rich, fat, slim, infra, vibe, docker Kernel Templates …

Pigsty FHS The default Pigsty home directory is ~/pigsty. It has this file structure: ~/pigsty Source Tree app/Application template resourcesbin/Management and operations scriptsfiles/victoria/Rules and operations scriptsgrafana/Grafana …

Official Modules Module Category Status Docs Path Summary PGSQL Core GA /docs/pgsql High-availability PostgreSQL clusters with built-in backup, monitoring, SOP, and extension ecosystem. INFRA Core GA /docs/infra Local software repository + …

Pigsty defaults support development, testing, and demonstrations on a trusted intranet. For production, configure credentials, network boundaries, authentication, certificates, backups, and audit controls for your threat model. Security and …

OpenTofu is an open-source infrastructure-as-code tool. It creates public cloud virtual machines from configuration files. Pigsty uses OpenTofu by default. It supplies Terraform-compatible .tf templates for Alibaba Cloud, global AWS, AWS China, …

Vagrant creates local virtual machines from declarative configuration. Pigsty requires Linux. You can use Vagrant to create local Linux virtual machines for testing. The recommended and validated versions are: Rocky Linux 9.8 / 10.2. Debian 12.15 / …

Pigsty supplies a standard 4-node sandbox for learning, testing, and feature demonstrations. It uses fixed IP addresses and predefined identity values to make the demonstrations repeatable. Description The default sandbox has 4 nodes and uses the …

Pigsty uses an operating system administration account with SSH and sudo access to every managed node. The account must be able to log in through SSH and run sudo commands on these nodes. Passwordless access is the standard configuration; password …

Pigsty uses a modular architecture. Select the modules for your requirements and define the deployment through declarative configuration. Common Patterns Use these common deployment patterns as a starting point. Adjust the configuration for your …

Pigsty runs on nodes, which can be physical machines or virtual machines. This document describes the planning and preparation for deployment. Node Pigsty runs on the Linux kernel with x86_64 or aarch64 architecture. A node supplies a bare Linux …

This guide describes production deployment on multiple nodes. For single-node demonstrations or development, use Getting Started. Summary Prepare the nodes according to your architecture plan. Install a supported Linux operating system. Configure SSH …

Pigsty is a portable, extensible, open-source PostgreSQL distribution. It uses declarative configuration and automation to build production database services in local environments. Its tools, scripts, and operating practices support PostgreSQL …

The default configuration supports local demonstrations and development on a trusted intranet. If other hosts can reach the deployment, examine the credentials, network access, and sensitive files. For production, also review the Security Model, …

Use Slim Installation to deploy PostgreSQL without the monitoring infrastructure. It installs ETCD, PGSQL, and part of NODE. It does not install INFRA, monitoring services, or a local software repository. When to use Slim Installation You only need …

Pigsty normally installs packages from upstream Internet repositories. If the environment has no Internet access, use offline packages. Overview An offline package contains the RPM or DEB packages and dependencies from a local APT or YUM repository. …

Pigsty uses Ansible to deploy and manage clusters. Ansible applies declarative configuration through playbooks. Pigsty module playbooks use idempotent tasks to reach the specified configuration. For a single-node installation, use deploy.yml. Other …

You can generate a configuration file with the configuration wizard. You can also write the file yourself. This guide builds an inventory in stages. The deploy.yml playbook deploys NODE, INFRA, ETCD, MINIO, and PGSQL when the inventory defines them. …

The default single-node installation includes the INFRA module. This module installs an Nginx web server on the node. Nginx supplies the Web UI and proxies requests to the monitoring services and other component interfaces. Access Enter the …

Pigsty runs on native Linux. It can also run in Linux containers with systemd. If you use macOS or Windows, use Docker to try a local single-node installation. Quick Start Enter the docker/ source directory. Run the launch command: cd ~/pigsty/docker …

This guide installs Pigsty on one Linux node. Single Node For production deployments with multiple nodes, use the Deployment Guide. The procedure has three stages: Install, Configure, and Deploy. Summary Prepare a node with a supported operating …

Compliance requires continuous evidence of three elements: Configuration: Security controls must be enabled. Pigsty directly provides configuration. Process: The organization must establish access approval, change management, recovery exercises, and …

Network boundaries, authentication, and access control reduce incident risk. Data controls must limit damage and support recovery after hardware failure, leaked credentials, or operator errors. Data security must provide integrity, recoverability, …

TLS can provide transport encryption, server authentication, and client authentication. Configure each protection separately. Enabling server TLS does not make clients verify the server or make the server require client certificates. Most TLS …

Authentication verifies identity. Authorization determines what that identity can do. PostgreSQL GRANT and REVOKE provide precise control. Privilege problems usually arise from missing default conventions. Examples include making an application …

pg_hba.conf defines PostgreSQL Host-Based Authentication. It controls who can connect, the source address, the database, and the required identity check. Manual HBA maintenance across a cluster requires care. Primary and replica rules can differ, and …

Identify the root of trust and defensive layers before selecting security features. The root of trust needs the strongest protection. Multiple layers preserve some protection if one fails. Trust Boundaries Pigsty uses Ansible for declarative …

Databases usually store the most valuable and sensitive data in an information system. Attacks and failures can therefore have severe consequences. Security requires multiple controls: who can connect, what they can do, and whether traffic is …

Use a PostgreSQL metabase as a dynamic configuration source instead of static YAML files. Overview A CMDB (Configuration Management Database) stores configuration in database tables. By default, Pigsty uses static pigsty.yml as the Ansible inventory. …

The inventory defines the deployment through declarative configuration. Customize its pigsty.yml file for your requirements. New users can start with ready-to-use templates for common deployment scenarios. Each template is a predefined pigsty.yml …

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 …

The configure configuration wizard generates pigsty.yml for your current environment. This script is optional. If you know how to configure Pigsty, edit pigsty.yml directly and skip the wizard. Quick Start Enter the Pigsty source directory and run …

Each Pigsty deployment has an inventory that describes the infrastructure and database clusters. Configuration File By default, Pigsty uses Ansible YAML configuration format. The inventory is a single file, pigsty.yml. ~/pigsty ^---- pigsty.yml # …

RTO (Recovery Time Objective) defines the maximum time required for the system to restore write capability when the primary fails. Critical transaction systems typically need the shortest practical RTO, often below one minute. Shorter RTO increases …

Overview Pigsty PostgreSQL clusters include HA through Patroni, Etcd, and HAProxy. A cluster with two or more instances gains automatic HA without extra configuration. A surviving instance can provide the complete database service. Clients can …

Production deployments require Architecture Planning and Preparation beyond the Getting Started procedure. This chapter describes the complete deployment process and recommended practices for production. Before production deployment, test the …

Pigsty uses IaC and GitOps. Describe the environment in a declarative inventory. Apply it with idempotent playbooks. Declare the target state with parameters. Playbooks can repeatedly adjust nodes to that state. This resembles Kubernetes CRDs and …

China PostgreSQL Ecosystem Projects Sorted by GitHub stars in descending order. Last updated: 2026-09-20 (Beijing time). Project Star Author Type Summary pgsty/pigsty 5660 Ruohang Feng @ PGSTY Distribution Out-of-the-box PostgreSQL distribution …

Overview The following data shows approximate differences in cost. Cloud prices and discounts vary with time, region, instance size, and purchase model. EC2 Core·Month RDS Core·Month DHH Self-Hosted Core-Month Price (192C 384G) 25.32 Junior Open …

A deployment is the largest entity in Pigsty. This entity-relationship diagram shows its main entities and their relationships: A deployment is also an environment. Examples include Production (Prod), User Acceptance Testing (UAT), Staging, Testing, …

Pigsty uses a modular architecture and declarative interface. Combine modules to meet your requirements. Use one or more modules from the modular design. Describe the environment with a configuration inventory and parameters. Apply it with Ansible …

What is Pigsty, and what is it not? Pigsty is a PostgreSQL distribution and a local-first, open-source RDS solution. It provides tools and operational practices for managing a DBMS. It is not itself a Database Management System (DBMS). For …

Pigsty combines tools from the PostgreSQL ecosystem with automated database management. It helps users use PostgreSQL, the world’s most popular database. Pigsty resolves many PostgreSQL operational issues. Enterprise service quality also requires …

Google Analytics page views and download statistics indicate approximately 100,000 Pigsty users. About half are in mainland China and half in other regions. They work in internet services, cloud computing, finance, autonomous driving, manufacturing, …

Sponsor Us PostgreSQL community members develop Pigsty as free and open-source software. It integrates the PostgreSQL ecosystem and promotes PostgreSQL adoption. If it helps you, consider these ways to support the project: Sponsor the project …

License Summary Pigsty core uses Apache-2.0; documentation uses CC BY 4.0. Official License: https://github.com/pgsty/pigsty/blob/main/LICENSE Pigsty Core The Pigsty core is licensed under Apache License 2.0. Apache-2.0 is a permissive open-source …

Pigsty Software For offline installation in a network-isolated environment, we receive no data about you. During online installation, our servers or cloud provider servers log the requesting machine’s IP address and/or hostname and downloaded …

GitHub Find the project at github.com/pgsty/pigsty. You can support it with a star. Contribute feature suggestions, new issues, or pull requests. For documentation problems, submit issues to github.com/pgsty/pigsty.cc. Press ⌘+ with K on macOS, or …

Release Strategy Pigsty uses semantic versioning: <major>.<minor>.<patch>. Alpha/Beta/RC versions will have suffixes like -a1, -b1, -c1 appended to the version number. Major versions introduce incompatible foundational changes and major features. …

Use this guide to install Pigsty on one Linux node. Start with Quick Start. A node with 1 CPU core and 2 GB of memory is sufficient. You can use a Linux MiniPC, a cloud server, Windows WSL, or a virtual machine on your laptop. Pigsty supplies Vagrant …

Recent News 2026-08-15: Pigsty v4.5.0 officially released: Kafka, MySQL, Valkey, Silo, and 575 extensions Release Blog: Pigsty v4.5 Release Article Release Notes: v4.5.0 Highlights: Kafka KRaft and MySQL 8.4 pilot modules, Valkey in REDIS, Silo as …

Historical Origins Pigsty began in 2018-2019 at Tantan. Tantan is a dating app similar to Tinder in China, later acquired by Momo. Its founding engineering team was Swedish, and its startup culture followed a Nordic model. Tantan used PostgreSQL and …

RPO (Recovery Point Objective) defines the maximum amount of data loss allowed when the primary fails. Critical data, such as financial transactions, typically requires RPO = 0: no data loss. Stricter RPO targets increase write latency and reduce …

“PostgreSQL In Great STYle”: Postgres, Infras, Graphics, Service, Toolbox, it’s all Yours. —— Battery-included, local-first PostgreSQL distribution, open-source RDS alternative Value Propositions Extensibility: Powerful extensions out of the box: …

“PostgreSQL In Great STYle”: Postgres, Infras, Graphics, Service, Toolbox, it’s all Yours. —— Battery-Included, Local-First PostgreSQL Distribution as a Free & Open-Source RDS Alternative Free & Open Source Local First Production Ready GitHub | Demo …