Allow overriding the image tag completely (#83)

See issue #82 for details

- Bump Chart major version to 2.0.0
- Add notes on breaking change
- Add `v` prefix to Chart `appVersion` as temporary workaround
- Remove unnecessary Helm template related to image tag
- Completely override image tag using `.Values.image.tag`

---------

Co-authored-by: Nikolai Rodionov <[email protected]>

Author: joshdcu

charts/db-operator/Chart.yaml

@@ -1,13 +1,14 @@
 apiVersion: v2
 type: application
 name: db-operator
-version: 1.42.1
+version: 2.0.0
+
 # ---------------------------------------------------------------------------------
 # -- All supported k8s versions are in the test:
 # --  https://github.com/db-operator/charts/blob/main/.github/workflows/test.yaml
 # ---------------------------------------------------------------------------------
 kubeVersion: ">= 1.30-prerelease"
-appVersion: "2.16.0"
+appVersion: "v2.16.0"
 description: The DB Operator creates databases and make them available in the cluster via Custom Resource.
 home: https://github.com/db-operator/db-operator
 maintainers:

charts/db-operator/README.md

@@ -170,7 +170,12 @@ After changing default `Values`, please execute `make gen_docs` to update the `R
 If there is an breaking change, or something that might make the upgrade complicated, it should be described here
 
 <details>
-  <summary>To `v1.11.0`</summary>
+  <summary>To <code>v2.0.0</code></summary>
+From `v2.0.0` onwards, the `v` prefix will not be automatically added to the image tag. If you are overriding the image tag through `.Values.image.tag` and are relying on this behaviour, please add the `v` prefix manually to the Helm value. Otherwise, no action is required from your side!
+</details>
+
+<details>
+  <summary>To <code>v1.11.0</code></summary>
 Additional selectors were added to the default templates in an attempt to follow the same labelling scheme everywhere, but since selectors are immutable, the upgrade will require removing of the db-operator deployment.
 
 ```bash
@@ -185,7 +190,7 @@ $ helm upgrade db-operator db-operator/db-operator --version 1.11.0
 </details>
 
 <details>
-  <summary>To `v1.10.0`</summary>
+  <summary>To <code>v1.10.0</code></summary>
 
 CRDs are moved to the `templates` folder, so now they are part of the release. It means that after the upgrade, you will get errors about resource ownerships. Thow errors will contain messages about missing `labels` and `annotations`, and the easiest way to fix it, will be just to add the `metadata` that helm can't find. So you can follow those messages one by one and when all the `CRDs` are patched, you'll be able to install the release.
 

charts/db-operator/README.md.gotmpl

@@ -90,7 +90,12 @@ After changing default `Values`, please execute `make gen_docs` to update the `R
 If there is an breaking change, or something that might make the upgrade complicated, it should be described here
 
 <details>
-  <summary>To `v1.11.0`</summary>
+  <summary>To <code>v2.0.0</code></summary>
+From `v2.0.0` onwards, the `v` prefix will not be automatically added to the image tag. If you are overriding the image tag through `.Values.image.tag` and are relying on this behaviour, please add the `v` prefix manually to the Helm value. Otherwise, no action is required from your side!
+</details>
+
+<details>
+  <summary>To <code>v1.11.0</code></summary>
 Additional selectors were added to the default templates in an attempt to follow the same labelling scheme everywhere, but since selectors are immutable, the upgrade will require removing of the db-operator deployment.
 
 ```bash
@@ -105,7 +110,7 @@ $ helm upgrade db-operator db-operator/db-operator --version 1.11.0
 </details>
 
 <details>
-  <summary>To `v1.10.0`</summary>
+  <summary>To <code>v1.10.0</code></summary>
 
 CRDs are moved to the `templates` folder, so now they are part of the release. It means that after the upgrade, you will get errors about resource ownerships. Thow errors will contain messages about missing `labels` and `annotations`, and the easiest way to fix it, will be just to add the `metadata` that helm can't find. So you can follow those messages one by one and when all the `CRDs` are patched, you'll be able to install the release.
 

charts/db-operator/templates/NOTES.txt

@@ -24,12 +24,11 @@ The Release name {{ .Release.Name }}.
 -----------------------------------------------------------------------
 Breaking changes and migration paths:
 
-{{ .Chart.Version }} introduces a new status field "operatorVersion" 
-to the Database CRD. This change is not breaking if your CRDs are
-managed by this Helm chart. Otherwise if you're deploying them separately, 
-please read the migration plan below:
-
-https://github.com/db-operator/charts/tree/main/charts/db-operator#upgrading
+From {{ .Chart.Version }}, the "v" prefix will not be 
+automatically added to the image tag. If you are overriding the image
+tag through ".Values.image.tag" and are relying on this behaviour,
+please add the "v" prefix manually to the Helm value.
+Otherwise, no action is required from your side!
 
 {{- if not .Values.crds.install }}
 -----------------------------------------------------------------------

charts/db-operator/templates/_helpers.tpl

@@ -119,10 +119,3 @@ Image version definition;
 {{- define "image_version" -}}
 {{ default .Chart.AppVersion .Values.image.tag }}
 {{- end -}}
-
-{{/*
-Image version definition using Github Packages format ('v' prefix);
-*/}}
-{{- define "github_packages_image_version" -}}
-{{- printf "v%s" (default .Chart.AppVersion .Values.image.tag) }}
-{{- end -}}

charts/db-operator/templates/controller/deployment.yaml

@@ -42,7 +42,7 @@ spec:
           securityContext:
             {{- toYaml . | nindent 12 }}
           {{- end }}
-          image: "{{ .Values.image.repository }}:{{ template "github_packages_image_version" . }}"
+          image: "{{ .Values.image.repository }}:{{ template "image_version" . }}"
           ports:
           - containerPort: 60000
             name: metrics

charts/db-operator/templates/webhook/deployment.yaml

@@ -41,7 +41,7 @@ spec:
           securityContext:
             {{- toYaml . | nindent 12 }}
           {{- end }}
-          image: "{{ .Values.image.repository }}:{{ template "github_packages_image_version" . }}"
+          image: "{{ .Values.image.repository }}:{{ template "image_version" . }}"
           ports:
           - containerPort: 9443
             name: webhook-server