Skip to content

Commit 16ac079

Browse files
authored
added feature list to README (zalando#629)
* added feature list to README
1 parent 0aff809 commit 16ac079

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,39 @@ clusters on Kubernetes (K8s) powered by [Patroni](https://github.com/zalando/spi
1313
It is configured only through manifests to ease integration into automated CI/CD
1414
pipelines with no access to Kubernetes directly.
1515

16+
### Operator features
17+
18+
* Rolling updates on Postgres cluster changes
19+
* Volume resize without Pod restarts
20+
* Cloning Postgres clusters
21+
* Logical Backups to S3 Bucket
22+
* Standby cluster from S3 WAL archive
23+
* Configurable for non-cloud environments
24+
* UI to create and edit Postgres cluster manifests
25+
26+
### PostgreSQL features
27+
28+
* Supports PostgreSQL 9.6+
29+
* Streaming replication cluster via Patroni
30+
* Point-In-Time-Recovery with
31+
[pg_basebackup](https://www.postgresql.org/docs/11/app-pgbasebackup.html) /
32+
[WAL-E](https://github.com/wal-e/wal-e) via [Spilo](https://github.com/zalando/spilo)
33+
* Preload libraries: [bg_mon](https://github.com/CyberDem0n/bg_mon),
34+
[pg_stat_statements](https://www.postgresql.org/docs/9.4/pgstatstatements.html),
35+
[pgextwlist](https://github.com/dimitri/pgextwlist),
36+
[pg_auth_mon](https://github.com/RafiaSabih/pg_auth_mon)
37+
* Incl. popular Postgres extensions such as
38+
[decoderbufs](https://github.com/debezium/postgres-decoderbufs),
39+
[hypopg](https://github.com/HypoPG/hypopg),
40+
[pg_cron](https://github.com/citusdata/pg_cron),
41+
[pg_partman](https://github.com/pgpartman/pg_partman),
42+
[pg_stat_kcache](https://github.com/powa-team/pg_stat_kcache),
43+
[pgq](https://github.com/pgq/pgq),
44+
[plpgsql_check](https://github.com/okbob/plpgsql_check),
45+
[postgis](https://postgis.net/),
46+
[set_user](https://github.com/pgaudit/set_user) and
47+
[timescaledb](https://github.com/timescale/timescaledb)
48+
1649
The Postgres Operator has been developed at Zalando and is being used in
1750
production for over two years.
1851

@@ -27,6 +60,7 @@ There is a browser-friendly version of this documentation at
2760
[postgres-operator.readthedocs.io](https://postgres-operator.readthedocs.io)
2861

2962
* [How it works](docs/index.md)
63+
* [Installation](docs/quickstart.md#deployment-options)
3064
* [The Postgres experience on K8s](docs/user.md)
3165
* [The Postgres Operator UI](docs/operator-ui.md)
3266
* [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
4579

4680
There are two places to get in touch with the community:
4781
1. The [GitHub issue tracker](https://github.com/zalando/postgres-operator/issues)
48-
2. The #postgres-operator slack channel under [Postgres Slack](https://postgres-slack.herokuapp.com)
82+
2. The **#postgres-operator** [slack channel](https://postgres-slack.herokuapp.com)

0 commit comments

Comments
 (0)