From f5a6c52ccc5e64b3f0197899081d0cce6b064877 Mon Sep 17 00:00:00 2001 From: Angel Nunez Mencias Date: Sat, 9 Apr 2022 12:44:26 +0200 Subject: [PATCH] [zalando-postgres-cluster] improve docs (#1498) --- charts/stable/zalando-postgres-cluster/Chart.yaml | 4 ++-- charts/stable/zalando-postgres-cluster/README.md | 4 ++++ .../stable/zalando-postgres-cluster/README_CONFIG.md.gotmpl | 4 ++++ 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/charts/stable/zalando-postgres-cluster/Chart.yaml b/charts/stable/zalando-postgres-cluster/Chart.yaml index 3f5d809e..bb2adb86 100644 --- a/charts/stable/zalando-postgres-cluster/Chart.yaml +++ b/charts/stable/zalando-postgres-cluster/Chart.yaml @@ -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. diff --git a/charts/stable/zalando-postgres-cluster/README.md b/charts/stable/zalando-postgres-cluster/README.md index 82d2f6b5..aaf342fe 100644 --- a/charts/stable/zalando-postgres-cluster/README.md +++ b/charts/stable/zalando-postgres-cluster/README.md @@ -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. diff --git a/charts/stable/zalando-postgres-cluster/README_CONFIG.md.gotmpl b/charts/stable/zalando-postgres-cluster/README_CONFIG.md.gotmpl index aedbddf5..b7e621e6 100644 --- a/charts/stable/zalando-postgres-cluster/README_CONFIG.md.gotmpl +++ b/charts/stable/zalando-postgres-cluster/README_CONFIG.md.gotmpl @@ -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.