References

• 1: Supported Linux
• 2: Pigsty Modules
• 3: Extensions
• 4: File Hierarchy
• 5: Parameters
• 6: Playbooks
• 7: Port List

1 - Supported Linux

Pigsty runs on Linux, supporting amd64/x86_64 and arm64/aarch64 arch, plus 3 major distros: EL, Debian, Ubuntu.

Pigsty runs bare-metal without containers. Supports latest 2 major releases for each of the 3 major distros across both archs.

Overview

Recommended OS versions: RockyLinux 10.0, Ubuntu 24.04, Debian 13.1.

EL

Pigsty supports RHEL / Rocky / Alma / Anolis / CentOS 8, 9, 10.

Ubuntu

Pigsty supports Ubuntu 24.04 / 22.04:

Debian

Pigsty supports Debian 12 / 13, latest Debian 13.1 recommended:

Vagrant

For local VM deployment, use these Vagrant base images (same as used in Pigsty dev):

• generic/rocky8: Rocky 8.10
• generic/rocky9: Rocky 9.6
• generic/debian12: Debian 12.11
• generic/debian13: Debian 13
• generic/ubuntu2204: Ubuntu 22.04
• bento/ubuntu-24.04: Ubuntu 24.04.2

Terraform

For cloud deployment, use these Terraform base images (Aliyun example):

• Rocky 8.10 : rockylinux_8_10_x64_20G_alibase_20240923.vhd
• Rocky 9.6 : rockylinux_9_6_x64_20G_alibase_20250101.vhd
• Ubuntu 22.04 : ubuntu_22_04_x64_20G_alibase_20240926.vhd
• Ubuntu 24.04 : ubuntu_24_04_x64_20G_alibase_20240923.vhd
• Debian 12.11 : debian_12_11_x64_20G_alibase_20241201.vhd
• Debian 13 : debian_13_x64_20G_alibase_20250101.vhd

2 - Pigsty Modules

Core Modules

Pigsty provides four core modules that are essential for delivering fully-featured, highly available PostgreSQL services:

• PGSQL: Self-healing PostgreSQL clusters with HA, PITR, IaC, SOP, monitoring, and 440 extensions out of the box.
• INFRA: Local software repo, VictoriaMetrics, Grafana, VictoriaLogs, AlertManager, PushGateway, Blackbox Exporter…
• NODE: Tune nodes to desired state: hostname, timezone, NTP, ssh, sudo, haproxy, docker, vector, keepalived.
• ETCD: Distributed key-value store serving as DCS for HA PostgreSQL clusters: consensus, config management, service discovery.

Kernel Modules

Pigsty provides four kernel modules as optional in-place replacements for the vanilla PostgreSQL kernel, offering different database flavors:

• MSSQL: Microsoft SQL Server wire-protocol compatible PG kernel, powered by AWS, WiltonDB & Babelfish!
• IVORY: Oracle-compatible PostgreSQL 16 kernel, from the IvorySQL open-source project by HighGo.
• POLAR: “Cloud-native” PostgreSQL kernel open-sourced by Alibaba Cloud, an Aurora-style RAC PostgreSQL fork.
• CITUS: Distributed PostgreSQL cluster via extension (Azure Hyperscale), with native Patroni HA support!

Extension Modules

Pigsty provides four extension modules that are not essential for core functionality but can enhance PostgreSQL capabilities:

• MINIO: S3-compatible simple object storage server, serving as optional backup repository for PostgreSQL, with production deployment and monitoring support.
• REDIS: Redis server, high-performance data structure server, supporting standalone, sentinel, and cluster deployment modes with comprehensive monitoring.
• MONGO: Native FerretDB deployment support — adding MongoDB wire-protocol level API compatibility to PostgreSQL!
• DOCKER: Docker daemon service, enabling one-click deployment of containerized stateless software templates to extend Pigsty’s capabilities!

Peripheral Modules

Pigsty also supports peripheral modules that are closely related to the PostgreSQL kernel (extensions, forks, derivatives, wrappers):

• DUCKDB: Powerful embedded OLAP database. Pigsty provides binaries, dynamic libraries, and related PG extensions: pg_duckdb, pg_lakehouse, and duckdb_fdw.
• SUPABASE: Pigsty allows running the popular Firebase open-source alternative — Supabase — on existing HA PostgreSQL clusters!
• GREENPLUM: MPP data warehouse based on PostgreSQL 12 kernel, currently with monitoring and RPM installation support only. (Beta)
• CLOUDBERRY: Open-source fork by original Greenplum developers after it went closed-source, based on PG 14 kernel, currently RPM installation support only. (Beta)
• NEON: Serverless PostgreSQL kernel with database branching capabilities. (WIP)

Pilot Modules

Pigsty is adding support for some pilot modules related to the PostgreSQL ecosystem. These may become official Pigsty modules in the future:

• KAFKA: Deploy KRaft-powered Kafka message queues with Pigsty, with out-of-the-box monitoring support. (Beta)
• MYSQL: Deploy highly available MySQL 8.0 clusters with Pigsty, with out-of-the-box monitoring support (for critique/migration evaluation). (Beta)
• KUBE: Production-grade Kubernetes deployment and monitoring using SealOS. (Alpha)
• VICTORIA: Alternative Infra implementation based on VictoriaMetrics and VictoriaLogs, offering better performance and resource utilization. (Alpha)
• JUPYTER: Out-of-the-box Jupyter Notebook environment for data analysis and machine learning scenarios. (Alpha)

Monitoring Other Databases

Pigsty’s INFRA module can be used standalone as an out-of-the-box monitoring infrastructure to monitor other nodes or existing PostgreSQL databases:

• Existing PostgreSQL Services: Pigsty can monitor external PostgreSQL services not managed by Pigsty, still providing relatively complete monitoring support.
• RDS PG: PostgreSQL RDS services provided by cloud vendors can be monitored as standard external Postgres instances.
• PolarDB: Alibaba Cloud’s cloud-native database can be monitored as external PostgreSQL 11 / 14 instances.
• KingBase: A Chinese domestic database provided by KINGBASE, monitored as external PostgreSQL 12 instances.
• Greenplum / YMatrixDB monitoring: Currently monitored as horizontally sharded PostgreSQL clusters.

3 - Extensions

Pigsty has 440 extensions. See PGEXT.CLOUD for details, maintained by PIGSTY.

4 - File Hierarchy

Pigsty FHS

Pigsty’s home directory is located at ~/pigsty by default. The file structure within this directory is as follows:

#------------------------------------------------------------------------------
# pigsty
#  ^-----@app                    # Extra application resources and examples
#  ^-----@bin                    # Utility scripts
#  ^-----@docs                   # Documentation (docsify-compatible)
#  ^-----@files                  # Ansible file resources
#            ^-----@victoria     # VictoriaMetrics rule definitions
#            ^-----@grafana      # Grafana dashboards
#            ^-----@postgres     # /pg/bin/ scripts
#            ^-----@migration    # PGSQL migration task definitions
#            ^-----@pki          # Self-signed CA and certificates
#  ^-----@roles                  # Ansible role implementations
#  ^-----@templates              # Ansible template files
#  ^-----@vagrant                # Vagrant sandbox VM templates
#  ^-----@terraform              # Terraform cloud VM provisioning templates
#  ^-----configure               # Configuration wizard script
#  ^-----ansible.cfg             # Ansible default configuration
#  ^-----pigsty.yml              # Pigsty default configuration file
#  ^-----*.yml                   # Ansible playbooks
#------------------------------------------------------------------------------
# /etc/pigsty/
#  ^-----@targets                # File-based service discovery targets
#  ^-----@dashboards             # Grafana monitoring dashboards
#  ^-----@datasources            # Grafana data sources
#  ^-----@playbooks              # Ansible playbooks
#------------------------------------------------------------------------------

CA FHS

Pigsty’s self-signed CA is located in files/pki/ under the Pigsty home directory.

You must keep the CA key file secure: files/pki/ca/ca.key. This key is generated by the ca role during deploy.yml or infra.yml execution.

# pigsty/files/pki
#  ^-----@ca                      # Self-signed CA key and certificate
#         ^[email protected]           # CRITICAL: Keep this secret
#         ^[email protected]           # CRITICAL: Trusted everywhere
#  ^-----@csr                     # Certificate signing requests
#  ^-----@misc                    # Miscellaneous certificates, issued certs
#  ^-----@etcd                    # ETCD server certificates
#  ^-----@minio                   # MinIO server certificates
#  ^-----@nginx                   # Nginx SSL certificates
#  ^-----@infra                   # Infra client certificates
#  ^-----@pgsql                   # PostgreSQL server certificates
#  ^-----@mongo                   # MongoDB/FerretDB server certificates
#  ^-----@mysql                   # MySQL server certificates (placeholder)

Nodes managed by Pigsty will have the following certificate files installed:

/etc/pki/ca.crt                             # Root certificate added to all nodes
/etc/pki/ca-trust/source/anchors/ca.crt     # Symlink to system trust anchors

All infra nodes will have the following certificates:

/etc/pki/infra.crt                          # Infra node certificate
/etc/pki/infra.key                          # Infra node private key

When your admin node fails, the files/pki directory and pigsty.yml file should be available on the backup admin node. You can use rsync to achieve this:

# run on meta-1, rsync to meta2
cd ~/pigsty;
rsync -avz ./ meta-2:~/pigsty

NODE FHS

The node data directory is specified by the node_data parameter, defaulting to /data, owned by root with permissions 0777.

Each component’s default data directory is located under this data directory:

/data
#  ^-----@postgres                   # PostgreSQL database directory
#  ^-----@backups                    # PostgreSQL backup directory (when no dedicated backup disk)
#  ^-----@redis                      # Redis data directory (shared by multiple instances)
#  ^-----@minio                      # MinIO data directory (single-node single-disk mode)
#  ^-----@etcd                       # ETCD main data directory
#  ^-----@infra                      # Infra module data directory
#  ^-----@docker                     # Docker data directory
#  ^-----@...                        # Other component data directories

Prometheus FHS

Prometheus main configuration file is located at roles/infra/templates/prometheus/prometheus.yml.j2 and is rendered to /etc/prometheus/prometheus.yml on all infrastructure nodes.

VictoriaMetrics-related scripts and rule definitions are placed in the files/victoria/ directory under the Pigsty home directory, and are copied to /etc/prometheus/ on all infrastructure nodes.

# /etc/prometheus/
#  ^-----prometheus.yml              # Prometheus main configuration file
#  ^-----@bin                        # Utility scripts: check config, show status, reload, rebuild
#  ^-----@rules                      # Recording and alerting rule definitions
#            ^-----infra.yml         # Infra rules and alerts
#            ^-----etcd.yml          # ETCD rules and alerts
#            ^-----node.yml          # Node rules and alerts
#            ^-----pgsql.yml         # PGSQL rules and alerts
#            ^-----redis.yml         # Redis rules and alerts
#            ^-----minio.yml         # MinIO rules and alerts
#            ^-----kafka.yml         # Kafka rules and alerts
#            ^-----mysql.yml         # MySQL rules and alerts
#  ^-----@targets                    # File-based service discovery target definitions
#            ^-----@infra            # Infra static target definitions
#            ^-----@node             # Node static target definitions
#            ^-----@pgsql            # PGSQL static target definitions
#            ^-----@pgrds            # PGSQL remote RDS targets
#            ^-----@redis            # Redis static target definitions
#            ^-----@minio            # MinIO static target definitions
#            ^-----@mongo            # MongoDB static target definitions
#            ^-----@mysql            # MySQL static target definitions
#            ^-----@etcd             # ETCD static target definitions
#            ^-----@ping             # Ping static target definitions
#            ^-----@patroni          # Patroni static targets (used when Patroni SSL is enabled)
#            ^-----@.....            # Other monitoring target definitions
# /etc/alertmanager.yml              # Alertmanager main configuration file
# /etc/blackbox.yml                  # Blackbox exporter main configuration file

PostgreSQL FHS

The following parameters are related to PostgreSQL database directory structure:

• pg_dbsu_home: Postgres default user home directory, defaults to /var/lib/pgsql
• pg_bin_dir: Postgres binary directory, defaults to /usr/pgsql/bin/
• pg_data: Postgres database directory, defaults to /pg/data
• pg_fs_main: Postgres main data disk mount point, defaults to /data
• pg_fs_backup: Postgres backup disk mount point, defaults to /data/backups (optional, can also backup to a subdirectory on the main data disk)

# Working assumptions:
#   {{ pg_fs_main }} main data directory, default location: `/data`          [fast SSD]
#   {{ pg_fs_backup }} backup data disk, default location: `/data/backups`     [cheap HDD]
#--------------------------------------------------------------#
# Default configuration:
#     pg_fs_main = /data             High-speed SSD
#     pg_fs_backup = /data/backups     Cheap HDD (optional)
#
#     /pg      -> /data/postgres/pg-test-15    (symlink)
#     /pg/data -> /data/postgres/pg-test-15/data
#--------------------------------------------------------------#
- name: create postgresql directories
  tags: pg_dir
  become: yes
  block:

    - name: make main and backup data dir
      file: path={{ item }} state=directory owner=root mode=0777
      with_items:
        - "{{ pg_fs_main }}"
        - "{{ pg_fs_backup }}"

    # pg_cluster_dir:    "{{ pg_fs_main }}/postgres/{{ pg_cluster }}-{{ pg_version }}"
    - name: create postgres directories
      file: path={{ item }} state=directory owner={{ pg_dbsu }} group=postgres mode=0700
      with_items:
        - "{{ pg_fs_main }}/postgres"
        - "{{ pg_cluster_dir }}"
        - "{{ pg_cluster_dir }}/bin"
        - "{{ pg_cluster_dir }}/log"
        - "{{ pg_cluster_dir }}/tmp"
        - "{{ pg_cluster_dir }}/cert"
        - "{{ pg_cluster_dir }}/conf"
        - "{{ pg_cluster_dir }}/data"
        - "{{ pg_cluster_dir }}/meta"
        - "{{ pg_cluster_dir }}/stat"
        - "{{ pg_cluster_dir }}/change"
        - "{{ pg_backup_dir }}/backup"

Data File Structure

# Physical directories
{{ pg_fs_main }}     /data                      # Top-level data directory, typically fast SSD mount point
{{ pg_dir_main }}    /data/postgres             # Contains all Postgres instance data (may have multiple instances/versions)
{{ pg_cluster_dir }} /data/postgres/pg-test-15  # Contains `pg-test` cluster data (major version 15)
                     /data/postgres/pg-test-15/bin            # PostgreSQL utility scripts
                     /data/postgres/pg-test-15/log            # Logs: postgres/pgbouncer/patroni/pgbackrest
                     /data/postgres/pg-test-15/tmp            # Temporary files, e.g., rendered SQL files
                     /data/postgres/pg-test-15/cert           # PostgreSQL server certificates
                     /data/postgres/pg-test-15/conf           # PostgreSQL configuration file index
                     /data/postgres/pg-test-15/data           # PostgreSQL main data directory
                     /data/postgres/pg-test-15/meta           # PostgreSQL identity information
                     /data/postgres/pg-test-15/stat           # Statistics, log reports, summary digests
                     /data/postgres/pg-test-15/change         # Change records

{{ pg_fs_backup }}     /data/backups                            # Optional backup disk directory/mount point
                     /data/backups/postgres/pg-test-15/backup # Actual storage location for cluster backups

# Symlinks
/pg             ->   /data/postgres/pg-test-15                # pg root symlink
/pg/data        ->   /data/postgres/pg-test-15/data           # pg data directory
/pg/backup      ->   /var/backups/postgres/pg-test-15/backup  # pg backup directory

Binary File Structure

On EL-compatible distributions (using yum), PostgreSQL default installation location is:

/usr/pgsql-${pg_version}/

Pigsty creates a symlink named /usr/pgsql pointing to the actual version specified by the pg_version parameter, for example:

/usr/pgsql -> /usr/pgsql-15

Therefore, the default pg_bin_dir is /usr/pgsql/bin/, and this path is added to the system PATH environment variable, defined in: /etc/profile.d/pgsql.sh.

export PATH="/usr/pgsql/bin:/pg/bin:$PATH"
export PGHOME=/usr/pgsql
export PGDATA=/pg/data

On Ubuntu/Debian, the default PostgreSQL Deb package installation location is:

/usr/lib/postgresql/${pg_version}/bin

Pgbouncer FHS

Pgbouncer runs under the same user as {{ pg_dbsu }} (defaults to postgres), with configuration files located in /etc/pgbouncer.

• pgbouncer.ini: Connection pool main configuration file
• database.txt: Defines databases in the connection pool
• userlist.txt: Defines users in the connection pool
• pgb_hba.conf: Defines access permissions for the connection pool

Redis FHS

Pigsty provides basic support for Redis deployment and monitoring.

Redis binaries are installed in /bin/ via RPM packages or binary copy, including:

redis-server
redis-server
redis-cli
redis-sentinel
redis-check-rdb
redis-check-aof
redis-benchmark
/usr/libexec/redis-shutdown

For a Redis instance named redis-test-1-6379, the related resources are as follows:

/usr/lib/systemd/system/redis-test-1-6379.service               # Service (on Debian: /lib/systemd)
/etc/redis/redis-test-1-6379.conf                               # Configuration
/data/redis/redis-test-1-6379                                   # Database directory
/data/redis/redis-test-1-6379/redis-test-1-6379.rdb             # RDB file
/data/redis/redis-test-1-6379/redis-test-1-6379.aof             # AOF file
/var/log/redis/redis-test-1-6379.log                            # Log
/var/run/redis/redis-test-1-6379.pid                            # PID

For Ubuntu/Debian, the default systemd service directory is /lib/systemd/system/ instead of /usr/lib/systemd/system/.

5 - Parameters

Pigsty provides approximately 380+ configuration parameters distributed across 8 core modules, allowing fine-grained control over all aspects of the system.

Module Navigation

This page provides navigation and overview for all Pigsty configuration parameters. Click on a module name to jump to the detailed parameter documentation.

PGSQL

The PGSQL module provides 9 groups with 123 PostgreSQL-related configuration parameters.

INFRA

The INFRA module provides 10 groups with 82 infrastructure-related configuration parameters.

NODE

The NODE module provides 11 groups with 83 host node-related configuration parameters.

ETCD

The ETCD module provides 2 groups with 13 distributed configuration storage parameters.

REDIS

The REDIS module provides 21 Redis-related configuration parameters.

MINIO

The MINIO module provides 2 groups with 21 MinIO object storage parameters.

FERRET

The FERRET module provides 9 FerretDB-related configuration parameters.

DOCKER

The DOCKER module provides 8 Docker container engine configuration parameters.

Parameter Overview

The following tables provide a comprehensive summary of all parameters, organized by module.

PGSQL Parameters

PG_ID parameter group defines PostgreSQL cluster and instance identity, including cluster name, instance number, role, shard, etc.

PG_BUSINESS parameter group defines business users, databases, services, access control rules, and default system user credentials.

PG_INSTALL parameter group configures PostgreSQL installation options, including version, paths, packages, and extensions.

PG_BOOTSTRAP parameter group configures PostgreSQL cluster initialization, including Patroni HA, data directory, storage, connections, encoding, etc.

PG_PROVISION parameter group configures PostgreSQL cluster template provisioning, including default roles, privileges, schemas, extensions, and HBA rules.

PG_BACKUP parameter group configures pgBackRest backup and recovery, including repository type, path, retention policy, etc.

PG_ACCESS parameter group configures service exposure, connection pool, VIP, DNS, and other client access options.

PG_MONITOR parameter group configures PostgreSQL monitoring exporters, including pg_exporter, pgbouncer_exporter, and pgbackrest_exporter.

PG_REMOVE parameter group configures PostgreSQL instance cleanup and uninstallation behavior, including data directory, backup, and package removal control.

INFRA Parameters

META parameter group defines Pigsty meta information, including version number, admin node IP, repository region, default language, and proxy settings.

CA parameter group configures Pigsty self-signed CA certificate management, including whether to create CA, CA name, and certificate validity.

INFRA_ID parameter group defines infrastructure node identity, including node sequence number, service portal configuration, and data directory.

REPO parameter group configures local software repository, including repository enable switch, directory path, upstream source definitions, and packages to download.

INFRA_PACKAGE parameter group defines packages to install on infrastructure nodes, including RPM/DEB and PIP packages.

NGINX parameter group configures Nginx web server and reverse proxy, including enable switch, ports, SSL mode, certificates, and basic authentication.

DNS parameter group configures DNSMasq DNS resolution service, including enable switch, listen port, and dynamic DNS records.

VICTORIA parameter group configures VictoriaMetrics/Logs/Traces observability suite, including enable switches, ports, data retention policies, etc.

PROMETHEUS parameter group configures Alertmanager and Blackbox Exporter, providing alerting management and network probing.

GRAFANA parameter group configures Grafana visualization platform, including enable switch, port, admin credentials, and data source configuration.

NODE Parameters

NODE_ID parameter group defines node identity parameters, including node name, cluster name, and whether to borrow identity from PostgreSQL.

NODE_DNS parameter group configures node DNS resolution, including static hosts records and dynamic DNS servers.

NODE_PACKAGE parameter group configures node software sources and package installation.

NODE_TUNE parameter group configures node kernel parameters, feature switches, and performance tuning templates.

NODE_SEC parameter group configures node security options, including SELinux, firewall, etc.

NODE_ADMIN parameter group configures node admin user, data directory, and command aliases.

NODE_TIME parameter group configures node timezone, NTP time sync, and cron jobs.

NODE_VIP parameter group configures node cluster L2 VIP, implemented by keepalived.

HAPROXY parameter group configures HAProxy load balancer and service exposure on nodes.

NODE_EXPORTER parameter group configures node monitoring exporter.

VECTOR parameter group configures Vector log collector.

ETCD Parameters

ETCD parameter group is for etcd cluster deployment and configuration, including instance identity, cluster name, data directory, ports, and authentication password.

ETCD_REMOVE parameter group controls etcd cluster removal behavior, including safeguard, data cleanup, and package uninstallation.

REDIS Parameters

REDIS parameter group is for Redis cluster deployment and configuration, including identity, instance definitions, working mode, memory configuration, persistence, and monitoring.

MINIO Parameters

MINIO parameter group is for MinIO cluster deployment and configuration, including identity, storage paths, ports, authentication credentials, and bucket/user provisioning.

MINIO_REMOVE parameter group controls MinIO cluster removal behavior, including safeguard, data cleanup, and package uninstallation.

FERRET Parameters

FERRET parameter group is for FerretDB deployment and configuration, including identity, underlying PostgreSQL connection, listen port, and SSL settings.

DOCKER Parameters

DOCKER parameter group is for Docker container engine deployment and configuration, including enable switch, data directory, storage driver, registry mirrors, and monitoring.

6 - Playbooks

Pigsty provides a series of Ansible playbooks for automated deployment and management of various modules. This page provides navigation and summary of all playbooks.

Module Navigation

Playbook Summary

The following table lists all available preset playbooks in Pigsty:

Playbook Usage Notes

Protection Mechanism

Multiple modules provide deletion protection through *_safeguard parameters:

• PGSQL: pg_safeguard prevents accidental deletion of PostgreSQL clusters
• ETCD: etcd_safeguard prevents accidental deletion of Etcd clusters
• MINIO: minio_safeguard prevents accidental deletion of MinIO clusters

By default, these safeguard parameters are not enabled (undefined). It’s recommended to explicitly set them to true for initialized clusters in production environments.

When the protection switch is set to true, the corresponding *-rm.yml playbook will abort immediately. You can force override through command-line parameters:

./pgsql-rm.yml -l pg-test -e pg_safeguard=false
./etcd-rm.yml -e etcd_safeguard=false
./minio-rm.yml -l minio -e minio_safeguard=false

Limiting Execution Scope

When executing playbooks, it’s recommended to use the -l parameter to limit the execution scope:

./pgsql.yml -l pg-meta            # Limit execution to pg-meta cluster
./node.yml -l 10.10.10.10         # Limit execution to specific node
./redis.yml -l redis-test         # Limit execution to redis-test cluster

Idempotency

Most playbooks are idempotent and can be executed repeatedly. However, note:

• infra.yml does not clear data by default and can be safely re-executed. All clean parameters (vmetrics_clean, vlogs_clean, vtraces_clean, grafana_clean, nginx_clean) default to false
• To clear infrastructure data for rebuild, you need to explicitly set the corresponding clean parameter to true
• Be extra careful when repeatedly executing *-rm.yml deletion playbooks

Task Tags

You can use the -t parameter to execute only specific task subsets:

./pgsql.yml -l pg-test -t pg_service    # Only refresh pg-test cluster services
./node.yml -t haproxy                   # Only set up haproxy on nodes
./etcd.yml -t etcd_launch               # Only restart etcd service

Quick Command Reference

./deploy.yml                     # One-pass deployment

INFRA Module

./infra.yml                      # Initialize infrastructure
./infra-rm.yml                   # Remove infrastructure

NODE Module

./node.yml -l <cls|ip>           # Add node
./node-rm.yml -l <cls|ip>        # Remove node
bin/node-add <cls|ip>            # Add node (wrapper script)
bin/node-rm <cls|ip>             # Remove node (wrapper script)

ETCD Module

./etcd.yml                       # Initialize etcd cluster
./etcd-rm.yml                    # Remove etcd cluster
bin/etcd-add <ip>                # Add etcd member (wrapper script)
bin/etcd-rm <ip>                 # Remove etcd member (wrapper script)

PGSQL Module

./pgsql.yml -l <cls>                            # Initialize PostgreSQL cluster
./pgsql-rm.yml -l <cls>                         # Remove PostgreSQL cluster
./pgsql-user.yml -l <cls> -e username=<user>    # Create business user
./pgsql-db.yml -l <cls> -e dbname=<db>          # Create business database
./pgsql-monitor.yml -e clsname=<cls>            # Monitor remote cluster
./pgsql-pitr.yml -l <cls> -e '{"pg_pitr": {}}'  # Execute PITR recovery

bin/pgsql-add <cls>              # Initialize cluster (wrapper script)
bin/pgsql-rm <cls>               # Remove cluster (wrapper script)
bin/pgsql-user <cls> <user>      # Create user (wrapper script)
bin/pgsql-db <cls> <db>          # Create database (wrapper script)

REDIS Module

./redis.yml -l <cls>             # Initialize Redis cluster
./redis-rm.yml -l <cls>          # Remove Redis cluster

MINIO Module

./minio.yml -l <cls>             # Initialize MinIO cluster
./minio-rm.yml -l <cls>          # Remove MinIO cluster

FERRET Module

./mongo.yml -l ferret            # Install FerretDB

DOCKER Module

./docker.yml -l <host>           # Install Docker

7 - Port List

This page lists default ports used by Pigsty module components. Adjust as needed or use as a reference for fine-grained firewall configuration.