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.
Preparation
Prepare resources for a serious deployment
Hardware
Nodes, specs, disks, network, VIP, domain ...
Linux OS
List of supported Linux OS distributions
Software
Locale, Firewall, Ansible, Pigsty...
Admin
User, Sudo, SSH, Accessibility...
You can leverage IaC tools such as Terraform and Vagrant to help you prepare the environment and do the chore.
Ansible
Ansible 101, basic knowledge for pigsty users
Sandbox
The four-node sandbox for learning & testing
Vagrant
Provision local virtual machine with vagrant
Terraform
Provision cloud servers with terraform
Here’s a checklist to help you prepare the environment for a serious Pigsty deployment in production environment.
| Item | Requirement | Item | Requirement |
|---|---|---|---|
| Node | 1C1G at least, 2C2G recommended, no upper limit |
Spec | 1 node at least, 2 for semi-HA, 3+ for real HA |
| Disk | /data, main mount point, ext4 or xfs |
Network | static intranet, IPv4 address, nice to have Internet access |
| VIP | Reserve an L2 IP for VIP (OPTIONAL) | Domain | Use local / public domain names (OPTIONAL) |
| Kernel | Linux, MacOS can be used as admin controller |
Distro | EL (8/9), Debian (12), Ubuntu (22/24), x86_64 / aarch64 |
| Locale | C.UTF-8 or C |
Firewall | port: 80 / 443 / 22 / 5432 |
| User | avoid using root & postgres |
Sudo | nopass sudo privilege |
| SSH | nopass via public key |
Accessible | ssh <ip|alias> sudo ls works |
Nodes, specs, disks, network, VIP, domain …
List of compatible linux OS Distributions
Locale, Firewall, Ansible, Pigsty…
User, Locale, Sudo, SSH, accessibility…
The 4-node env for learning & testing
Provision local VM with vagrant
Provision cloud VM with terraform