Add the ability to use global.imageRegistry (#151)

Signed-off-by: Pete Wall <pete.wall@grafana.com>

Author: petewall

charts/alloy-operator/CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * Update Alloy to 1.7.0 (@petewall)
 * Add support for PodDisruptionBudget and topologySpreadConstraints (@petewall)
+* Add the ability to use global.imageRegistry instead of global.image.registry (@petewall)
 
 ## 0.5.2
 

charts/alloy-operator/README.md

@@ -59,27 +59,29 @@ A Helm chart the Alloy Operator, a project to innovate on creating instances of
 |-----|------|---------|-------------|
 | extraArgs | list | `[]` | Additional arguments to pass to the Alloy Operator. |
 
+### Deployment Settings
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| fullnameOverride | string | `""` | Overrides the chart's computed fullname. Used to change the full prefix of resource names. |
+| global.namespaceOverride | string | `""` | Global namespace override. When set, all resources will be deployed to this namespace instead of the Helm release namespace. Takes lower precedence than `namespaceOverride`. |
+| nameOverride | string | `""` | Overrides the chart's name. Used to change the infix in the resource names. |
+| namespaceOverride | string | `""` | Overrides the namespace for all resources deployed by this chart. When empty, resources are deployed to the Helm release namespace. |
+| replicaCount | int | `1` | How many replicas to use for the Alloy Operator Deployment. |
+
 ### Image Settings
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | global.image.pullSecrets | list | `[]` | Global image pull secrets. |
-| global.image.registry | string | `""` | Global image registry override. |
+| global.imageRegistry | string | `""` | Global image registry override. |
 | image.digest | string | `""` | Alloy Operator image digest. If set, will override the tag. Format: sha256:<digest>. |
 | image.pullPolicy | string | `"IfNotPresent"` | The pull policy for images. |
 | image.pullSecrets | list | `[]` | Optional set of image pull secrets. |
 | image.registry | string | `"ghcr.io"` | Alloy Operator image registry |
 | image.repository | string | `"grafana/alloy-operator"` | Alloy Operator image repository |
 | image.tag | string | `""` | Alloy Operator image tag. When empty, the Chart's appVersion is used. |
 
-### Deployment Settings
-
-| Key | Type | Default | Description |
-|-----|------|---------|-------------|
-| global.namespaceOverride | string | `""` | Global namespace override. When set, all resources will be deployed to this namespace instead of the Helm release namespace. Takes lower precedence than `namespaceOverride`. |
-| namespaceOverride | string | `""` | Overrides the namespace for all resources deployed by this chart. When empty, resources are deployed to the Helm release namespace. |
-| replicaCount | int | `1` | How many replicas to use for the Alloy Operator Deployment. |
-
 ### Leader Election Settings
 
 | Key | Type | Default | Description |
@@ -150,10 +152,3 @@ A Helm chart the Alloy Operator, a project to innovate on creating instances of
 | serviceMonitor.scrapeTimeout | string | `"10s"` | Set timeout for scrape |
 | serviceMonitor.targetLabels | list | `[]` | Set of labels to transfer from the Kubernetes Service onto the target |
 | serviceMonitor.telemetryPath | string | `"/metrics"` | Set path to metrics path |
-
-### Other Values
-
-| Key | Type | Default | Description |
-|-----|------|---------|-------------|
-| fullnameOverride | string | `""` | Overrides the chart's computed fullname. Used to change the full prefix of resource names. |
-| nameOverride | string | `""` | Overrides the chart's name. Used to change the infix in the resource names. |

charts/alloy-operator/templates/_helpers.tpl

@@ -56,6 +56,11 @@ app.kubernetes.io/instance: {{ .Release.Name }}
 {{- .Values.namespaceOverride | default ((.Values.global).namespaceOverride) | default .Release.Namespace -}}
 {{- end }}
 
+{{/* Calculate the image registry to use */}}
+{{- define "alloy-operator.imageRegistry" -}}
+{{- ((.Values.global).imageRegistry) | default (((.Values.global).image).registry) | default .Values.image.registry -}}
+{{- end -}}
+
 {{/* Calculate the image identifier to use */}}
 {{- define "alloy-operator.imageIdentifier" -}}
 {{- if .Values.image.digest }}

charts/alloy-operator/templates/deployment.yaml

@@ -40,7 +40,7 @@ spec:
       {{- end }}
       containers:
         - name: {{ .Chart.Name }}
-          image: "{{ .Values.global.image.registry | default .Values.image.registry }}/{{ .Values.image.repository }}{{ include "alloy-operator.imageIdentifier" . }}"
+          image: "{{ include "alloy-operator.imageRegistry" . }}/{{ .Values.image.repository }}{{ include "alloy-operator.imageIdentifier" . }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           args:
             - --health-probe-bind-address=:{{ .Values.service.health.port }}

charts/alloy-operator/tests/image-settings_test.yaml

@@ -0,0 +1,40 @@
+# yamllint disable rule:document-start rule:line-length rule:trailing-spaces
+suite: Test - Alloy Operator - Image Settings
+templates:
+  - deployment.yaml
+tests:
+  - it: uses the default image registry
+    asserts:
+      - matchRegex:
+          path: spec.template.spec.containers[0].image
+          pattern: "^ghcr\\.io/grafana/alloy-operator:"
+
+  - it: uses global.imageRegistry to override the image registry
+    set:
+      global:
+        imageRegistry: my-registry.example.com
+    asserts:
+      - matchRegex:
+          path: spec.template.spec.containers[0].image
+          pattern: "^my-registry\\.example\\.com/grafana/alloy-operator:"
+
+  - it: uses global.image.registry for backwards compatibility
+    set:
+      global:
+        image:
+          registry: old-registry.example.com
+    asserts:
+      - matchRegex:
+          path: spec.template.spec.containers[0].image
+          pattern: "^old-registry\\.example\\.com/grafana/alloy-operator:"
+
+  - it: prefers global.imageRegistry over global.image.registry
+    set:
+      global:
+        imageRegistry: preferred-registry.example.com
+        image:
+          registry: old-registry.example.com
+    asserts:
+      - matchRegex:
+          path: spec.template.spec.containers[0].image
+          pattern: "^preferred-registry\\.example\\.com/grafana/alloy-operator:"

charts/alloy-operator/values.schema.json

@@ -30,12 +30,12 @@
                     "properties": {
                         "pullSecrets": {
                             "type": "array"
-                        },
-                        "registry": {
-                            "type": "string"
                         }
                     }
                 },
+                "imageRegistry": {
+                    "type": "string"
+                },
                 "namespaceOverride": {
                     "type": "string"
                 }

charts/alloy-operator/values.yaml

@@ -1,8 +1,10 @@
 ---
 # -- Overrides the chart's name. Used to change the infix in the resource names.
+# @section -- Deployment Settings
 nameOverride: ""
 # -- Overrides the chart's computed fullname. Used to change the full prefix of
 # resource names.
+# @section -- Deployment Settings
 fullnameOverride: ""
 # -- Overrides the namespace for all resources deployed by this chart. When empty,
 # resources are deployed to the Helm release namespace.
@@ -15,11 +17,11 @@ global:
   # @section -- Deployment Settings
   namespaceOverride: ""
 
-  image:
-    # -- Global image registry override.
-    # @section -- Image Settings
-    registry: ""
+  # -- Global image registry override.
+  # @section -- Image Settings
+  imageRegistry: ""
 
+  image:
     # -- Global image pull secrets.
     # @section -- Image Settings
     pullSecrets: []