Module: PIGSTY

The Pigsty v5.0 documentation focuses on Pigsty itself: architecture, installation, deployment, configuration, operations, and the complete manual for every first-party module. v5.0 Docs Preview OINK 0.6.0 Local First Press ⌘+ with K on macOS, or …

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

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

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. Its value is a path relative to conf/ without the .yml suffix. If omitted, Pigsty uses the default meta template. Category Templates Solo Templates meta, rich, fat, slim, infra, vibe, docker Kernel …

Pigsty FHS Pigsty’s home directory is located at ~/pigsty by default. The file structure within this directory is as follows: ~/pigsty Source Tree app/Application template resourcesbin/Management and operations scriptsfiles/victoria/Rules and …

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 target development, testing, and demonstrations on a trusted intranet. A production deployment must configure credentials, network boundaries, authentication, certificates, backup, and audit according to its threat model. See Security …

Terraform is a popular “Infrastructure as Code” tool that you can use to create virtual machines on public clouds with one click. Pigsty currently provides example Terraform templates for Alibaba Cloud, AWS (global and China), Azure, GCP, Tencent …

Vagrant is a popular local virtualization tool that creates local virtual machines in a declarative manner. Pigsty requires a Linux environment to run. You can use Vagrant to easily create Linux virtual machines locally for testing. The currently …

Pigsty provides a standard 4-node sandbox environment for learning, testing, and feature demonstration. The sandbox uses fixed IP addresses and predefined identity identifiers, making it easy to reproduce various demo use cases. Description The …

Pigsty requires an OS admin user with passwordless SSH and Sudo privileges on all managed nodes. This user must be able to SSH to all managed nodes and execute sudo commands on them. User Typically use names like dba or admin, avoiding root and …

Pigsty uses a modular architecture. You can combine modules like building blocks and express your intent through declarative configuration. Common Patterns Here are common deployment patterns for reference. Customize based on your requirements: …

Pigsty runs on nodes (physical machines or VMs). This document covers the planning and preparation required for deployment. Node Pigsty currently runs on Linux kernel with x86_64 / aarch64 architecture. A “node” refers to an SSH accessible resource …

This is the Pigsty production multi-node deployment guide. For single-node Demo/Dev setups, see Getting Started. Summary Prepare nodes with SSH access following your architecture plan, install a compatible Linux OS, then execute with an admin user …

Pigsty is a portable, extensible open-source PostgreSQL distribution for building production-grade database services in local environments with declarative configuration and automation. It has a vast ecosystem providing a complete set of tools, …

The default configuration targets local demonstrations and development or testing on a trusted intranet. If other hosts can reach the deployment, complete at least three checks: credentials, network boundaries, and critical files. Production …

If you only want HA PostgreSQL database cluster itself without monitoring, infra, etc., consider Slim Installation. Slim installation has no INFRA module, no monitoring, no local repo—just ETCD and PGSQL and partial NODE functionality. Slim …

Pigsty installs from Internet upstream by default, but some envs are isolated from the Internet. To address this, Pigsty supports offline installation using offline packages. Think of them as Linux-native Docker images. Overview Offline packages …

Pigsty uses Ansible to manage clusters, a very popular large-scale/batch/automation ops tool in the SRE community. Ansible can use declarative approach for server configuration management. All module deployments are implemented through a series of …

Besides using the configuration wizard to auto-generate configs, you can write Pigsty config files from scratch. This tutorial guides you through building a complex inventory step by step. If you define NODE, INFRA, ETCD, MINIO, and PGSQL in the …

After single-node installation, you’ll have the INFRA module installed on the current node, which includes an out-of-the-box Nginx web server. The default server configuration provides a WebUI graphical interface for displaying monitoring dashboards …

Pigsty is designed for native Linux, but can also run in Linux containers with systemd. If you don’t have native Linux (e.g., macOS or Windows), use Docker to spin up a local single-node Pigsty for testing. Quick Start Enter the docker/ dir in Pigsty …

This is the Pigsty single-node install guide Single Node. For multi-node HA production deployment, refer to the Deployment docs. Pigsty single-node installation consists of three steps: Install, Configure, and Deploy. Summary Prepare a node with …

Compliance is not a product you can buy. It is a state that must be demonstrated continuously through three elements: Configuration: whether security controls are enabled. Pigsty directly provides this part. Process: access approval, change …

Network boundaries, authentication, and access control reduce the likelihood of an incident. When hardware fails, credentials leak, or an operator makes a mistake, data-layer controls must limit the impact and support recovery. Data security answers …

TLS can provide three separate protections: transport encryption, server authentication, and client authentication. Each must be configured independently. Enabling server-side TLS does not mean the client verifies the server identity, nor does it …

Authentication answers “Who are you?” Authorization answers “What may you do?” Privilege failures rarely result from a lack of mechanisms—PostgreSQL GRANT and REVOKE are sufficiently precise. The usual problem is the absence of conventions that are …

PostgreSQL uses pg_hba.conf for Host-Based Authentication: who may connect, from where, to which database, and how they must prove their identity. The mechanism is powerful, but expensive to maintain manually across a cluster. Primary and replica …

Before examining individual security features, answer two more fundamental questions: Where is the root of trust? and How many defensive layers exist? The first determines what deserves the strongest protection. The second determines what remains …

The database is usually the most sensitive component in an information system: it stores the most valuable data, so attacks and failures can have the most serious consequences. Database security is not a feature that can be enabled with one switch. …

Pigsty allows you to use a PostgreSQL metabase as a dynamic configuration source, replacing static YAML configuration files for more powerful configuration management capabilities. Overview CMDB (Configuration Management Database) is a method of …

In Pigsty, deployment blueprint details are defined by the inventory, which is the pigsty.yml configuration file. You can customize it through declarative configuration. However, writing configuration files directly can be daunting for new users. To …

In the inventory, you can use various parameters to fine-tune Pigsty customization. These parameters cover everything from infrastructure settings to database configuration. Parameter List According to the current source and parameter reference …

Pigsty provides a configure script as a configuration wizard that automatically generates an appropriate pigsty.yml configuration file based on your current environment. This is an optional script: if you already understand how to configure Pigsty, …

Every Pigsty deployment corresponds to an Inventory that describes key properties of the infrastructure and database clusters. Configuration File Pigsty uses Ansible YAML configuration format by default, with a single YAML configuration file …

RTO (Recovery Time Objective) defines the maximum time required for the system to restore write capability when the primary fails. For critical transaction systems where availability is paramount, the shortest possible RTO is typically required, such …

Overview Pigsty’s PostgreSQL clusters come with out-of-the-box high availability, with core capabilities provided by Patroni, Etcd, and HAProxy. When your PostgreSQL cluster has two or more instances, you automatically have self-healing database …

Unlike Getting Started, production Pigsty deployments require more Architecture Planning and Preparation. This chapter helps you understand the complete deployment process and provides best practices for production environments. Before deploying to …

Pigsty follows the IaC and GitOPS philosophy: use a declarative config inventory to describe the entire environment, and materialize it through idempotent playbooks. Users describe their desired state declaratively through parameters, and playbooks …

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

Overview The cost data below is intended to illustrate order-of-magnitude differences. Cloud vendor pricing and discounts vary over time, region, instance size, and purchase model. EC2 Core·Month RDS Core·Month DHH Self-Hosted Core-Month Price (192C …

The largest entity concept in Pigsty is a Deployment. The main entities and relationships (E-R diagram) in a deployment are shown below: A deployment can also be understood as an Environment. For example, Production (Prod), User Acceptance Testing …

Pigsty uses a modular architecture with a declarative interface. You can freely combine modules like building blocks as needed. Pigsty adopts a modular design that can be freely combined and used on demand (use one or all) to suit different …

What is Pigsty, and what is it not? Pigsty is a PostgreSQL database distribution, a local-first open-source RDS cloud database solution. Pigsty is not a Database Management System (DBMS), but rather a tool, distribution, solution, and best practice …

Pigsty aims to unite the power of the PostgreSQL ecosystem and help users make the most of the world’s most popular database, PostgreSQL, with self-driving database management software. While Pigsty itself has already resolved many issues in …

According to Google Analytics PV and download statistics, Pigsty currently has approximately 100,000 users, with half from mainland China and half from other regions globally. They span across multiple industries including internet, cloud computing, …

Sponsor Us Pigsty is a free and open-source software, passionately developed by PostgreSQL community members, aiming to integrate the power of the PostgreSQL ecosystem and promote the widespread adoption of PostgreSQL. If our work has helped you, …

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 When you install Pigsty software, if you use offline package installation in a network-isolated environment, we will not receive any data about you. If you choose online installation, when downloading related packages, our servers or …

GitHub Our GitHub repository is: https://github.com/pgsty/pigsty. Please give us a ⭐️ star! We welcome anyone to submit new Issues or create Pull Requests, propose feature suggestions, and contribute to Pigsty. Please note that for issues related to …

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 version updates signify incompatible foundational changes and major new …

Pigsty uses a scalable architecture design, suitable for both large-scale production environments and single-node development/demo environments. This guide focuses on the latter. If you intend to learn about Pigsty, you can start with the Quick Start …

Recent News 2026-07-10: Pigsty v4.4.0 officially released: PG19 beta support and 531 extensions Release Notes: v4.4.0 Highlights: PostgreSQL 18.4 / 19 beta support, 531 total extensions, kernel and package updates, and Pig CLI improvements. …

Historical Origins The Pigsty project began in 2018-2019, originating from Tantan. Tantan is an internet dating app — China’s Tinder, now acquired by Momo. Tantan was a Nordic-style startup with a Swedish engineering founding team. Tantan had …

RPO (Recovery Point Objective) defines the maximum amount of data loss allowed when the primary fails. For scenarios where data integrity is critical, such as financial transactions, RPO = 0 is typically required, meaning no data loss is allowed. …

“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: …