https://github.com/pgedge/pgedge
pgEdge Distributed Postgres
https://github.com/pgedge/pgedge
Last synced: over 1 year ago
JSON representation
pgEdge Distributed Postgres
- Host: GitHub
- URL: https://github.com/pgedge/pgedge
- Owner: pgEdge
- Created: 2024-01-19T01:36:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-27T14:08:32.000Z (over 1 year ago)
- Last Synced: 2025-01-19T16:17:14.416Z (over 1 year ago)
- Homepage:
- Size: 3.52 MB
- Stars: 101
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Support: supported-components.md
Awesome Lists containing this project
README

Our Distributed Multi-master Postgres runs nicely (on most all flavors of Linux) in vm's, containers, bare metal, or a localhost sandbox.
You can join our [Discord Server](https://discord.com/invite/QaqHy52sUd) or learn more about [our sponsor](https://pgedge.com/company).
Also check out our [Docker](https://github.com/pgEdge/pgedge-docker/blob/main/README.md) or [K8's Helm](https://github.com/pgEdge/pgedge-helm/blob/main/examples/README.md) examples.
## Getting started
Start by installling CLI on a single node (per below) and then looking next at quick tutorial for setting up a test cluster
Node Pre-Reqs
- Use a non-root user from the command line
- Tested with Python 3.9 thru 3.12
- Python 3.9 on EL8, EL9, SLE-15, & Amazon Linux 2023
- Python 3.10 on Ubuntu 22.04
- Python 3.11 on Debian 12
- Python 3.12 on Ubuntu 24.04
- optional: config [password-less sudo](http://lussier.io/index.php/2023/04/07/passwordless-sudo/) if you want to autostart components with systemctl
- optional config [password-less ssh](http://lussier.io/index.php/2023/06/07/passwordless-ssh-to-localhost-2) to localhost for using `localhost cluster` commands
```
python3 -c "$(curl -fsSL https://pgedge-upstream.s3.amazonaws.com/REPO/install.py)"
```
## Try a cluster tutorial using [localhost](cli/tutorials/localhost-cluster.md) or [vm's](cli/tutorials/vm-cluster.md)
## Learn more about our family of [supported components](supported-components.md)
## Get a feel for our powerful CLI commands
#####
**[spock](cli/SPOCK.md)** - Custom configure world's best logical & multi-master distributed Postgres
#####
**[localhost](cli/LOCALHOST.md)** - Create a localhost test cluster
#####
**[cluster](cli/CLUSTER.md)** - Define & control a cluster of nodes
#####
**[ace](cli/ACE.md)** - The Anti-Chaos Engine efficiently assures your distributed data is in sync
#####
**[db](cli/DB.md)** - Configure and control distributed PostgreSQL DB's
#####
**[um](cli/UM.md)** - Update Manager commands
#####
**[service](cli/SERVICE.md)** - Service control commands
## CLI Examples
##### Sandbox with latest *Postgres 16*, *Spock* & *Snowflake* installed into default *postgres* db
```
./pgedge install pg16 --start : install spock : install snowflake
```
##### Create database *db1* owned by *denis* & setting up *Spock* & *Snowflake* into *pg16*
```
./pgedge setup -U denis -P secret -d db1 --pg_ver 16
```
##### Create a cluster *cl1* on localhost with two nodes, then install *northwind sample app* on cluster
```
./pgedge localhost cluster-create cl1 2 : cluster app-install cl1 northwind
```