Skip to content

Commit

Permalink
README: Add Docs and Slack link, add package installations
Browse files Browse the repository at this point in the history
  • Loading branch information
lfittl committed May 6, 2019
1 parent 244a02f commit 64013b0
Showing 1 changed file with 34 additions and 3 deletions.
37 changes: 34 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# pg_auto_failover

[![Slack Status](http://slack.citusdata.com/badge.svg)](https://slack.citusdata.com)
[![Documentation Status](https://readthedocs.org/projects/pg-auto-failover/badge/?version=latest)](https://pg-auto-failover.readthedocs.io/en/latest/?badge=latest)

pg_auto_failover is an extension and service for PostgreSQL that monitors and manages
automated failover for a Postgres cluster. It is optimized for simplicity and correctness.
automated failover for a Postgres cluster. It is optimized for simplicity and correctness and supports Postgres 10 and newer.

![pg_auto_failover Architecture](docs/pg_auto_failover-arch.png?raw=true "pg_auto_failover Architecture")

Expand Down Expand Up @@ -30,14 +33,42 @@ Monitor removes it from the `synchronous_standby_names` setting on the
*primary* node. Until the *secondary* is back to being monitored healthy,
failover and switchover operations are not allowed, preventing data loss.

## Building pg_auto_failover, and first steps with the solution

pg_auto_failover consists of the following parts:

- a PostgreSQL extension named `pgautofailover`,
- a PostgreSQL service to operate the pg_auto_failover monitor,
- a pg_auto_failover keeper to operate your PostgreSQL instances, see `pg_autoctl run`.

## Installing pg_auto_failover from packages

Ubuntu or Debian:

```bash
# Add the repository to your system
curl https://install.citusdata.com/community/deb.sh | sudo bash

# Install pg_auto_failover
sudo apt-get install postgresql-11-auto-failover

# Confirm installation
/usr/bin/pg_autoctl --version
```

Fedora, CentOS, or Red Hat:

```bash
# Add the repository to your system
curl https://install.citusdata.com/community/rpm.sh | sudo bash

# Install pg_auto_failover
sudo yum install -y pg-auto-failover10_11

# Confirm installation
/usr/pgsql-11/bin/pg_autoctl --version
```

## Building pg_auto_failover from source

To build the project, just type `make`.

~~~ bash
Expand Down

0 comments on commit 64013b0

Please sign in to comment.