feat: add default image refs if none set (#195)

Normally, the official Helm chart packaging will set the image
references used or Coder components. This change applies a default
if the image reference is not set, useful for tests or when
installing from the source repository.

Author: Jonathan Yu

.github/workflows/build.yml

@@ -105,13 +105,7 @@ jobs:
             --namespace=coder-test \
             --wait \
             --debug \
-            --values=examples/kind/kind.values.yaml \
-            --values=examples/images.yaml \
-            --set=coderd.image=docker.io/coderenvs/coder-service:1.24.0 \
-            --set=coderd.serviceSpec.type=ClusterIP \
-            --set=coderd.serviceSpec.externalTrafficPolicy="" \
-            --set=postgres.default.image=docker.io/coderenvs/timescale:1.24.0 \
-            --set=envbox.image=docker.io/coderenvs/envbox:1.24.0
+            --values=examples/kind/kind.values.yaml
 
       - name: Get running info
         if: always()

Chart.yaml

@@ -3,9 +3,11 @@
 # See release.mk - build/helm target.
 apiVersion: v2
 name: coder
-description: Coder moves developer workspaces to your cloud and centralizes their creation and management.
-appVersion: master
-version: 1.19.0
+description: >
+  Coder moves developer workspaces to your cloud and centralizes their
+  creation and management.
+appVersion: 1.25.0
+version: 1.25.0
 # Coder follows the Kubernetes upstream version support policy, and the
 # latest stable release version of Coder supports the previous two minor
 # releases as well as the current release of Kubernetes at time of

examples/images.yaml

@@ -26,7 +26,6 @@ for example in "${EXAMPLES[@]}"; do
     --create-namespace \
     --namespace=coder-test \
     --release-name \
-    --values="$PROJECT_ROOT/examples/images.yaml" \
     --values="$PROJECT_ROOT/examples/$example/$example.values.yaml" \
     --output-dir="$BUILD"
 done

scripts/test_helm.sh

@@ -48,7 +48,7 @@ spec:
       {{- if not .Values.coderd.satellite.enable }}
       initContainers:
         - name: migrations
-          image: {{ .Values.coderd.image | quote }}
+          image: {{ .Values.coderd.image | default (printf "docker.io/coderenvs/coder-service:%s" (.Chart.AppVersion)) | quote }}
           imagePullPolicy: Always
           env:
             - name: HUMAN_LOG
@@ -88,7 +88,7 @@ spec:
       {{- end }}
       containers:
         - name: {{ include "coder.serviceName" . }}
-          image: {{ .Values.coderd.image | quote }}
+          image: {{ .Values.coderd.image | default (printf "docker.io/coderenvs/coder-service:%s" (.Chart.AppVersion)) | quote }}
           imagePullPolicy: Always
           ports:
             - name: tcp-{{ include "coder.serviceName" . }}
@@ -112,7 +112,7 @@ spec:
               # additional features to users for running applications
               # such as dockerd and kubernetes.
             - name: ENVBOX_IMAGE
-              value: {{ .Values.envbox.image | quote }}
+              value: {{ .Values.envbox.image | default (printf "docker.io/coderenvs/envbox:%s" (.Chart.AppVersion)) | quote }}
             - name: CLUSTER_ADDRESS
               value: {{ include "coder.cluster.accessURL" . | quote }}
             - name: NAMESPACE

templates/coderd.yaml

@@ -54,7 +54,7 @@ spec:
       {{- include "coder.serviceTolerations" . | indent 6 }}
       containers:
         - name: timescale
-          image: {{ .Values.postgres.default.image | quote }}
+          image: {{ .Values.postgres.default.image | default (printf "docker.io/coderenvs/timescale:%s" (.Chart.AppVersion)) | quote }}
           imagePullPolicy: Always
           readinessProbe:
             exec:

templates/timescale.yaml

@@ -5,6 +5,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 	"k8s.io/apimachinery/pkg/api/meta"
+	"k8s.io/utils/pointer"
 )
 
 // TestDefault loads the chart and checks metadata.
@@ -18,8 +19,22 @@ func TestDefault(t *testing.T) {
 	require.Equal(t, "coder", metadata.Name, "unexpected chart name")
 	require.False(t, metadata.Deprecated, "chart should not be deprecated")
 
-	coderd := chart.OriginalValues.Coderd
-	require.Equal(t, 1, *coderd.Replicas, "expected 1 replica by default")
+	objs := chart.MustRender(t, nil)
+	deployment := MustFindDeployment(t, objs, "coderd")
+
+	require.Equal(t, pointer.Int32(1), deployment.Spec.Replicas, "expected 1 replica by default")
+	podSpec := deployment.Spec.Template.Spec
+	require.Len(t, podSpec.Containers, 1, "pod spec should have 1 container")
+	require.Equal(t, "docker.io/coderenvs/coder-service:1.25.0", podSpec.Containers[0].Image,
+		"expected default image name")
+	vars := EnvVarsAsMap(podSpec.Containers[0].Env)
+	t.Logf("vars: %v", vars)
+	require.Equal(t, "docker.io/coderenvs/envbox:1.25.0", vars["ENVBOX_IMAGE"],
+		"expected default envbox image name")
+
+	require.Len(t, podSpec.InitContainers, 1, "pod spec should have 1 init container")
+	require.Equal(t, "docker.io/coderenvs/coder-service:1.25.0", podSpec.InitContainers[0].Image,
+		"expected default image name")
 }
 
 // TestNamespace checks that all objects are created in the specified