You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Recommend installing plugins in custom image (#144)
- explain how to build and use a custom image
- render message in NOTES.txt if default image is used or plugins are
installed anyhow
- smaller fixes
- move httpsKeyStore further down in values.yaml
Closes: #12
Signed-off-by: Torsten Walter <[email protected]>
The change log 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.
12
+
The change log until v1.5.7 was auto-generated based on git commits.
13
+
Those entries include a reference to the git commit to be able to get more details.
14
+
15
+
## 2.18.1
16
+
17
+
Recommend installing plugins in custom image
18
+
12
19
## 2.18.0
13
20
14
21
Removed /tmp volume. Making /tmp a volume causes permission issues with jmap/jstack on certain Kubernetes clusters
Copy file name to clipboardExpand all lines: charts/jenkins/README.md
+48-9Lines changed: 48 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,8 @@ For migration between major version check [migration guide](#migration-guide).
57
57
58
58
## Configuration
59
59
60
-
See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands:
60
+
See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing).
61
+
To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands:
For a summary of all configurable options, see [VALUES_SUMMARY.md](./VALUES_SUMMARY.md)
71
72
73
+
### Consider using a custom image
74
+
75
+
This chart allows the user to specify plugins, which should be installed however for production use cases one should consider to build a custom Jenkins image which has all required plugins pre-installed.
76
+
This way you can be sure which plugins Jenkins is using when starting up and you avoid trouble in case of connectivity issues to the Jenkins update site.
77
+
78
+
The [docker repository](https://github.com/jenkinsci/docker) for the Jenkins image contains [documentation](https://github.com/jenkinsci/docker#preinstalling-plugins) how to do it.
79
+
80
+
Here is an example how that can be done:
81
+
82
+
```Dockerfile
83
+
FROM jenkins/jenkins:lts
84
+
RUN jenkins-plugin-cli --plugins kubernetes workflow-job workflow-aggregator credentials-binding git configuration-as-code
85
+
```
86
+
87
+
NOTE: If you want a reproducible build then you should specify a non floating tag for the image `jenkins/jenkins:2.249.3` and specify plugin versions.
88
+
89
+
Once you built the image and pushed it tou your registry you can specify it in your values file like this:
90
+
91
+
```yaml
92
+
master:
93
+
image: "registry/my-jenkins"
94
+
tag: "v1.2.3"
95
+
installPlugins: []
96
+
```
97
+
98
+
Notice: `installPlugins` is set to an empty list to disable plugin download.
99
+
100
+
In case you are using a private registry you can use 'imagePullSecretName' to specify the name of the secret to use when pulling the image:
101
+
102
+
```yaml
103
+
master:
104
+
image: "registry/my-jenkins"
105
+
tag: "v1.2.3"
106
+
imagePullSecretName: registry-secret
107
+
installPlugins: []
108
+
```
109
+
110
+
### External URL Configuration
111
+
112
+
If you are using the ingress definitions provided by this chart via the `master.ingress` block the configured hostname will be the ingress hostname starting with `https://` or `http://` depending on the `tls` configuration.
113
+
The Protocol can be overwritten by specifying `master.jenkinsUrlProtocol`.
114
+
115
+
If you are not using the provided ingress you can specify `master.jenkinsUrl` to change the url definition.
116
+
72
117
### Configuration as Code
73
118
74
119
Jenkins Configuration as Code is now a standard component in the Jenkins project.
75
120
Add a key under configScripts for each configuration area, where each corresponds to a plugin or section of the UI.
76
121
The keys (prior to `|` character) are just labels, and can be any value.
77
122
They are only used to give the section a meaningful name.
78
123
The only restriction is they must conform to RFC 1123 definition of a DNS label, so they may only contain lowercase letters, numbers, and hyphens.
79
-
Each key will become the name of a configuration yaml file on the master in /var/jenkins_home/casc_configs (by default) and will be processed by the Configuration as Code Plugin during Jenkins startup.
124
+
Each key will become the name of a configuration yaml file on the master in `/var/jenkins_home/casc_configs` (by default) and will be processed by the Configuration as Code Plugin during Jenkins startup.
80
125
The lines after each `|` become the content of the configuration yaml file.
81
126
The first line after this is a JCasC root element, e.g. jenkins, credentials, etc.
82
127
Best reference is the Documentation link here: `https://<jenkins_url>/configuration-as-code`.
@@ -516,17 +561,11 @@ master:
516
561
- /github-webhook
517
562
```
518
563
519
-
### External URL Configuration
520
-
If you are using the ingress definitions provided by this chart via the `master.ingress` block the configured hostname will be the ingress hostname starting with `https://` or `http://` depending on the `tls` configuration.
521
-
The Protocol can be overwritten by specifying `master.jenkinsUrlProtocol`.
522
-
523
-
If you are not using the provided ingress you can specify `master.jenkinsUrl` to change the url definition.
524
-
525
564
## Migration Guide
526
565
527
566
### From stable repo
528
567
529
-
Upgrade an existing release from `stable/jenkins` to `jenkinsci/jenkins` seamlessly by ensuring you have the latest [repo info](#get-repo-info) and running the [upgrade commands](#upgrade-chart) specifying the `jenkinsci/jenkins` chart.
568
+
Upgrade an existing release from `stable/jenkins` to `jenkins/jenkins` seamlessly by ensuring you have the latest [repo info](#get-repo-info) and running the [upgrade commands](#upgrade-chart) specifying the `jenkins/jenkins` chart.
0 commit comments