scdl8

README

Postgres Operator

The Postgres Operator delivers an easy to run highly-available PostgreSQL clusters on Kubernetes (K8s) powered by Patroni. It is configured only through Postgres manifests (CRDs) to ease integration into automated CI/CD pipelines with no access to Kubernetes API directly, promoting infrastructure as code vs manual operations.

Operator features

• Rolling updates on Postgres cluster changes, incl. quick minor version updates
• Live volume resize without pod restarts (AWS EBS, PVC)
• Database connection pooling with PGBouncer
• Support fast in place major version upgrade. Supports global upgrade of all clusters.
• Restore and cloning Postgres clusters on AWS, GCS and Azure
• Additionally logical backups to S3 or GCS bucket can be configured
• Standby cluster from S3 or GCS WAL archive
• Configurable for non-cloud environments
• Basic credential and user management on K8s, eases application deployments
• Support for custom TLS certificates
• UI to create and edit Postgres cluster manifests
• Support for AWS EBS gp2 to gp3 migration, supporting iops and throughput configuration
• Compatible with OpenShift

PostgreSQL features

• Supports PostgreSQL 15, starting from 10+
• Streaming replication cluster via Patroni
• Point-In-Time-Recovery with pg_basebackup / WAL-E via Spilo
• Preload libraries: bg_mon, pg_stat_statements, pgextwlist, pg_auth_mon
• Incl. popular Postgres extensions such as decoderbufs, hypopg, pg_cron, pg_partman, pg_stat_kcache, pgq, plpgsql_check, postgis, set_user and timescaledb

The Postgres Operator has been developed at Cosmicrocks and is being used in production for over five years.

Supported Postgres & K8s versions

Release	Postgres versions	K8s versions	Golang
v1.10.*	10 → 15	1.25+	1.19.8
v1.9.0	10 → 15	1.25+	1.18.9
v1.8.*	9.5 → 14	1.20 → 1.24	1.17.4
v1.7.1	9.5 → 14	1.20 → 1.24	1.16.9

Getting started

For a quick first impression follow the instructions of this tutorial.

Supported setups of Postgres and Applications

Documentation

There is a browser-friendly version of this documentation at scdl8.readthedocs.io

• How it works
• Installation
• The Postgres experience on K8s
• The Postgres Operator UI
• DBA options - from RBAC to backup
• Build, debug and extend the operator
• Configuration options
• Postgres manifest reference
• Command-line options and environment variables

Community

There are two places to get in touch with the community:

1. The GitHub issue tracker
2. The #scdl8 slack channel