☁️ Postgres operator creates and manages PostgreSQL clusters running in Kubernetes https://postgres-operator.readthedocs.io/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Felix Kunde 32e6c135b9
replace statefulset on annotation diff (#1449)
1 day ago
.github Bump v1.6.2 (#1433) 3 weeks ago
charts Remove team label from UI deployment (#1444) 2 weeks ago
cmd Introduce ENABLE_JSON_LOGGING env variable (#1158) 6 months ago
docker upgrade pip to latest version to avoid broken deps (#1357) 2 months ago
docs Fix broken address of user documents (#1443) 2 weeks ago
e2e Improve rolling upgrades and rolling upgrade continue (#1341) 1 month ago
hack hack: update shebang (#755) 1 year ago
kubectl-pg update kubectl-pg plugin (#1264) 2 months ago
manifests Bump v1.6.2 (#1433) 3 weeks ago
mocks Support EBS gp2 to gp3 migration on sync for below 1tb volumes (#1242) 4 months ago
pkg replace statefulset on annotation diff (#1449) 1 day ago
ui Remove team label from UI deployment (#1444) 2 weeks ago
.flake8 Implement runner for e2e tests (#548) 1 year ago
.gitignore Support EBS gp2 to gp3 migration on sync for below 1tb volumes (#1242) 4 months ago
.golangci.yml add .golangci.yml (#422) 2 years ago
.zappr.yaml Min 2 zalando approvers. (#1338) 2 months ago
CODEOWNERS Initial commit for new 1.6 release with Postgres 13 support. (#1257) 4 months ago
CONTRIBUTING.md Update docs for v1.2 (#609) 1 year ago
LICENSE update year in generated code and maintainer info in Dockerfiles (#1298) 3 months ago
MAINTAINERS Initial commit for new 1.6 release with Postgres 13 support. (#1257) 4 months ago
Makefile update kubectl-pg plugin (#1264) 2 months ago
README.md Bump v1.6.2 (#1433) 3 weeks ago
SECURITY.md docs(general): Adding Security.md (#88) 3 years ago
build-ci.sh reflect change in github url (#496) 2 years ago
delivery.yaml bump tp v1.6.0 (#1265) 4 months ago
go.mod update kubectl-pg plugin (#1264) 2 months ago
go.sum Bump v1.6.2 (#1433) 3 weeks ago
mkdocs.yml Initial commit for new 1.6 release with Postgres 13 support. (#1257) 4 months ago
run_operator_locally.sh Add CRD validation (#599) 1 year ago

README.md

Postgres Operator

Tests E2E Tests Coverage Status

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 pooler with PGBouncer
  • Restore and cloning Postgres clusters (incl. major version upgrade)
  • Additionally logical backups to S3 bucket can be configured
  • Standby cluster from S3 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
  • Works well on Amazon AWS, Google Cloud, OpenShift and locally on Kind
  • Support for AWS EBS gp3 migration

PostgreSQL features

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

Notes on Postgres 13 support

If you are new to the operator, you can skip this and just start using the Postgres operator as is, Postgres 13 is ready to go.

The Postgres operator supports Postgres 13 with the new Spilo Image that includes also the recent Patroni version to support PG13 settings. More work on optimizing restarts and rolling upgrades is pending.

If you are already using the Postgres operator in older version with a Spilo 12 Docker image you need to be aware of the changes for the backup path. We introduce the major version into the backup path to smoothen the major version upgrade that is now supported manually.

The new operator configuration can set a compatibility flag enable_spilo_wal_path_compat to make Spilo look for wal segments in the current path but also old format paths. This comes at potential performance costs and should be disabled after a few days.

The newest Spilo 13 image is: registry.opensource.zalan.do/acid/spilo-13:2.0-p6

The last Spilo 12 image is: registry.opensource.zalan.do/acid/spilo-12:1.6-p5

Getting started

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

Supported setups of Postgres and Applications

Features

Documentation

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

Community

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

  1. The GitHub issue tracker
  2. The #postgres-operator slack channel