Skip to content

Version v2.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.

Category: Setup

  • FAQ

    In Getting Started

    SetupFAQPIGSTY

    If you have any unlisted questions or suggestions, please create an Issue or ask the community for help. How to Get the Pigsty Source Package? Use the following command to install Pigsty with one click: bash -c "$(curl -fsSL …

    If you have any unlisted questions or suggestions, please create an Issue or ask the community for help. How to Get the Pigsty Source Package? Use the following command to install Pigsty with one click: bash -c "$(curl -fsSL …

  • FAQ

    In Module: REDIS

    SetupFAQPIGSTY

    ABORT due to existing redis instance use redis_clean = true and redis_safeguard = false to force clean redis data This happens when you run redis.yml to init a redis instance that is already running, and redis_clean is set to false. If redis_clean …

    ABORT due to existing redis instance use redis_clean = true and redis_safeguard = false to force clean redis data This happens when you run redis.yml to init a redis instance that is already running, and redis_clean is set to false. If redis_clean …

  • FAQ

    In Module: NODE

    SetupFAQPIGSTY

    How to configure NTP service? If NTP is not configured, use a public NTP service or sync time with the admin node. If your nodes already have NTP configured, you can leave it there by setting node_ntp_enabled to false. Otherwise, if you have …

    How to configure NTP service? If NTP is not configured, use a public NTP service or sync time with the admin node. If your nodes already have NTP configured, you can leave it there by setting node_ntp_enabled to false. Otherwise, if you have …

  • FAQ

    In Module: MONGO

    SetupFAQPIGSTY

    Install mongosh cat > /etc/yum.repos.d/mongo.repo <<EOF [mongodb-org-7.0] name=MongoDB Repository baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/7.0/x86_64/ gpgcheck=0 enabled=1 EOF yum install -y mongodb-mongosh # or just …

    Install mongosh cat > /etc/yum.repos.d/mongo.repo <<EOF [mongodb-org-7.0] name=MongoDB Repository baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/7.0/x86_64/ gpgcheck=0 enabled=1 EOF yum install -y mongodb-mongosh # or just …

  • FAQ

    In Module: MINIO

    SetupFAQPIGSTY

    Fail to launch multi-node / multi-driver MinIO cluster. In Multi-Driver or Multi-Node mode, MinIO will refuse to start if the data dir is not a valid mount point. Use mounted disks for MinIO data dir rather than some regular directory. You can use …

    Fail to launch multi-node / multi-driver MinIO cluster. In Multi-Driver or Multi-Node mode, MinIO will refuse to start if the data dir is not a valid mount point. Use mounted disks for MinIO data dir rather than some regular directory. You can use …

  • FAQ

    In Module: INFRA

    SetupFAQPIGSTY

    Which components are included in INFRA Ansible for automation, deployment, and administration; Nginx for exposing any WebUI service and serving the yum/apt repo; Self-Signed CA for SSL/TLS certificates; Prometheus for monitoring metrics Grafana for …

    Which components are included in INFRA Ansible for automation, deployment, and administration; Nginx for exposing any WebUI service and serving the yum/apt repo; Self-Signed CA for SSL/TLS certificates; Prometheus for monitoring metrics Grafana for …

  • FAQ

    In Module: ETCD

    SetupFAQPIGSTY

    What is the impact of ETCD failure? ETCD availability is critical for the PGSQL cluster’s HA, which is guaranteed by using multiple nodes. With a 3-node ETCD cluster, if one node is down, the other two nodes can still function normally; and with a …

    What is the impact of ETCD failure? ETCD availability is critical for the PGSQL cluster’s HA, which is guaranteed by using multiple nodes. With a 3-node ETCD cluster, if one node is down, the other two nodes can still function normally; and with a …

  • FAQ

    In Module: DOCKER

    SetupFAQPIGSTY

    How to install Docker ? Install with the docker.yml playbook, targeting at any node managed by Pigsty. ./docker.yml -l <selector>

    How to install Docker ? Install with the docker.yml playbook, targeting at any node managed by Pigsty. ./docker.yml -l <selector>

  • Security

    In Getting Started

    SetupPIGSTYSecurity

    Pigsty already provides a secure-by-default authentication and access control model, which is sufficient for most scenarios. But if you want to further strengthen the security of the system, the following suggestions are for your reference: …

    Pigsty already provides a secure-by-default authentication and access control model, which is sufficient for most scenarios. But if you want to further strengthen the security of the system, the following suggestions are for your reference: …

  • Provisioning

    In Getting Started

    SetupAdminPIGSTYProvision

    Pigsty runs on nodes, which are Bare Metals or Virtual Machines. You can prepare them manually, or using terraform & vagrant for provisioning. Sandbox Pigsty has a sandbox, which is a 4-node deployment with fixed IP addresses and other identifiers. …

    Pigsty runs on nodes, which are Bare Metals or Virtual Machines. You can prepare them manually, or using terraform & vagrant for provisioning. Sandbox Pigsty has a sandbox, which is a 4-node deployment with fixed IP addresses and other identifiers. …

  • Playbooks

    In Getting Started

    SetupPlaybookPIGSTY

    Playbooks are used in Pigsty to install modules on nodes. To run playbooks, just treat them as executables. e.g. run with ./install.yml. Playbooks Here are default playbooks included in Pigsty. Playbook Function install.yml Install Pigsty on current …

    Playbooks are used in Pigsty to install modules on nodes. To run playbooks, just treat them as executables. e.g. run with ./install.yml. Playbooks Here are default playbooks included in Pigsty. Playbook Function install.yml Install Pigsty on current …

  • Planning

    In Getting Started

    SetupAdminPIGSTY

    Pigsty v2.7 planning starts by selecting a deployment topology and preparing the matching hosts, operating systems, network, and administrator access. Planning Checklist Choose a single-node, monitoring-only, or highly available topology from the …

    Pigsty v2.7 planning starts by selecting a deployment topology and preparing the matching hosts, operating systems, network, and administrator access. Planning Checklist Choose a single-node, monitoring-only, or highly available topology from the …

  • Preparation

    In Getting Started

    SetupAdminPIGSTYPreparation

    Node Pigsty supports the Linux kernel and x86_64/amd64 arch, applicable to any node. A “node” refers to a resource that is SSH accessible and offers a bare OS environment, such as a physical machine, a virtual machine, or an OS container equipped …

    Node Pigsty supports the Linux kernel and x86_64/amd64 arch, applicable to any node. A “node” refers to a resource that is SSH accessible and offers a bare OS environment, such as a physical machine, a virtual machine, or an OS container equipped …

  • Configuration

    In Getting Started

    SetupConfigPIGSTY

    Pigsty treats Infra & Database as Code. You can describe the infrastructure & database clusters through a declarative interface. All your essential work is to describe your need in the inventory, then materialize it with a simple idempotent playbook. …

    Pigsty treats Infra & Database as Code. You can describe the infrastructure & database clusters through a declarative interface. All your essential work is to describe your need in the inventory, then materialize it with a simple idempotent playbook. …

  • Offline Install

    In Getting Started

    SetupInstallPIGSTYOffline

    Pigsty’s Standard Installation process requires Internet access, but production database servers are often isolated from the Internet. Therefore, Pigsty offers an offline installation feature, allowing you to complete the installation and deployment …

    Pigsty’s Standard Installation process requires Internet access, but production database servers are often isolated from the Internet. Therefore, Pigsty offers an offline installation feature, allowing you to complete the installation and deployment …

  • Installation

    In Getting Started

    SetupInstallPIGSTY

    Install Pigsty with 4 steps: Prepare, Download, Configure and Install. Also check offline installation if you don’t have the Internet access. Short Version Prepare a fresh Linux x86_64 node that runs compatible OS, then run as a sudo-able user: curl …

    Install Pigsty with 4 steps: Prepare, Download, Configure and Install. Also check offline installation if you don’t have the Internet access. Short Version Prepare a fresh Linux x86_64 node that runs compatible OS, then run as a sudo-able user: curl …