PostgreSQL Operator Creates/Configures/Manages PostgreSQL Clusters on Kubernetes
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Oct 5, 2018
apis/cr/v1 initial workflow command Nov 9, 2018
apiserver refactor the container resources template processing to fix panic on … Nov 26, 2018
apiservermsgs update to version 3.4.0, fix --archive and xlogdir env var support, m… Nov 21, 2018
bin update the uid script to match the crunchy-containsers version, also … Nov 20, 2018
centos7 updated version information for new release Nov 20, 2018
chart add new pgbackrest template to helm chart to match non-helm structure Nov 26, 2018
conf fix pgo.yaml back to orig Nov 26, 2018
config refactor the container resources template processing to fix panic on … Nov 26, 2018
controller initial workflow command Nov 9, 2018
deploy fix pgbackrest env var processing and remove pgbackrest.conf references Nov 25, 2018
docs/installation/manual-installation fix merge conflicts Oct 11, 2018
examples fix pgbackrest env var processing and remove pgbackrest.conf references Nov 25, 2018
hugo add note that a replica is required for the pgbouncer and pgpool side… Nov 25, 2018
kubeapi Debug Pgtask result Nov 2, 2018
operator refactor the container resources template processing to fix panic on … Nov 26, 2018
pgo-backrest fix pgo-backrest to not do stanza creation now that container-suite p… Nov 21, 2018
pgo update restore command docs Nov 21, 2018
pv add collect container chagnes for 2.1.0, also fix backrest restore jo… Aug 15, 2018
redhat updated version information for new release Nov 20, 2018
rhel7 updated version information for new release Nov 20, 2018
util refactor the container resources template processing to fix panic on … Nov 26, 2018
vendor move to dep for golang dep mgmt, remove godep Sep 12, 2018
.gitignore updated for using gh-pages to handle multiple versions of the docs. Oct 10, 2018
Gopkg.lock move to dep for golang dep mgmt, remove godep Sep 12, 2018
Gopkg.toml move to dep for golang dep mgmt, remove godep Sep 12, 2018
ISSUE_TEMPLATE.md add storage class to issue template Oct 19, 2018
LICENSE.md update copyright dates Apr 3, 2018
Makefile Merge branch 'develop' of https://github.com/CrunchyData/postgres-ope… Nov 16, 2018
PULL_REQUEST_TEMPLATE.md issue #336 add PR & Issue templates Sep 5, 2018
README.adoc updated version information for new release Nov 20, 2018
apiserver.go initial workflow command Nov 9, 2018
btn.png update README, clipboard/code styles Jun 12, 2018
crunchy_logo.png update Crunchy logo Aug 15, 2018
generate-docs.sh update README, clipboard/code styles Jun 12, 2018
postgres-operator.go add operator upgrade framework Oct 29, 2018

README.adoc

Crunchy Data PostgreSQL Operator

Latest Release: 3.4.0 2018-12-13

General

The postgres-operator is a controller that runs within a Kubernetes cluster that provides a means to deploy and manage PostgreSQL clusters.

Documentation

Please view the official Crunchy Data PostgreSQL Operator documentation here. If you are interested in contributing or making an update to the documentation, please view the Contributing Guidelines.

Official Documentation

If you are looking for the latest documentation, please see the develop branch which is considered unstable. The development documentation can be reviewed here

Installation

To build and deploy the Operator on your Kubernetes system, follow the instructions documented on the Installation page.

If you’re seeking to upgrade your existing Operator installation, please visit the Upgrading the Operator page. Also, read the Release Notes as to details on recent changes to the Operator.

What is the Operator?

The postgres-operator is a controller that runs within a Kubernetes cluster that provides a means to deploy and manage PostgreSQL clusters.

Use the postgres-operator to -

  • deploy PostgreSQL containers including streaming replication clusters

  • scale up PostgreSQL clusters with extra replicas

  • add pgpool and metrics sidecars to PostgreSQL clusters

  • apply SQL policies to PostgreSQL clusters

  • assign metadata tags to PostgreSQL clusters

  • maintain PostgreSQL users and passwords

  • perform minor and major upgrades to PostgreSQL clusters

  • load simple CSV and JSON files into PostgreSQL clusters

  • perform database backups

Design

The postgres-operator design incorporates the following concepts -

  • adds Custom Resource Definitions for PostgreSQL to Kubernetes

  • adds controller logic that watches events on PostgreSQL resources

  • provides a command line client (pgo) and REST API for interfacing with the postgres-operator

  • provides for very customized deployments including container resources, storage configurations, and PostgreSQL custom configurations

More design information is found on the How It Works page.

Requirements

The postgres-operator runs on any Kubernetes and Openshift platform that supports Custom Resource Definitions.

The Operator project builds and operates with the following containers -

This Operator is developed and tested on the following operating systems but is known to run on other operating systems -

  • CentOS 7

  • RHEL 7

Installation

To build and deploy the Operator on your Kubernetes system, follow the instructions documented on the Installation page.

If you’re seeking to upgrade your existing Operator installation, please visit the Upgrading the Operator page.

Configuration

The operator is template-driven; this makes it simple to configure both the client and the operator. The configuration options are documented on the Configuration page.

Getting Started

postgres-operator commands are documented on the Getting Started page.