The pgEdge Control Plane is a distributed application designed to simplify the management and orchestration of Postgres databases. It provides a declarative API for defining, deploying, and updating databases across multiple hosts.
You interact with the Control Plane via an HTTP API. Once you've initialized a Control Plane cluster, you can submit requests to the API of any Control Plane server in the cluster to create and manage Postgres databases deployed to your hosts.
At a high level, the pgEdge Control Plane supports:
- deploying Postgres 16, 17, and 18 with support for managed extensions.
- Extension support includes: Spock, LOLOR, Snowflake, pgAudit, PostGIS, pgVector.
- deploying multiple Postgres instances on the same host, enabling efficient resource utilization and consolidation of workloads.
- flexible deployment options for both single-region and multi-region deployments. You can:
- deploy to a single region with optional standby replicas.
- deploy across multiple regions with Spock active-active replication, with optional standby replicas.
- failover and switchover operations via the API to manage primary and replica instances.
- starting, stopping, and restarting database instances via the API.
- managing Spock active-active replication configuration when deploying distributed databases with multiple nodes. Spock provides support for:
- automatic DDL Replication (AutoDDL) by default.
- zero downtime node addition.
- backup and restore operations for databases via pgBackRest integration. This enables:
- scheduled backups with customizable configuration for distributed setups.
- on-demand backups to protect your data and support operational needs.
- in-place restores to enable rapid disaster recovery and minimize downtime.
- database creation from existing pgBackRest repositories, supporting migration and cloning use cases.
- distributed node addition via pgBackRest restore.
- monitoring database operations through detailed task logs, enabling visibility into deployment progress, troubleshooting, and historical activity tracking.
- secure API access with certificate-based authentication.
- performing in-place minor version upgrades of Postgres and supporting components.
Control Plane releases are available as GitHub Releases. Each release includes a change log and downloadable binaries, along with generated Software Bill of Materials (SBOMs).
Control Plane server images are published upon release in the pgEdge Github Container Repository.
A CHANGELOG is available with full release notes for each version.
You can learn more about the release process in our documentation.
The Control Plane is written in Golang, and includes a Docker Compose setup for ease of local development. To get started, you'll need to:
-
Install dependencies: Ensure you have Go 1.20+ and Docker installed, with host networking enabled.
-
Clone the repository:
git clone https://github.com/pgEdge/control-plane.git cd control-plane -
Build and run the Control Plane locally using Docker Compose:
make dev-watch
This development environment will deploy multiple Control Plane servers on your local machine. Each server exposes an HTTP API that you can interact with during local development.
As you make changes to the code, you can rebuild and redeploy the Control Plane servers by running:
make dev-buildFor step-by-step guidance on using this setup, including interacting with the API, see Running the Control Plane locally. If you'd like to contribute to this project, review our Development Process.
This project includes a documentation site maintained in the docs folder, which covers usage guides, architecture concepts, installation instructions, configuration options, and development workflows.
It uses MkDocs with the Material theme to generate styled static HTML documentation from Markdown files in the docs directory.
The documentation can be accessed locally at http://localhost:8000 using:
make docs
