• Overview

• Requirements

• Build and Setup Instructions

• Configuration

• Examples

• PostgreSQL Operator Container

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

• Test Connections

• Clone a Cluster

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

• Kubernetes 1.5.3+

• PostgreSQL 9.5+ Container

• PostgreSQL Backup Container

• PostgreSQL Upgrade Container

• For OpenShift deployments, Openshift Origin 1.5.1+ or Openshift Container Platform 3.5

With the operator deployed, the pgo command line interface can 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, documented on the Build and Setup page.

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

Some examples of using the pgo command line interface are as follows.

Details on the above pgo command examples are found in the User Guide.

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 located on the Build and Setup page.