crunchydata/postgres-operator repository overview

⁠PostgreSQL Operator

⁠Run your own production-grade PostgreSQL-as-a-Service on Kubernetes!

The Crunchy PostgreSQL Operator⁠ automates and simplifies deploying and managing open source PostgreSQL clusters on Kubernetes and other Kubernetes-enabled Platforms by providing the essential features you need to keep your PostgreSQL clusters up and running, including:

⁠PostgreSQL Cluster Provisioning

Create, Scale, & Delete PostgreSQL clusters with ease⁠, while fully customizing your Pods and PostgreSQL configuration!

⁠High-Availability

Safe, automated failover backed by a distributed consensus based high-availability solution⁠. Uses Pod Anti-Affinity⁠ to help resiliency; you can configure how aggressive this can be! Failed primaries automatically heal, allowing for faster recovery time.

Support for standby PostgreSQL clusters⁠ that work both within an across multiple Kubernetes clusters⁠.

⁠Disaster Recovery

Backups and restores leverage the open source pgBackRest⁠ utility and includes support for full, incremental, and differential backups as well as efficient delta restores⁠. Set how long you want your backups retained for. Works great with very large databases!

⁠TLS

Secure communication between your applications and data servers by enabling TLS for your PostgreSQL servers⁠, including the ability to enforce that all of your connections to use TLS.

⁠Monitoring

Track the health of your PostgreSQL clusters using the open source pgMonitor⁠ library.

⁠PostgreSQL User Management

Quickly add and remove users from your PostgreSQL clusters with powerful commands. Manage password expiration policies or use your preferred PostgreSQL authentication scheme.

⁠Upgrade Management

Safely apply PostgreSQL updates with minimal availability impact to your PostgreSQL clusters.

⁠Advanced Replication Support

Choose between asynchronous replication⁠ and synchronous replication⁠ for workloads that are sensitive to losing transactions.

⁠Clone

Create new clusters from your existing clusters with a simple pgo clone⁠ command.

⁠Connection Pooling

Use pgBouncer⁠ for connection pooling

⁠Node Affinity

Have your PostgreSQL clusters deployed to Kubernetes Nodes⁠ of your preference

⁠Scheduled Backups

Choose the type of backup (full, incremental, differential) and how frequently you want it to occur⁠ on each PostgreSQL cluster.

⁠Backup to S3

Store your backups in Amazon S3⁠ or any object storage system that supports the S3 protocol. The PostgreSQL Operator can backup, restore, and create new clusters from these backups.

⁠Multi-Namespace Support

You can control how the PostgreSQL Operator leverages Kubernetes Namespaces⁠ with several different deployment models:

• Deploy the PostgreSQL Operator and all PostgreSQL clusters to the same namespace
• Deploy the PostgreSQL Operator to one namespaces, and all PostgreSQL clusters to a different namespace
• Deploy the PostgreSQL Operator to one namespace, and have your PostgreSQL clusters managed acrossed multiple namespaces
• Dynamically add and remove namespaces managed by the PostgreSQL Operator using the pgo create namespace and pgo delete namespace commands

⁠Full Customizability

The Crunchy PostgreSQL Operator makes it easy to get your own PostgreSQL-as-a-Service up and running on Kubernetes-enabled platforms, but we know that there are further customizations that you can make. As such, the Crunchy PostgreSQL Operator allows you to further customize your deployments, including:

• Selecting different storage classes for your primary, replica, and backup storage
• Select your own container resources class for each PostgreSQL cluster deployment; differentiate between resources applied for primary and replica clusters!
• Use your own container image repository, including support imagePullSecrets and private repositories
• Customize your PostgreSQL configuration⁠
• Bring your own trusted certificate authority (CA) for use with the Operator API server
• Override your PostgreSQL configuration for each cluster

⁠How it Works

The Crunchy PostgreSQL Operator extends Kubernetes to provide a higher-level abstraction for rapid creation and management of PostgreSQL clusters. The Crunchy PostgreSQL Operator leverages a Kubernetes concept referred to as "Custom Resources⁠” to create several custom resource definitions (CRDs)⁠ that allow for the management of PostgreSQL clusters.

⁠Supported Platforms

The Crunchy PostgreSQL Operator is tested on the following Platforms:

• Kubernetes 1.13+
• OpenShift 3.11+
• Google Kubernetes Engine (GKE), including Anthos
• VMware Enterprise PKS 1.3+

⁠Storage

The Crunchy PostgreSQL Operator is tested with a variety of different types of Kubernetes storage and Storage Classes, including:

• Rook
• StorageOS
• Google Compute Engine persistent volumes
• NFS
• HostPath

and more. We have had reports of people using the PostgreSQL Operator with other Storage Classes⁠ as well.

We know there are a variety of different types of Storage Classes⁠ available for Kubernetes and we do our best to test each one, but due to the breadth of this area we are unable to verify PostgreSQL Operator functionality in each one. With that said, the PostgreSQL Operator is designed to be storage class agnostic and has been demonstrated to work with additional Storage Classes. Storage is a rapidly evolving field in Kubernetes and we will continue to adapt the PostgreSQL Operator to modern Kubernetes storage standards.

This container is maintained by Crunchy Data⁠ and is provided under the Crunchy Data Developer Program⁠.