Merge pull request #172 from jonstacks/use-app-version-in-helm-chart

Use Chart appVersion if tag is not specified
ngrok · Mar 16, 2023 · a2095d6 · a2095d6
2 parents d3e4be4 + 45574a1
commit a2095d6
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 11 deletions.
diff --git a/helm/ingress-controller/CHANGELOG.md b/helm/ingress-controller/CHANGELOG.md
@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.6.1
+### Fixed
+- Default the image tag to the chart's `appVersion` for predictable installs. Previously, the helm chart would default to the `latest` image tag which can have breaking changes, notably with CRDs.
+
 ## 0.6.0
 ### Changed
 - Ingress Class has Default set to false [#109](https://github.com/ngrok/kubernetes-ingress-controller/pull/109)

diff --git a/helm/ingress-controller/Chart.yaml b/helm/ingress-controller/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v2
 name: kubernetes-ingress-controller
 description: A Kubernetes ingress controller built using ngrok.
-version: 0.6.0
+version: 0.6.1
 appVersion: 0.4.0
 keywords:
   - ngrok

diff --git a/helm/ingress-controller/README.md b/helm/ingress-controller/README.md
@@ -51,7 +51,7 @@ To uninstall the chart:
 | `replicaCount`               | The number of controllers and agents to run.                                                                          | `1`                                   |
 | `image.registry`             | The ngrok ingress controller image registry.                                                                          | `docker.io`                           |
 | `image.repository`           | The ngrok ingress controller image repository.                                                                        | `ngrok/kubernetes-ingress-controller` |
-| `image.tag`                  | The ngrok ingress controller image tag.                                                                               | `latest`                              |
+| `image.tag`                  | The ngrok ingress controller image tag. Defaults to the chart's appVersion if not specified                           | `""`                                  |
 | `image.pullPolicy`           | The ngrok ingress controller image pull policy.                                                                       | `IfNotPresent`                        |
 | `image.pullSecrets`          | An array of imagePullSecrets to be used when pulling the image.                                                       | `[]`                                  |
 | `ingressClass.name`          | The name of the ingress class to use.                                                                                 | `ngrok`                               |

diff --git a/helm/ingress-controller/templates/_helpers.tpl b/helm/ingress-controller/templates/_helpers.tpl
@@ -82,6 +82,6 @@ Return the ngrok/ingress-controller image name
 {{- define "kubernetes-ingress-controller.image" -}}
 {{- $registryName := .Values.image.registry -}}
 {{- $repositoryName := .Values.image.repository -}}
-{{- $tag := .Values.image.tag | toString -}}
+{{- $tag := .Values.image.tag | default .Chart.AppVersion | toString -}}
 {{- printf "%s/%s:%s" $registryName $repositoryName $tag -}}
 {{- end -}}
diff --git a/helm/ingress-controller/tests/__snapshot__/controller-deployment_test.yaml.snap b/helm/ingress-controller/tests/__snapshot__/controller-deployment_test.yaml.snap
diff --git a/helm/ingress-controller/tests/__snapshot__/controller-serviceaccount_test.yaml.snap b/helm/ingress-controller/tests/__snapshot__/controller-serviceaccount_test.yaml.snap
diff --git a/helm/ingress-controller/tests/__snapshot__/ingress-class_test.yaml.snap b/helm/ingress-controller/tests/__snapshot__/ingress-class_test.yaml.snap
diff --git a/helm/ingress-controller/values.yaml b/helm/ingress-controller/values.yaml
@@ -26,13 +26,13 @@ replicaCount: 1
 
 ## @param image.registry The ngrok ingress controller image registry.
 ## @param image.repository The ngrok ingress controller image repository.
-## @param image.tag The ngrok ingress controller image tag.
+## @param image.tag The ngrok ingress controller image tag. Defaults to the chart's appVersion if not specified
 ## @param image.pullPolicy The ngrok ingress controller image pull policy.
 ## @param image.pullSecrets An array of imagePullSecrets to be used when pulling the image.
 image:
   registry: docker.io
   repository: ngrok/kubernetes-ingress-controller
-  tag: latest
+  tag: ""
   pullPolicy: IfNotPresent
   ## Example
   ## pullSecrets: