Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zalando/postgres-operator
Postgres operator creates and manages PostgreSQL clusters running in Kubernetes
https://github.com/zalando/postgres-operator
cluster data-infrastructure database-as-a-service golang kubernetes managed-services operator postgres postgres-operator postgresql
Last synced: 4 days ago
JSON representation
Postgres operator creates and manages PostgreSQL clusters running in Kubernetes
- Host: GitHub
- URL: https://github.com/zalando/postgres-operator
- Owner: zalando
- License: mit
- Created: 2017-05-12T09:26:07.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-26T00:18:14.000Z (about 2 months ago)
- Last Synced: 2024-10-29T09:51:58.262Z (about 1 month ago)
- Topics: cluster, data-infrastructure, database-as-a-service, golang, kubernetes, managed-services, operator, postgres, postgres-operator, postgresql
- Language: Go
- Homepage: https://postgres-operator.readthedocs.io/
- Size: 32.9 MB
- Stars: 4,335
- Watchers: 65
- Forks: 979
- Open Issues: 658
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ccamel - zalando/postgres-operator - Postgres operator creates and manages PostgreSQL clusters running in Kubernetes (Go)
- awesome-dok - Zalando PostgreSQL Operator - one of the first Operators for PostgreSQL, open-source, used by [Zalando](https://www.zalando.com/) internally and loved by Community. (Databases / PostgreSQL)
- awesome-dok - Zalando PostgreSQL Operator - one of the first Operators for PostgreSQL, open-source, used by [Zalando](https://www.zalando.com/) internally and loved by Community. (Databases / PostgreSQL)
README
# Postgres Operator
[](https://coveralls.io/github/zalando/postgres-operator?branch=master)
The Postgres Operator delivers an easy to run highly-available [PostgreSQL](https://www.postgresql.org/)
clusters on Kubernetes (K8s) powered by [Patroni](https://github.com/zalando/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
* Compatible with OpenShift
### PostgreSQL features
* Supports PostgreSQL 16, starting from 12+
* Streaming replication cluster via Patroni
* Point-In-Time-Recovery with
[pg_basebackup](https://www.postgresql.org/docs/16/app-pgbasebackup.html) /
[WAL-E](https://github.com/wal-e/wal-e) via [Spilo](https://github.com/zalando/spilo)
* Preload libraries: [bg_mon](https://github.com/CyberDem0n/bg_mon),
[pg_stat_statements](https://www.postgresql.org/docs/16/pgstatstatements.html),
[pgextwlist](https://github.com/dimitri/pgextwlist),
[pg_auth_mon](https://github.com/RafiaSabih/pg_auth_mon)
* Incl. popular Postgres extensions such as
[decoderbufs](https://github.com/debezium/postgres-decoderbufs),
[hypopg](https://github.com/HypoPG/hypopg),
[pg_cron](https://github.com/citusdata/pg_cron),
[pg_partman](https://github.com/pgpartman/pg_partman),
[pg_stat_kcache](https://github.com/powa-team/pg_stat_kcache),
[pgq](https://github.com/pgq/pgq),
[pgvector](https://github.com/pgvector/pgvector),
[plpgsql_check](https://github.com/okbob/plpgsql_check),
[postgis](https://postgis.net/),
[set_user](https://github.com/pgaudit/set_user) and
[timescaledb](https://github.com/timescale/timescaledb)
The Postgres Operator has been developed at Zalando and is being used in
production for over five years.
## Supported Postgres & K8s versions
| Release | Postgres versions | K8s versions | Golang |
| :-------- | :---------------: | :---------------: | :-----: |
| v1.13.0 | 12 → 16 | 1.27+ | 1.22.5 |
| v1.12.0 | 11 → 16 | 1.27+ | 1.22.3 |
| v1.11.0 | 11 → 16 | 1.27+ | 1.21.7 |
| v1.10.1 | 10 → 15 | 1.21+ | 1.19.8 |
| v1.9.0 | 10 → 15 | 1.21+ | 1.18.9 |
| v1.8.2 | 9.5 → 14 | 1.20 → 1.24 | 1.17.4 |
## Getting started
For a quick first impression follow the instructions of this
[tutorial](docs/quickstart.md).
## Supported setups of Postgres and Applications
## Documentation
There is a browser-friendly version of this documentation at
[postgres-operator.readthedocs.io](https://postgres-operator.readthedocs.io)
* [How it works](docs/index.md)
* [Installation](docs/quickstart.md#deployment-options)
* [The Postgres experience on K8s](docs/user.md)
* [The Postgres Operator UI](docs/operator-ui.md)
* [DBA options - from RBAC to backup](docs/administrator.md)
* [Build, debug and extend the operator](docs/developer.md)
* [Configuration options](docs/reference/operator_parameters.md)
* [Postgres manifest reference](docs/reference/cluster_manifest.md)
* [Command-line options and environment variables](docs/reference/command_line_and_environment.md)