[zalando-postgres-cluster] improve docs (#1498)

This commit is contained in:
Angel Nunez Mencias 2022-04-09 12:44:26 +02:00 committed by GitHub
parent 515e0aea0f
commit f5a6c52ccc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 2 deletions

View File

@ -1,5 +1,5 @@
apiVersion: v2
version: 3.2.0
version: 3.2.1
description: Creates a postgres cluster using the Zalando Postgres operator and local storage
name: zalando-postgres-cluster
appVersion: 1.0.0
@ -21,4 +21,4 @@ dependencies:
annotations:
artifacthub.io/changes: |
- kind: changed
description: Upgraded `common` chart dependency to version `4.3.0`.
description: documented that operator has to be installed before this chart.

View File

@ -68,6 +68,10 @@ helm install zalando-postgres-cluster k8s-at-home/zalando-postgres-cluster -f va
This chart is a wrapper for the [Zalando postgres operator](https://github.com/zalando/postgres-operator) to create
a high available Postgres cluster using nodes local storage.
**IMPORTANT:** You have to install the [Zalando postgres operator](https://github.com/zalando/postgres-operator) before you you
install this chart. This chart does not do it as you typically will deploy multiple instances of it (on per postgres cluster)
while the operator is installed only once.
Features added by this wrapper:
- creates an storage class using local storage in the nodes specified in `persistentVolumes.replicaNodes`. These replicas survive
a tear-down and tear-up of the cluster.

View File

@ -8,6 +8,10 @@
This chart is a wrapper for the [Zalando postgres operator](https://github.com/zalando/postgres-operator) to create
a high available Postgres cluster using nodes local storage.
**IMPORTANT:** You have to install the [Zalando postgres operator](https://github.com/zalando/postgres-operator) before you you
install this chart. This chart does not do it as you typically will deploy multiple instances of it (on per postgres cluster)
while the operator is installed only once.
Features added by this wrapper:
- creates an storage class using local storage in the nodes specified in `persistentVolumes.replicaNodes`. These replicas survive
a tear-down and tear-up of the cluster.