From aba8a8e0ed0b2ee1c3937ca6239acc1f54e07fe7 Mon Sep 17 00:00:00 2001 From: Felix Kunde <felix-kunde@gmx.de> Date: Tue, 1 Jun 2021 11:07:49 +0200 Subject: [PATCH] reflect change in docs --- docs/developer.md | 9 ++++----- docs/quickstart.md | 6 ------ 2 files changed, 4 insertions(+), 11 deletions(-) diff --git a/docs/developer.md b/docs/developer.md index 6f4e0893..67a05145 100644 --- a/docs/developer.md +++ b/docs/developer.md @@ -314,13 +314,12 @@ Please, reflect your changes in tests, for example in: For the CRD-based configuration, please update the following files: * the default [OperatorConfiguration](../manifests/postgresql-operator-default-configuration.yaml) -* the Helm chart's [values-crd file](../charts/postgres-operator/values.yaml) * the CRD's [validation](../manifests/operatorconfiguration.crd.yaml) +* the CRD's validation in the [helm chart](../charts/postgres-operator/crds/operatorconfigurations.yaml) -Reflect the changes in the ConfigMap configuration as well (note that numeric -and boolean parameters have to use double quotes here): -* [ConfigMap](../manifests/configmap.yaml) manifest -* the Helm chart's default [values file](../charts/postgres-operator/values.yaml) +Add new options also to the Helm chart's [values file](../charts/postgres-operator/values.yaml) file. +It follows the OperatorConfiguration CRD layout. Nested values will be flattened for the ConfigMap. +Last but no least, update the [ConfigMap](../manifests/configmap.yaml) manifest example as well. ### Updating documentation diff --git a/docs/quickstart.md b/docs/quickstart.md index fe083a61..a90c90f4 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -81,12 +81,6 @@ the repo root. With Helm v3 installed you should be able to run: helm install postgres-operator ./charts/postgres-operator ``` -To use CRD-based configuration you need to specify the [values-crd yaml file](../charts/postgres-operator/values-crd.yaml). - -```bash -helm install postgres-operator ./charts/postgres-operator -f ./charts/postgres-operator/values-crd.yaml -``` - The chart works with both Helm 2 and Helm 3. The `crd-install` hook from v2 will be skipped with warning when using v3. Documentation for installing applications with Helm 2 can be found in the [v2 docs](https://v2.helm.sh/docs/). -- GitLab