PostgreSQL Operator

Overview

The PostgreSQL Operator provides a Kubernetes operator capability for managing PostgreSQL Clusters deployed within a Kubernetes.

The PostgreSQL Operator leverages Kubernetes Third Party Resources to define custom resource type pgcluster, pgbackups, and pgupgrades.

Once those custom objects are defined, Kubernetes provides the ability to create and manage those objects similar to any other native Kubernetes object.

The PostgreSQL Operator runs within Kubernetes detecting these new custom object types being created or removed.

Once the objects are detected, the PostgreSQL Operator enables users to perform operations across the Kubernetes environment, including:

• Create Cluster

• Destroy Cluster

• Backup Cluster

• Scale a Cluster

• Restore Cluster

• Upgrade Cluster

• View PVC

What actually gets created on the Kube cluster for a pgcluster resource is defined as a deployment strategy. Strategies are documented in detail here Deployment Strategies

Requirements

• Kubernetes 1.5.3+

• PostgreSQL 9.5+ Container

• PostgreSQL Backup Container

• PostgreSQL Upgrade Container

Example Commands Usage

Some examples of using the command line interface:

Display Cluster Information

pgo show cluster all
pgo show cluster db1 db2 db3
pgo show cluster mycluster
pgo show cluster mycluster --show-secrets=true

Create Cluster

pgo create cluster mycluster

Scale Cluster

pgo scale mycluster --replica-count=2

Delete a Cluster

pgo delete cluster mycluster

Backup Cluster

pgo create backup mycluster

Restore Cluster

pgo create cluster myrestore --backup-pvc=mypvc --backup-path=foo-backups/2017-03-21-15-57-21

Upgrade Cluster (minor Postgres version upgrade)

pgo create upgrade mycluster

Upgrade Cluster (major Postgres version upgrade from 9.5 to 9.6)

pgo create upgrade mycluster --upgrade-type=major

View PVC

pgo show pvc mypvc

Details on the pgo commands are found in the User Guide

postgres-operator Container

In the following diagram, the postgres operator client, pgo, is shown interacting with the postgres operator that runs within a Kubernetes cluster. The operator is responsible for creating or modifying PostgreSQL databases deployed within the Kube cluster.

The operator funtionality runs in a Pod deployed to your Kubernetes cluster. The postgres-operator Docker container is available on Dockerhub.

You can also build the Docker image for postgres-operator using the build instructions Build and Setup.

Command Line Interface

With the operator deployed, you can then use the pgo command line interface to execute commands that the postgres-operator understands and reacts to.

You can download a pre-built pgo CLI binary from the Releases page on the github repository or build it yourself using the build instructions.

Build and Setup Instructions

Build instructions are documented here. Build and Setup

Configuration

You can configure both the client and the operator. The configuration options are documented here. Configuration