From 16ac0794ad8012135218d37af3541cc53a07fd8a Mon Sep 17 00:00:00 2001 From: Felix Kunde Date: Tue, 23 Jul 2019 13:49:17 +0200 Subject: [PATCH] added feature list to README (#629) * added feature list to README --- README.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ca48db5e8..724cee774 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,39 @@ clusters on Kubernetes (K8s) powered by [Patroni](https://github.com/zalando/spi It is configured only through manifests to ease integration into automated CI/CD pipelines with no access to Kubernetes directly. +### Operator features + +* Rolling updates on Postgres cluster changes +* Volume resize without Pod restarts +* Cloning Postgres clusters +* Logical Backups to S3 Bucket +* Standby cluster from S3 WAL archive +* Configurable for non-cloud environments +* UI to create and edit Postgres cluster manifests + +### PostgreSQL features + +* Supports PostgreSQL 9.6+ +* Streaming replication cluster via Patroni +* Point-In-Time-Recovery with +[pg_basebackup](https://www.postgresql.org/docs/11/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/9.4/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), +[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 two years. @@ -27,6 +60,7 @@ 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) @@ -45,4 +79,4 @@ and start discussions in [the issue tracker](https://github.com/zalando/postgres There are two places to get in touch with the community: 1. The [GitHub issue tracker](https://github.com/zalando/postgres-operator/issues) -2. The #postgres-operator slack channel under [Postgres Slack](https://postgres-slack.herokuapp.com) +2. The **#postgres-operator** [slack channel](https://postgres-slack.herokuapp.com)