Pigsty Get Started

Launch Pigsty with 3 lines of command

There are two typical modes: Singleton & Cluster Management

  • Singleton Meta: Install pigsty on one single meta node. (for PostgreSQL dev/test, RDS monitoring, etc…)
  • Cluster Manage: Initiate control from meta node, and manage & monitoring more nodes & databases.

Singleton Meta

When Pigsty is installed on one single node. It will init pigsty infra with a battery including Postgres as CMDB. You may use that database directly.


Prepare a new node : Linux x86_64 CentOS 7.8.2003, with root or sudo access, then download pigsty

bash -c "$(curl -fsSL http://download.pigsty.cc/get)"  # Download Latest Pigsty Source
cd ~/pigsty; ./configure                               # Configure pigsty with ip & template
./infra.yml                                            # Install pigsty on current meta node

If you have available Mac/PC/Laptop/Cloud Account, Sandbox could be handy to create vm for you.

After installation. port 5432 is ready for postgres database connection @ postgres://dbuser_dba:DBUser.DBA@

And a Nginx is serving & proxy all WebUI services @ port 80.

Download Directly via Curl
curl https://github.com/Vonng/pigsty/releases/download/v1.5.1/pigsty.tgz -o /tmp/pigsty.tgz
curl https://github.com/Vonng/pigsty/releases/download/v1.5.1/pkg.tgz    -o /tmp/pkg.tgz  

Access Web Services

Nginx port 80 is the default access endpoint for all Web GUI services. Although it is possible to bypass Nginx add access services directly by port, such as Grafana on 3000, it is highly recommended to use domain names. If you don’t have public domain names, considering use Static DNS on your localhost with make dns.

http://g.pigsty or http://<primary_ip>:3000 is the portal of the monitoring system (username: admin, password: pigsty)

Visit http://<primary_ip>:3000 / http://g.pigsty to visit Pigsty Grafana (username: admin, password: pigsty)

Cluster Manage

Pigsty can also be used as a controller & monitoring infrastructure for production-grade large-scale nodes & databases.

You can initiate control from meta node, and add more nodes into Pigsty.

You can deploy different types of High available PostgreSQL Clusters, Redis clusters, or Greenplum/MatrixDB data warehouse.

./nodes.yml  -l pg-test      # init 3 nodes of cluster pg-test
./pgsql.yml  -l pg-test      # init HA PGSQL Cluster pg-test
./redis.yml  -l redis-test   # init redis cluster redis-test
./pigsty-matrixdb.yml -l mx-*  # init MatrixDB: mx-mdw,mx-sdw

Last modified 2022-06-20: add timescaledb (3c335f4)