doc: clarification on Helm charts (cloudnative-pg#47)

Signed-off-by: Jaime Silvela <[email protected]> Signed-off-by: Gabriele Bartolini <[email protected]> Co-authored-by: Philippe Scorsolini <[email protected]> Co-authored-by: Gabriele Bartolini <[email protected]>
bozorgmehr96 · Oct 20, 2022 · 0e5af94 · 0e5af94
1 parent eb828b3
commit 0e5af94
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,12 @@
 # CloudNativePG Helm Chart
 
 Helm chart to install the
-[CloudNativePG operator](https://cloudnative-pg.io),originally created and sponsored by 
+[CloudNativePG operator](https://cloudnative-pg.io), originally created and sponsored by
 [EDB](https://www.enterprisedb.com/) to manage PostgreSQL workloads on any supported Kubernetes cluster
 running in private, public, or hybrid cloud environments.
 
+**NOTE**: supports only the latest point release of the CloudNativePG operator.
+
 ## Deployment using the latest release
 
 ```console
@@ -43,6 +45,8 @@ expect that Prometheus and Grafana are already part of that infrastructure:
 there you can install CloudNativePG, the suggested metrics and the
 provided Grafana dashboard.
 
+**NOTE**: supports only the latest point release of the CloudNativePG operator.
+
 ![Example of dashboard](dashboard.png)
 
 ## Requirements

diff --git a/RELEASE.md b/RELEASE.md
@@ -3,15 +3,26 @@
 This repo contains two helm charts: [cloudnative-pg](./charts/cloudnative-pg)
 and [cnpg-sandbox](./charts/cnpg-sandbox). Both the charts are available
 through a single [repository](https://cloudnative-pg.github.io/charts), but
-should be released separately as their versioning might be unlinked and the
-latter depend on the former.
+should be released separately as their versioning might be unlinked, and the
+latter depends on the former.
+
+**IMPORTANT** we should run the below procedures against the latest point
+release of the CloudNativePG operator. I.e. even if we have several release
+branches in CNPG, we will only target the most advanced point
+release (e.g. 1.17.1)
 
 ## How to release cloudnative-pg
 
-In order to release `vX.Y.Z` of the `cloudnative-pg` chart, follow these steps:
+In order to create a new release of the `cloudnative-pg` chart,
+follow these steps:
 
+1. take note of the current value of the release: see `.version`
+   in `charts/cloudnative-pg/Chart.yaml`
+1. decide which version to create, depending on the kind of jump of the
+   CloudNativePG release, following semver semantics.
+   For this document, let's call it `X.Y.Z`
 1. create a branch named `release/cloudnative-pg-vX.Y.Z` and switch to it
-1. bump the `.version` in the [Chart.yaml](./charts/cloudnative-pg/Chart.yaml) file to `vX.Y.Z`
+1. update the `.version` in the [Chart.yaml](./charts/cloudnative-pg/Chart.yaml) file to `"X.Y.Z"`
 1. update everything else as required, e.g. if releasing due to a new
    cloudnative-pg version being released, you might want to update the
    following:
@@ -22,16 +33,26 @@ In order to release `vX.Y.Z` of the `cloudnative-pg` chart, follow these steps:
        [remoteBuild](https://github.com/kubernetes-sigs/kustomize/blob/master/examples/remoteBuild.md)
        running: `kustomize build
        https://github.com/cloudnative-pg/cloudnative-pg/tree/release-1.16/config/helm/\?ref=v1.16.0`,
-       take care to set the correct version as ref (v1.15.1 in the example
-       command). Also notice that crd generation should be guarded from
-       `.Values.crds.create`, so please pay attention to maintain that.
-    1. all the needed files in the
+       **take care to set the correct release branch and version as ref**
+        (v1.15.1 in the example
+       command). \
+       It might be easier to run `kustomize build config/helm` from the
+      `cloudnative-pg` repo, with the desired release branch checked out, and
+      copy the result to `./charts/cloudnative-pg/templates/crds/crds.yaml`.
+    1. NOTE: please keep the guards for `.Values.crds.create`, i.e.
+      `{{- if .Values.crds.create }}` and `{{- end }}` after you copy the CRD
+      into `templates/crds/crds.yaml`.
+    1. to update the files in the
        [templates](./charts/cloudnative-pg/templates) directory, you can diff
-       the previous release yaml w.r.t. the new one to know what should be
-       updated (e.g. `vimdiff
+       the previous CNPG release yaml against the new one, to find what
+       should be updated (e.g. `vimdiff
        https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/main/releases/cnpg-1.15.0.yaml
-       https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/main/releases/cnpg-1.15.1.yaml`)
+       https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/main/releases/cnpg-1.15.1.yaml`) \
+       Or, from the `cloudnative-pg` repo, with the desired release branch checked out,
+       `vimdiff releases/cnpg-1.15.0.yaml releases/cnpg-1.15.1.yaml`
     1. update [values.yaml](./charts/cloudnative-pg/values.yaml) if needed
+    1. NOTE: updating `values.yaml` just for the CNPG  verision may not be
+      necessary, as the value should default to the `appVersion` in `Chart.yaml`
   1. run `make docs schema` to regenerate the docs and the values schema in case it is needed
   1. `git commit -S -s -m "Release cloudnative-pg-vX.Y.Z" --edit` and add all
      the informations you wish below the commit message.
@@ -45,17 +66,24 @@ In order to release `vX.Y.Z` of the `cloudnative-pg` chart, follow these steps:
      message to be `Release cloudnative-pg-vX.Y.Z`**
   1. a tag `cloudnative-pg-vX.Y.Z` will be automatically created by an action,
      which will ten trigger the release action, check they both are successful.
-  1. once done you should be able to run helm repo `helm repo add cnpg https://cloudnative-pg.github.io/charts; helm repo update; helm search repo cnpg` and be ableto see the new version `vX.Y.Z` as `CHART VERSION` for `cloudnative-pg`
+  1. once done you should be able to run helm repo `helm repo add cnpg https://cloudnative-pg.github.io/charts; helm repo update; helm search repo cnpg` and be able to see the new version `vX.Y.Z` as `CHART VERSION` for `cloudnative-pg`
 
 ## How to release cnpg-sandbox
 
 cnpg-sandbox is an umbrella chart which depends on the cloudnative-pg chart, therefore in case the only change required is bumping cloudnative-pg version, its release should be done only once its dependency has been successfully released.
 
-In order to release `vX.Y.Z` of the `cnpg-sandbox` chart, follow these steps:
+In order to create a new release of the `cnpg-sandbox` chart, follow
+these steps:
 
+1. take note of the current value of the release: see `.version`
+   in `charts/cnpg-sandbox/Chart.yaml`
+1. decide which version to create, depending on the kind of jump of the
+   cloudnative-pg chart release, following semver semantics.
+   For this document, let's call it `X.Y.Z`
 1. create a branch `release/cnpg-sandbox-vX.Y.Z` and switch to it
-1. bump the `.version` in the [Chart.yaml](./charts/cnpg-sanbox/Chart.yaml) file to `vX.Y.Z`
+1. update the `.version` in the [Chart.yaml](./charts/cnpg-sandbox/Chart.yaml) file to `"X.Y.Z"`
 1. update everything else as required, e.g. if releasing due to a new cloudnative-pg chart being released:
+  1. bump the `.appVersion` in `Chart.yaml`
   1. bump `.dependecies[0].version` for the `cloudnative-pg` chart in the aforementioned `Chart.yaml` file
   1. update the [values.yaml](./charts/cnpg-sandbox/Chart.yaml) file if needed
   1. run `helm dependency update charts/cnpg-sandbox` to sync the [Chart.lock](./charts/cnpg-sandbox/Chart.lock) to the new dependencies
@@ -72,4 +100,4 @@ In order to release `vX.Y.Z` of the `cnpg-sandbox` chart, follow these steps:
    message to be `Release cnpg-sandbox-vX.Y.Z`**
 1. a tag `cnpg-sandbox-vX.Y.Z` will be automatically created by an action,
    which will ten trigger the release action, check they both are successful.
-1. once done you should be able to run helm repo `helm repo add cnpg https://cloudnative-pg.github.io/charts; helm repo update; helm search repo cnpg` and be ableto see the new version `vX.Y.Z` as `CHART VERSION` for `cnpg-sanbox`
+1. once done you should be able to run helm repo `helm repo add cnpg https://cloudnative-pg.github.io/charts; helm repo update; helm search repo cnpg` and be able to see the new version `vX.Y.Z` as `CHART VERSION` for `cnpg-sandbox`