feat(template): Support registry-specific Helm values

Author: Techassi

template/Makefile.j2

@@ -76,3 +76,9 @@ run-dev: check-nix check-kubernetes
 
 stop-dev: check-nix check-kubernetes
 	nix run --extra-experimental-features "nix-command flakes" -f. tilt -- down
+
+helm-install:
+	helm install \
+		--values deploy/helm/airflow-operator/values.yaml \
+		--values deploy/helm/airflow-operator/values/$(OCI_REGISTRY_HOSTNAME).yaml \
+		airflow-operator deploy/helm/airflow-operator

template/Tiltfile

@@ -1,16 +1,18 @@
+# Load the metadata first, so that we immediately get access to the operator name
+meta = read_json('nix/meta.json')
+operator_name = meta['operator']['name']
+
 # If tilt_options.json exists read it and load the default_registry value from it
 settings = read_json('tilt_options.json', default={})
-registry = settings.get('default_registry', 'oci.stackable.tech/sandbox')
+registry = settings.get('default_registry', 'oci.stackable.tech')
+repository = settings.get('default_repository', 'sandbox' + '/' + operator_name)
 
 # Configure default registry either read from config file above, or with default value of "oci.stackable.tech/sandbox"
 default_registry(registry)
 
-meta = read_json('nix/meta.json')
-operator_name = meta['operator']['name']
-
 custom_build(
-    registry + '/' + operator_name,
-    'make regenerate-nix && nix-build . -A docker --argstr dockerName "${EXPECTED_REGISTRY}/' + operator_name + '" && ./result/load-image | docker load',
+    registry + '/' + repository,
+    'make regenerate-nix && nix-build . -A docker --argstr dockerName "${EXPECTED_REGISTRY}/' + repository + '" && ./result/load-image | docker load',
     deps=['rust', 'Cargo.toml', 'Cargo.lock', 'default.nix', "nix", 'build.rs', 'vendor'],
     ignore=['*.~undo-tree~'],
     # ignore=['result*', 'Cargo.nix', 'target', *.yaml],
@@ -28,13 +30,15 @@ k8s_kind('DaemonSet', image_json_path='{.spec.template.metadata.annotations.inte
 # supported by helm(set).
 helm_values = settings.get('helm_values', None)
 
-helm_override_image_repository = 'image.repository=' + registry + '/' + operator_name
+helm_override_image_registry = 'image.registry=' + registry
+helm_override_image_repository = 'image.repository=' + repository
 
 k8s_yaml(helm(
    'deploy/helm/' + operator_name,
    name=operator_name,
    namespace="stackable-operators",
    set=[
+      helm_override_image_registry,
       helm_override_image_repository,
    ],
    values=helm_values,

template/deploy/helm/[[operator]]/.helmignore

@@ -6,6 +6,8 @@
 # Patterns to ignore when building packages.
 # This supports shell glob matching, relative path matching, and
 # negation (prefixed with !). Only one pattern per line.
+# Ignore the file itself
+.helmignore
 .DS_Store
 # Common VCS dirs
 .git/
@@ -26,3 +28,5 @@
 .idea/
 *.tmproj
 .vscode/
+# Partial, unmerged, registry-specific values files
+values/

template/deploy/helm/[[operator]]/templates/_helpers.tpl

@@ -77,3 +77,10 @@ Labels for Kubernetes objects created by helm test
 {{- define "operator.testLabels" -}}
 helm.sh/test: {{ include "operator.chart" . }}
 {{- end }}
+
+{{/*
+Build the full container image reference.
+*/}}
+{{- define "operator.image" -}}
+{{- printf "%s/%s:%s" .Values.image.registry .Values.image.repository (.Values.image.tag | default .Chart.AppVersion) -}}
+{{- end }}

template/deploy/helm/[[operator]]/templates/deployment.yaml.j2

@@ -16,7 +16,7 @@ spec:
   template:
     metadata:
       annotations:
-        internal.stackable.tech/image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+        internal.stackable.tech/image: {{ include "operator.image" . }}
         checksum/config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }}
         {{- with .Values.podAnnotations }}
         {{- toYaml . | nindent 8 }}
@@ -38,7 +38,7 @@ spec:
         - name: {{ include "operator.appname" . }}
           securityContext:
             {{- toYaml .Values.securityContext | nindent 12 }}
-          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          image: {{ include "operator.image" . }}
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
@@ -71,6 +71,15 @@ spec:
             - name: OPERATOR_SERVICE_NAME
               value: {{ include "operator.fullname" . }}
 
+            # The URI of the image registry, like "oci.stackable.tech". Used to derive product image
+            # name.
+            - name: IMAGE_REGISTRY_URI
+              value: {{ .Values.image.registry }}
+
+            # The image repository, like "sdp/airflow-operator"
+            - name: IMAGE_REPOSITORY
+              value: {{ .Values.image.repository }}
+
             # Operators need to know the node name they are running on, to e.g. discover the
             # Kubernetes domain name from the kubelet API.
             - name: KUBERNETES_NODE_NAME

template/deploy/helm/[[operator]]/values/oci.stackable.tech.yaml

@@ -0,0 +1,5 @@
+---
+# Values overlay for chart packages published to oci.stackable.tech.
+image:
+  registry: oci.stackable.tech
+  repository: sdp/airflow-operator