Fix Jenkins Helm Chart JCasC Configuration Issue with defaultConfig: false (#1443)

Author: itsvshreyas

charts/jenkins/CHANGELOG.md

@@ -12,6 +12,12 @@ Use the following links to reference issues, PRs, and commits prior to v2.6.0.
 The changelog until v1.5.7 was auto-generated based on git commits.
 Those entries include a reference to the git commit to be able to get more details.
 
+## 5.8.80
+
+- Fix [#1435](https://github.com/jenkinsci/helm-charts/issues/1435): Ensure `controller.JCasC.defaultConfig=false` properly prevents generation of all JCasC ConfigMaps
+- Changed the conditional logic in jcasc-config.yaml to only generate ConfigMaps when defaultConfig is true
+- Moved securityRealm and authorizationStrategy configuration into configScripts for better maintainability
+
 ## 5.8.79
 
 Update `jenkins/inbound-agent` to version `3327.v868139a_d00e0-5`

charts/jenkins/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: jenkins
 type: application
 home: https://www.jenkins.io/
-version: 5.8.79
+version: 5.8.80
 appVersion: 2.516.1
 description: >
   Jenkins - Build great things at any scale! As the leading open source automation server, Jenkins provides over 2000 plugins to support building, deploying and automating any project.

charts/jenkins/templates/jcasc-config.yaml

@@ -1,5 +1,5 @@
 {{- $root := . }}
-{{- if .Values.controller.sidecars.configAutoReload.enabled }}
+{{- if and .Values.controller.sidecars.configAutoReload.enabled (not .Values.controller.JCasC.defaultConfig) }}
 {{- range $key, $val := .Values.controller.JCasC.configScripts }}
 {{- if $val }}
 ---
@@ -20,6 +20,7 @@ data:
 {{ tpl $val $| indent 4 }}
 {{- end }}
 {{- end }}
+{{- end }}
 {{- if .Values.controller.JCasC.defaultConfig }}
 ---
 apiVersion: v1
@@ -37,58 +38,6 @@ metadata:
 data:
   jcasc-default-config.yaml: |-
     {{- include "jenkins.casc.defaults" . | nindent 4 }}
-{{- end}}
-{{- $configScripts := toYaml .Values.controller.JCasC.configScripts }}
-{{- if and .Values.controller.JCasC.securityRealm (not (contains "securityRealm:" $configScripts)) (not .Values.controller.JCasC.defaultConfig) }}
----
-apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: {{ template "jenkins.casc.configName" (list "config-securityrealm" $ )}}
-  namespace: {{ template "jenkins.namespace" $root }}
-  labels:
-    "app.kubernetes.io/name": {{ template "jenkins.name" $root}}
-    {{- if .Values.renderHelmLabels }}
-    "helm.sh/chart": "{{ $root.Chart.Name }}-{{ $root.Chart.Version | replace "+" "_" }}"
-    {{- end }}
-    "app.kubernetes.io/managed-by": "{{ $.Release.Service }}"
-    "app.kubernetes.io/instance": "{{ $.Release.Name }}"
-    "app.kubernetes.io/component": "{{ $.Values.controller.componentName }}"
-    {{ template "jenkins.fullname" $root }}-jenkins-config: "true"
-{{- if $root.Values.controller.JCasC.configMapAnnotations }}
-  annotations:
-{{ toYaml $root.Values.controller.JCasC.configMapAnnotations | indent 4 }}
-{{- end }}
-data:
-  securityrealm.yaml: |-
-    jenkins:
-      securityRealm:
-        {{- tpl .Values.controller.JCasC.securityRealm . | nindent 8 }}
-{{- end }}
-{{- if and .Values.controller.JCasC.authorizationStrategy (not (contains "authorizationStrategy:" $configScripts)) (not .Values.controller.JCasC.defaultConfig) }}
----
-apiVersion: v1
-kind: ConfigMap
-metadata:
-  name: {{ template "jenkins.casc.configName" (list "config-authorizationstrategy" $ )}}
-  namespace: {{ template "jenkins.namespace" $root }}
-  labels:
-    "app.kubernetes.io/name": {{ template "jenkins.name" $root}}
-    {{- if .Values.renderHelmLabels }}
-    "helm.sh/chart": "{{ $root.Chart.Name }}-{{ $root.Chart.Version | replace "+" "_" }}"
-    {{- end }}
-    "app.kubernetes.io/managed-by": "{{ $.Release.Service }}"
-    "app.kubernetes.io/instance": "{{ $.Release.Name }}"
-    "app.kubernetes.io/component": "{{ $.Values.controller.componentName }}"
-    {{ template "jenkins.fullname" $root }}-jenkins-config: "true"
-{{- if $root.Values.controller.JCasC.configMapAnnotations }}
-  annotations:
-{{ toYaml $root.Values.controller.JCasC.configMapAnnotations | indent 4 }}
-{{- end }}
-data:
-  authorizationstrategy.yaml: |-
-    jenkins:
-      authorizationStrategy:
-        {{- tpl .Values.controller.JCasC.authorizationStrategy . | nindent 8 }}
-{{- end }}
+{{- else }}
+{{- /* When defaultConfig is false, only process configScripts - no individual security ConfigMaps */}}
 {{- end }}

charts/jenkins/unittests/garbage-collect-test.yaml

@@ -13,14 +13,17 @@ tests:
           of: ConfigMap
       - hasDocuments:
           count: 1
-      - isNotEmpty:
+      - documentIndex: 0
+        isNotEmpty:
           path: data["jcasc-default-config.yaml"]
       - matchRegex:
           path: metadata.labels["helm.sh/chart"]
           pattern: ^jenkins-
-      - matchSnapshot:
+      - documentIndex: 0
+        matchSnapshot:
           path: data["jcasc-default-config.yaml"]
-      - equal:
+      - documentIndex: 0
+        equal:
           path: metadata.namespace
           value: my-namespace
 
@@ -33,12 +36,14 @@ tests:
           of: ConfigMap
       - hasDocuments:
           count: 1
-      - isNotEmpty:
+      - documentIndex: 0
+        isNotEmpty:
           path: data["jcasc-default-config.yaml"]
       - matchRegex:
           path: metadata.labels["helm.sh/chart"]
           pattern: ^jenkins-
-      - matchSnapshot:
+      - documentIndex: 0
+        matchSnapshot:
           path: data["jcasc-default-config.yaml"]
       - equal:
           path: metadata.namespace
@@ -55,13 +60,16 @@ tests:
           of: ConfigMap
       - hasDocuments:
           count: 1
-      - isNotEmpty:
+      - documentIndex: 0
+        isNotEmpty:
           path: data["jcasc-default-config.yaml"]
       - matchRegex:
           path: metadata.labels["helm.sh/chart"]
           pattern: ^jenkins-
-      - matchSnapshot:
+      - documentIndex: 0
+        matchSnapshot:
           path: data["jcasc-default-config.yaml"]
-      - equal:
+      - documentIndex: 0
+        equal:
           path: metadata.namespace
           value: my-namespace

charts/jenkins/unittests/instance-cap-test.yaml

@@ -11,14 +11,17 @@ tests:
           of: ConfigMap
       - hasDocuments:
           count: 1
-      - isNotEmpty:
+      - documentIndex: 0
+        isNotEmpty:
           path: data["jcasc-default-config.yaml"]
       - matchRegex:
           path: metadata.labels["helm.sh/chart"]
           pattern: ^jenkins-
-      - matchSnapshot:
+      - documentIndex: 0
+        matchSnapshot:
           path: data["jcasc-default-config.yaml"]
-      - equal:
+      - documentIndex: 0
+        equal:
           path: metadata.namespace
           value: my-namespace
 
@@ -30,13 +33,16 @@ tests:
           of: ConfigMap
       - hasDocuments:
           count: 1
-      - isNotEmpty:
+      - documentIndex: 0
+        isNotEmpty:
           path: data["jcasc-default-config.yaml"]
       - matchRegex:
           path: metadata.labels["helm.sh/chart"]
           pattern: ^jenkins-
-      - matchSnapshot:
+      - documentIndex: 0
+        matchSnapshot:
           path: data["jcasc-default-config.yaml"]
-      - equal:
+      - documentIndex: 0
+        equal:
           path: metadata.namespace
           value: my-namespace