Skip to content

Commit 6869c2c

Browse files
authored
Added image to readme, added/rewrote features. (zalando#1031)
* Added image to readme, added/rewrote features.
1 parent 0c6655a commit 6869c2c

File tree

3 files changed

+3514
-9
lines changed

3 files changed

+3514
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,27 @@
88

99
<img src="docs/diagrams/logo.png" width="200">
1010

11-
The Postgres Operator enables highly-available [PostgreSQL](https://www.postgresql.org/)
11+
The Postgres Operator delivers an easy to run highly-available [PostgreSQL](https://www.postgresql.org/)
1212
clusters on Kubernetes (K8s) powered by [Patroni](https://github.com/zalando/spilo).
13-
It is configured only through manifests to ease integration into automated CI/CD
14-
pipelines with no access to Kubernetes directly.
13+
It is configured only through Postgres manifests (CRDs) to ease integration into automated CI/CD
14+
pipelines with no access to Kubernetes API directly, promoting infrastructure as code vs manual operations.
1515

1616
### Operator features
1717

18-
* Rolling updates on Postgres cluster changes
19-
* Volume resize without Pod restarts
20-
* Database connection pooler
21-
* Cloning Postgres clusters
22-
* Logical backups to S3 Bucket
18+
* Rolling updates on Postgres cluster changes, incl. quick minor version updates
19+
* Live volume resize without pod restarts (AWS EBS, others pending)
20+
* Database connection pooler with PGBouncer
21+
* Restore and cloning Postgres clusters (incl. major version upgrade)
22+
* Additionally logical backups to S3 bucket can be configured
2323
* Standby cluster from S3 WAL archive
2424
* Configurable for non-cloud environments
25+
* Basic credential and user management on K8s, eases application deployments
2526
* UI to create and edit Postgres cluster manifests
27+
* Works well on Amazon AWS, Google Cloud, OpenShift and locally on Kind
2628

2729
### PostgreSQL features
2830

29-
* Supports PostgreSQL 9.6+
31+
* Supports PostgreSQL 12, starting from 9.6+
3032
* Streaming replication cluster via Patroni
3133
* Point-In-Time-Recovery with
3234
[pg_basebackup](https://www.postgresql.org/docs/11/app-pgbasebackup.html) /
@@ -55,6 +57,10 @@ production for over two years.
5557
For a quick first impression follow the instructions of this
5658
[tutorial](docs/quickstart.md).
5759

60+
## Supported setups of Postgres and Applications
61+
62+
![Features](docs/diagrams/neutral_operator.png)
63+
5864
## Documentation
5965

6066
There is a browser-friendly version of this documentation at

0 commit comments

Comments
 (0)