refactor(templates)!: centralize Secret names in gitea.secret.*.name helpers

The names of the Secrets rendered by the chart were built inline in each template and, for two of
them, in ad-hoc chart-wide helpers. The same name therefore existed in several places (Deployment
volumes, ServiceMonitor credentials, the Secret templates themselves), which made every rename a
multi-file change and allowed the references to drift apart unnoticed - the Helm unit tests render
one template at a time and cannot detect a mismatching secretName.

All Secret names are now defined once in templates/gitea/_secrets.tpl:

  gitea.secret.config.name        -> <fullname>-config
  gitea.secret.gpg.name           -> <fullname>-gpg-key (or signing.existingSecret)
  gitea.secret.init.name          -> <fullname>-init
  gitea.secret.inlineConfig.name  -> <fullname>-inline-config
  gitea.secret.metrics.name       -> <fullname>-metrics

gitea.gpg-key-secret-name and gitea.metrics-secret-name are removed from _helpers.tpl accordingly.

A checksum/inlineConfig pod annotation is added as well. After the inline configuration had been
split out of secret_config.yaml, changes to it were no longer covered by any checksum annotation and
did not trigger a rollout of the Deployment.

Finally the metadata attributes of the Secret templates are sorted alphabetically as required by the
chart conventions.

BREAKING CHANGE: two Secrets are renamed. The config Secret changes from <fullname> to
<fullname>-config and the metrics Secret from <fullname>-metrics-secret to <fullname>-metrics. Helm
replaces both on upgrade; references to them from outside the chart have to be adjusted.

Co-authored-by: Copilot <copilot@github.com>

templates/_helpers.tpl

@@ -507,10 +507,6 @@ https
   {{- end -}}
 {{- end -}}
 
-{{- define "gitea.gpg-key-secret-name" -}}
-{{ default (printf "%s-gpg-key" (include "gitea.fullname" .)) .Values.signing.existingSecret }}
-{{- end -}}
-
 {{- define "gitea.serviceAccountName" -}}
 {{ .Values.serviceAccount.name | default (include "gitea.fullname" .) }}
 {{- end -}}
@@ -553,6 +549,3 @@ https
   {{- toYaml $probe -}}
 {{- end -}}
 
-{{- define "gitea.metrics-secret-name" -}}
-{{ default (printf "%s-metrics-secret" (include "gitea.fullname" .)) }}
-{{- end -}}

templates/gitea/_secrets.tpl

@@ -0,0 +1,23 @@
+{{/* vim: set filetype=mustache: */}}
+
+{{/* names */}}
+
+{{- define "gitea.secret.config.name" -}}
+{{ include "gitea.fullname" . }}-config
+{{- end }}
+
+{{- define "gitea.secret.gpg.name" -}}
+{{ default (printf "%s-gpg-key" (include "gitea.fullname" .)) .Values.signing.existingSecret }}
+{{- end }}
+
+{{- define "gitea.secret.init.name" -}}
+{{ include "gitea.fullname" . }}-init
+{{- end }}
+
+{{- define "gitea.secret.inlineConfig.name" -}}
+{{ include "gitea.fullname" . }}-inline-config
+{{- end }}
+
+{{- define "gitea.secret.metrics.name" -}}
+{{ include "gitea.fullname" . }}-metrics
+{{- end }}

templates/gitea/deployment.yaml

@@ -28,6 +28,7 @@ spec:
     metadata:
       annotations:
         checksum/config: {{ include (print $.Template.BasePath "/gitea/secret_config.yaml") . | sha256sum }}
+        checksum/inlineConfig: {{ include (print $.Template.BasePath "/gitea/secret_inlineConfig.yaml") . | sha256sum }}
         {{- range $idx, $value := .Values.gitea.ldap }}
         checksum/ldap_{{ $idx }}: {{ include "gitea.ldap_settings" (list $idx $value) | sha256sum }}
         {{- end }}
@@ -419,18 +420,18 @@ spec:
       volumes:
         - name: init
           secret:
-            secretName: {{ include "gitea.fullname" . }}-init
+            secretName: {{ include "gitea.secret.init.name" . }}
             defaultMode: 110
         - name: config
           secret:
-            secretName: {{ include "gitea.fullname" . }}
+            secretName: {{ include "gitea.secret.config.name" . }}
             defaultMode: 110
         {{- if gt (len .Values.extraVolumes) 0 }}
         {{- toYaml .Values.extraVolumes | nindent 8 }}
         {{- end }}
         - name: inline-config-sources
           secret:
-            secretName: {{ include "gitea.fullname" . }}-inline-config
+            secretName: {{ include "gitea.secret.inlineConfig.name" . }}
         {{- range $idx, $value := .Values.gitea.additionalConfigSources }}
         - name: additional-config-sources-{{ $idx }}
           {{- toYaml $value | nindent 10 }}
@@ -440,7 +441,7 @@ spec:
         {{- if .Values.signing.enabled }}
         - name: gpg-private-key
           secret:
-            secretName: {{ include "gitea.gpg-key-secret-name" . }}
+            secretName: {{ include "gitea.secret.gpg.name" . }}
             items:
               - key: privateKey
                 path: private.asc

templates/gitea/secret_config.yaml

@@ -2,10 +2,10 @@
 apiVersion: v1
 kind: Secret
 metadata:
-  name: {{ include "gitea.fullname" . }}
-  namespace: {{ .Values.namespace | default .Release.Namespace }}
   labels:
     {{- include "gitea.labels" . | nindent 4 }}
+  name: {{ include "gitea.secret.config.name" . }}
+  namespace: {{ .Values.namespace | default .Release.Namespace }}
 type: Opaque
 stringData:
 {{ (.Files.Glob "scripts/init-containers/config/*.sh").AsConfig | indent 2 }}

templates/gitea/secret_gpg.yaml

@@ -6,10 +6,10 @@
 apiVersion: v1
 kind: Secret
 metadata:
-  name: {{ include "gitea.gpg-key-secret-name" . }}
-  namespace: {{ .Values.namespace | default .Release.Namespace }}
   labels:
     {{- include "gitea.labels" . | nindent 4 }}
+  name: {{ include "gitea.secret.gpg.name" . }}
+  namespace: {{ .Values.namespace | default .Release.Namespace }}
 type: Opaque
 data:
   privateKey: {{ .Values.signing.privateKey | b64enc }}

templates/gitea/secret_init.yaml

@@ -1,10 +1,10 @@
 apiVersion: v1
 kind: Secret
 metadata:
-  name: {{ include "gitea.fullname" . }}-init
-  namespace: {{ .Values.namespace | default .Release.Namespace }}
   labels:
     {{- include "gitea.labels" . | nindent 4 }}
+  name: {{ include "gitea.secret.init.name" . }}
+  namespace: {{ .Values.namespace | default .Release.Namespace }}
 type: Opaque
 stringData:
 {{ (.Files.Glob "scripts/init-containers/init/*.sh").AsConfig | indent 2 }}

templates/gitea/secret_inlineConfig.yaml

@@ -2,10 +2,10 @@
 apiVersion: v1
 kind: Secret
 metadata:
-  name: {{ include "gitea.fullname" . }}-inline-config
-  namespace: {{ .Values.namespace | default .Release.Namespace }}
   labels:
     {{- include "gitea.labels" . | nindent 4 }}
+  name: {{ include "gitea.secret.inlineConfig.name" . }}
+  namespace: {{ .Values.namespace | default .Release.Namespace }}
 type: Opaque
 stringData:
   {{- include "gitea.inline_configuration" . | nindent 2 }}

templates/gitea/secret_metrics.yaml

@@ -2,10 +2,10 @@
 apiVersion: v1
 kind: Secret
 metadata:
-  name: {{ include "gitea.metrics-secret-name" . }}
-  namespace: {{ .Values.namespace | default .Release.Namespace }}
   labels:
     {{- include "gitea.labels" . | nindent 4 }}
+  name: {{ include "gitea.secret.metrics.name" . }}
+  namespace: {{ .Values.namespace | default .Release.Namespace }}
 type: Opaque
 data:
   token: {{ .Values.gitea.metrics.token  | b64enc }}

templates/gitea/serviceMonitor.yaml

@@ -36,7 +36,7 @@ spec:
     authorization:
       type: Bearer
       credentials:
-        name: {{ include "gitea.metrics-secret-name" . }}
+        name: {{ include "gitea.secret.metrics.name" . }}
         key: token
         optional: false
     {{- end }}

unittests/helm/deployment/HA.yaml

@@ -5,6 +5,7 @@ release:
 templates:
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: fails with multiple replicas and "GIT_GC_REPOS" enabled
     template: templates/gitea/secret_config.yaml

unittests/helm/deployment/basic.yaml

@@ -5,6 +5,7 @@ release:
 templates:
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: renders a deployment
     template: templates/gitea/deployment.yaml

unittests/helm/deployment/deployment-additional-config.yaml

@@ -5,6 +5,7 @@ release:
 templates:
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: Renders a deployment
     template: templates/gitea/deployment.yaml

unittests/helm/deployment/extraEnvSourceFile.yaml

@@ -5,6 +5,7 @@ release:
 templates:
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: uses direct execution when extraEnvSourceFile is not set
     template: templates/gitea/deployment.yaml

unittests/helm/deployment/extraInitContainers.yaml

@@ -5,6 +5,7 @@ release:
 templates:
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: Render the deployment (default)
     asserts:

unittests/helm/deployment/image-configuration.yaml

@@ -8,6 +8,7 @@ chart:
 templates:
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: default values
     template: templates/gitea/deployment.yaml

unittests/helm/deployment/openshift.yaml

@@ -5,6 +5,7 @@ release:
 templates:
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: renders openshift-compatible defaults for chart-managed containers
     template: templates/gitea/deployment.yaml

unittests/helm/deployment/probes.yaml

@@ -5,6 +5,7 @@ release:
 templates:
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: renders default liveness probe
     template: templates/gitea/deployment.yaml

unittests/helm/deployment/sidecar-container.yaml

@@ -5,6 +5,7 @@ release:
 templates:
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: supports adding a sidecar container
     template: templates/gitea/deployment.yaml

unittests/helm/deployment/signing-disabled.yaml

@@ -5,6 +5,7 @@ release:
 templates:
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: skips gpg init container
     template: templates/gitea/deployment.yaml

unittests/helm/deployment/signing-enabled.yaml

@@ -5,6 +5,7 @@ release:
 templates:
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: adds gpg init container
     template: templates/gitea/deployment.yaml

unittests/helm/deployment/ssh-configuration.yaml

@@ -5,6 +5,7 @@ release:
 templates:
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: supports defining SSH log level for root based image
     template: templates/gitea/deployment.yaml

unittests/helm/metric-secret/metrics-secret-servicemonitor-enabled.yaml

@@ -25,7 +25,7 @@ tests:
         containsDocument:
           kind: Secret
           apiVersion: v1
-          name: gitea-unittests-metrics-secret
+          name: gitea-unittests-metrics
       - isNotNullOrEmpty:
           path: metadata.labels
       - equal:

unittests/helm/serviceaccount/reference.yaml

@@ -6,6 +6,7 @@ templates:
   - templates/gitea/serviceAccount.yaml
   - templates/gitea/deployment.yaml
   - templates/gitea/secret_config.yaml
+  - templates/gitea/secret_inlineConfig.yaml
 tests:
   - it: does not modify the deployment by default
     template: templates/gitea/deployment.yaml

unittests/helm/servicemonitor/servicemonitor-enabled.yaml

@@ -65,6 +65,6 @@ tests:
               authorization:
                 type: Bearer
                 credentials:
-                  name: gitea-unittests-metrics-secret
+                  name: gitea-unittests-metrics
                   key: token
                   optional: false