PostgreSQL Management Appliance
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
aptly
ci
cockpit
debian
doc
grafana
image-sources
images
node-exporter
pgbackrest
pgbadger
portal
postgresql
prometheus
sql-exporter
tmate
vagrant
.gitignore
.gitlab-ci.yml
.vimrc
LICENSE
Makefile
README.md

README.md

Intro

Elephant Shed is a web-based PostgreSQL management front-end that bundles several utilities and applications for use with PostgreSQL. It currently manages single-node Debian/Ubuntu PostgreSQL servers and appliances.

The main components are:

Supported PostgreSQL versions, via https://apt.postgresql.org:

  • 10
  • 9.6
  • 9.5
  • 9.4

Supported distributions:

  • Debian Stretch (9)
  • Ubuntu Bionic (18.04)
  • RHEL/CentOS (in planning)

Download

Packages, Vagrant boxes, images: https://elephant-shed.io/#download

Documentation

The documentation is located at https://elephant-shed.io/doc/

Screenshots

Portal

The main portal webpage has links to all bundled applications. It also shows the PostgreSQL status, and allows starting/stopping the clusters, backup, and log reports.

Figure: Elephant Shed portal

Cockpit

For managing clusters and services, Cockpit is used.

Figure: Cockpit Cluster Service

Monitoring - Prometheus

Prometheus is a metric based monitoring system for servers and services. It collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and can trigger alerts if some condition is observed to be true.

Figure: Prometheus graphing the load

Monitoring - Grafana

Grafana bundles metrics collected by Prometheus and presents them in a dashboard.

Figure: Grafana - PostgreSQL Server Overview

DBA Tool - pgAdmin4

pgAdmin4 is a management tool for PostgreSQL to help DBAs execute many different tasks. It provides user management, DDL functionality, an interactive SQL shell, and more.

Figure: pgAdmin4

Backup - pgBackRest

The Elephant Shed comes with a preinstalled backup solution, pgBackRest.

Figure: pgBackRest Backup via Cockpit

Reporting - pgBadger

A pgBadger report is created for each PostgreSQL instance.

Figure: pgBadger overview

Web Terminal - Shell In A Box

Shell In A Box is a convenient web based terminal.

Remote Control - tmate

tmate is a fork of the popular terminal multiplexer tmux, tweaked for instant terminal sharing. It is preconfigured to connect to a relay server and enables the user to share the current terminal with a third party using a secret token.

Figure: tmate

License

The Elephant Shed itself is licensed under the GPLv3 (https://www.gnu.org/licenses/gpl-3.0.html).

All bundled components are Free/Open-Source software with a known and approved open source license.

Support

Elephant Shed is an open source project, developed and maintained by credativ.

For the Elephant Shed PostgreSQL appliance, credativ offers comprehensive technical support with service level agreements, which are also available on 365 days a year and 24 hours a day as an option.

Installation and integration support, as well as an introduction in Elephant Shed PostgreSQL appliance is of course also part of credativ's services. If you are interested, please feel free to contact us.