JCasC 'welcome-message' configuration example does not work

[jenkinsci]

JCasC 'welcome-message' configuration example does not work

[torstenwalter]

jenkins.url template is defined in:

helm-charts/charts/jenkins/templates/_helpers.tpl

Lines 51 to 68 in 91a2a39

	{{/*
	Returns the Jenkins URL
	*/}}
	{{- define "jenkins.url" -}}
	{{- if .Values.master.jenkinsUrl }}
	{{- .Values.master.jenkinsUrl }}
	{{- else }}
	{{- if .Values.master.ingress.hostName }}
	{{- if .Values.master.ingress.tls }}
	{{- default "https" .Values.master.jenkinsUrlProtocol }}://{{ .Values.master.ingress.hostName }}{{ default "" .Values.master.jenkinsUriPrefix }}
	{{- else }}
	{{- default "http" .Values.master.jenkinsUrlProtocol }}://{{ .Values.master.ingress.hostName }}{{ default "" .Values.master.jenkinsUriPrefix }}
	{{- end }}
	{{- else }}
	{{- default "http" .Values.master.jenkinsUrlProtocol }}://{{ template "jenkins.fullname" . }}:{{.Values.master.servicePort}}{{ default "" .Values.master.jenkinsUriPrefix }}
	{{- end}}
	{{- end}}
	{{- end -}}

That should give you an idea which values you can set to configure it.

This template is then used to configure it via JCasC:

helm-charts/charts/jenkins/templates/_helpers.tpl

Lines 159 to 163 in 91a2a39

	unclassified:
	location:
	adminAddress: {{ default "" .Values.master.jenkinsAdminEmail }}
	url: {{ template "jenkins.url" . }}
	{{- end -}}

[larrycai]

jenkins.url template is defined in:

helm-charts/charts/jenkins/templates/_helpers.tpl

Lines 51 to 68 in 91a2a39

	{{/*
	Returns the Jenkins URL
	*/}}
	{{- define "jenkins.url" -}}
	{{- if .Values.master.jenkinsUrl }}
	{{- .Values.master.jenkinsUrl }}
	{{- else }}
	{{- if .Values.master.ingress.hostName }}
	{{- if .Values.master.ingress.tls }}
	{{- default "https" .Values.master.jenkinsUrlProtocol }}://{{ .Values.master.ingress.hostName }}{{ default "" .Values.master.jenkinsUriPrefix }}
	{{- else }}
	{{- default "http" .Values.master.jenkinsUrlProtocol }}://{{ .Values.master.ingress.hostName }}{{ default "" .Values.master.jenkinsUriPrefix }}
	{{- end }}
	{{- else }}
	{{- default "http" .Values.master.jenkinsUrlProtocol }}://{{ template "jenkins.fullname" . }}:{{.Values.master.servicePort}}{{ default "" .Values.master.jenkinsUriPrefix }}
	{{- end}}
	{{- end}}
	{{- end -}}

That should give you an idea which values you can set to configure it.

This template is then used to configure it via JCasC:

helm-charts/charts/jenkins/templates/_helpers.tpl

Lines 159 to 163 in 91a2a39

	unclassified:
	location:
	adminAddress: {{ default "" .Values.master.jenkinsAdminEmail }}
	url: {{ template "jenkins.url" . }}
	{{- end -}}

This is very nice information, can you add this tip into documentation on how the mapping works, so when we are stuck somewhere, we know where to find the template to check by ourselves.

[FNSdev]

I have changed my values.yaml like this

master:
  serviceType: ClusterIP
  servicePort: 8081
  installPlugins:
    - kubernetes:1.27.0
    - workflow-aggregator:2.6
    - workflow-job:2.39
    - git:4.4.1
    - configuration-as-code:1.41
  JCasC:
    securityRealm: |-
      local:
        allowsSignup: false
    configScripts:
      jenkins-url: |
        unclassified:
          location:
            url: https://example.com/jenkins
            adminAddress: [email protected]
      welcome-message: |
        jenkins:
          systemMessage: Welcome to our CI\CD server.  This Jenkins is configured and managed 'as code'.
  # https://github.com/helm/charts/issues/15453
  customInitContainers:
    - name: "volume-mount-permission"
      image: "busybox"
      command: ["/bin/chown", "-R", "1000", "/var/jenkins_home"]
      volumeMounts:
        - name: "jenkins-home"
          mountPath: "/var/jenkins_home"
      securityContext:
        runAsUser: 0
  jenkinsUriPrefix: "/jenkins"
persistence:
  storageClass: jenkins
  size: "4Gi"

And now I have another issue:

io.jenkins.plugins.casc.ConfiguratorException: Found conflicting configuration at YamlSource: /var/jenkins_home/casc_configs/jenkins-url.yaml  in /var/jenkins_home/casc_configs/jenkins-url.yaml, line 3, column 10:
        url: https://example.com/jenkins
             ^
	at io.jenkins.plugins.casc.yaml.YamlUtils.merge(YamlUtils.java:139)
	at io.jenkins.plugins.casc.yaml.YamlUtils.merge(YamlUtils.java:125)
	at io.jenkins.plugins.casc.yaml.YamlUtils.merge(YamlUtils.java:125)
	at io.jenkins.plugins.casc.yaml.YamlUtils.merge(YamlUtils.java:125)
	at io.jenkins.plugins.casc.yaml.YamlUtils.merge(YamlUtils.java:52)
Caused: io.jenkins.plugins.casc.ConfiguratorException: Failed to read YamlSource: /var/jenkins_home/casc_configs/jenkins-url.yaml
	at io.jenkins.plugins.casc.yaml.YamlUtils.merge(YamlUtils.java:56)
	at io.jenkins.plugins.casc.yaml.YamlUtils.loadFrom(YamlUtils.java:150)
	at io.jenkins.plugins.casc.ConfigurationAsCode.configureWith(ConfigurationAsCode.java:616)
	at io.jenkins.plugins.casc.ConfigurationAsCode.configure(ConfigurationAsCode.java:298)
	at io.jenkins.plugins.casc.ConfigurationAsCode.init(ConfigurationAsCode.java:290)
Caused: java.lang.reflect.InvocationTargetException
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)
	at hudson.init.TaskMethodFinder.invoke(TaskMethodFinder.java:104)
Caused: java.lang.Error
	at hudson.init.TaskMethodFinder.invoke(TaskMethodFinder.java:110)
	at hudson.init.TaskMethodFinder$TaskImpl.run(TaskMethodFinder.java:175)
	at org.jvnet.hudson.reactor.Reactor.runTask(Reactor.java:296)
	at jenkins.model.Jenkins$5.runTask(Jenkins.java:1131)
	at org.jvnet.hudson.reactor.Reactor$2.run(Reactor.java:214)
	at org.jvnet.hudson.reactor.Reactor$Node.run(Reactor.java:117)
	at jenkins.security.ImpersonatingExecutorService$1.run(ImpersonatingExecutorService.java:59)
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
	at java.lang.Thread.run(Thread.java:748)
2020-09-04 06:18:34.325+0000 [id=19]	SEVERE	hudson.util.BootFailure#publish: Failed to initialize Jenkins

I guess that's because default config also specifies url.

What am I doing wrong?

[larrycai]

those needs to be overwritten in values.yaml for helm chart since jcasc-default-config.yaml already have it.

for url, I guess it is set in ingress part, I guess you removed this in the sample above.

master:
    ingress:
        hostName: xxx

You can check inside your jenkins

$ kubectl exec -it $(kubectl get pods -l app.kubernetes.io/name=jenkins -o=jsonpath='{.items[0].metadata.name}') -c jenkins bash
$ cat $CASC_JENKINS_CONFIG/jcasc-default-config.yaml

[FNSdev]

@larrycai Thank you for the reply
I use custom ingress configuration

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: jenkins-ingress
  annotations:
    kubernetes.io/ingress.class: "nginx"
spec:
  tls:
    - hosts:
        - example.com
        - www.example.com
      secretName: tls
  rules:
    - host: example.com
      http:
        paths:
        - path: /jenkins
          pathType: Prefix
          backend:
            service:
              name: jenkins
              port:
                number: 8081
    - host: www.example.com
      http:
        paths:
          - path: /jenkins
            pathType: Prefix
            backend:
              service:
                name: jenkins
                port:
                  number: 8081

Is there no other way to configure hostName?

[FNSdev]

@torstenwalter
Thank you! That is exactly what I was looking for.
I'm sorry for being not attentive enough, just getting started with Jenkins.

Could you please also clarify why the example with systemMessage was not working for me?

Do I have to put it into configScripts section?

[torstenwalter]

Yes

[torstenwalter]

#29 contains an example. I think we should add it in the README.

@FNSdev Would you like to create a PR for it?

[FNSdev]

@torstenwalter
Please take a look
#32