Skip to Content

Wiki source code of Jenkins Shared Library

Version 6.2 by Boris Folgmann on 2025/11/03 09:01
Show last authors
1 {{toc/}}
2
3 = DevOps-as-a-Service Open Source Pipeline Library =
4
5 DevOps-as-a-Service provides a standardized Jenkins Shared Library to be used for all your builds. See [[https:~~/~~/prd.sdc.t-systems.net/bitbucket/projects/DEVOPSAAS/repos/sdcloud-caas-jenkins-libs/browse>>url:https://prd.sdc.t-systems.net/bitbucket/projects/DEVOPSAAS/repos/sdcloud-caas-jenkins-libs/browse||shape="rect"]] for the source code and additional documentation like e.g. release notes.
6
7 == Getting Started ==
8
9 Since the Shared Library is globally configured on all Jenkins instances managed by DevOps-as-a-Service you just need to place the following very short Jenkinsfile in the root folder of your git repository to automatically build your maven or node project or simply build a container using a Dockerfile.
10
11 {{code}}
12 @Library('sdcloud') _
13
14 sdcPipeline()
15 {{/code}}
16
17 Calling sdcPipeline() starts an automatically configured, standardized build and deployment pipeline.
18 The pipeline requires a node labeled with 'docker' to execute successfully. To run on other types of Jenkins agents set the //useNode //argument as described below.
19
20 == Pipeline features ==
21
22 What the pipeline currently does is visualised in the following image which shows an example for a maven-based Java project.
23
24 [[image:attach:image2022-5-17_17-51-43.png||height="250"]]
25
26 1. Checking out the source code from git.
27 1. If a pom.xml is found your favorite JDK is selected, by default jdk11. Then a maven build is done.
28 1. If there's no pom.xml but a package.json is found a nodejs build is done.
29 1. If there is no pom.xml or package.json but a go.mod file, a go build is done.
30 1. Then the following stages are executed in parallel
31 11. Analysis: For maven projects the Java source code is checked by checkstyle, pmd and spotbugs. Furthermore the job output will be checked for any warnings generated by maven, javac or javadoc. If Python modules (.py files) exist in the git repository they will be analyzed using pylint and flake8. If pylint or flake8 are not available on the Jenkins agent the steps will be skipped. Python files that are generated or downloaded into the workspace will not be checked. The results will be displayed on the classical Jenkins build page after the build. For Go projects, the Go test tool is used to run all tests and produce a coverage output file for SonarQube. Additionally, the gotestsum tool is used to produce a report which is picked up by Jenkins.</dd>
32 11. Security: If it's not a feature or bugfix branch a dependency check is done which checks if e.g. libraries are used which have known vulnerabilities. The results will be displayed in Jenkins after the build.
33 11. Docker: this will also work for projects which are neither maven or nodejs. A Dockerfile is enough to trigger this part of the pipeline.
34 111. If a Dockerfile is found a docker image is built.
35 111. The image is started as an isolated container on the Jenkins agent.
36 111. Any loglines written to stdout or stderr by the container will be displayed.
37 111. A smoke test is performed which is a simple query for a valid answer on the exposed port of the container.
38 111. If the smoke test was successful and the build was not done for a pull request the docker image will be pushed to the docker registry.
39 111. For easy identification of the image 3 image tags are defined:
40 1111. BRANCH_NAME-BUILD_NUMBER (e.g. 'production-1014')
41 1111. BRANCH_NAME-GIT_HASH (e.g. 'develop-8a7c4f2')
42 1111. BRANCH_NAME-latest (e.g. 'feature-PKEY-42-latest')
43 1111. (If BRANCH_NAME is defaultBranch the prefix 'BRANCH_NAME-' will not be included.)
44 111. When a chart/Chart.yaml is found and  it's not a pull request a Helm Chart will be created and pushed to the Helm Chart repository.
45 1. Yamllint will check all YAML files in the workspace for errors and warnings. This is done at this place since the Create Helm Chart stage modifies or creates YAML files which should be also checked before the pipeline proceeds.
46 1. When depolyHelmChart is set to true the Helm chart will be deployed to the Kubernestes cluster and namespace of your choice. Not done in the example diagram.
47
48 == {{id name="pipeline_customization"/}}Pipeline Customization ==
49
50 By passing named arguments to sdcPipline() e.g. sdcPipeline(imageName: 'nginx-demo', imageTag: 'v1.4') you can change the default configuration of the pipeline.
51
52 (% class="table-bordered" style="width:100.0%" %)
53 (% class="active" %)|=(((
54 Category
55 )))|=(((
56 Argument
57 )))|=(((
58 Default
59 )))|=(((
60 Description
61 )))
62 |=(% rowspan="4" %)(((
63 Job execution
64 )))|(((
65 decorateOutput
66 )))|(((
67 true
68 )))|(((
69 Enables timestamps and colorization for the console output when set to true.
70 )))
71 |allocateNode|true|(((
72 Specifies if a node should be allocated for executing the sdcPipeline code.
73
74 If you set this to false you will need to put your sdcPipeline() call into a node {} block.
75 )))
76 |(((
77 useNode
78 )))|(((
79 'docker'
80 )))|(((
81 Specifies which node should be allocated and used by the pipeline if allocateNode is true.
82
83 Pass a label or name of a configured Jenkins agent.
84 )))
85 |(((
86 defaultBranch
87 )))|(((
88 'master'
89 )))|(((
90 This branch will be the integration branch for work. At some points the pipeline will behave differently, if the default branch or another branch ist currently being built.
91 )))
92 |=(% rowspan="5" %)(((
93 Programming language and build tool
94 )))|(((
95 jdk
96 )))|(((
97 'jdk11'
98 )))|(((
99 JDK to use for all Java operations. Refers to a symbolic name of a Java tool configuration in Jenkins.
100 )))
101 |(((
102 mvnCommand
103 )))|(((
104 'mvn clean verify'
105 )))|(((
106 maven command to execute for building maven projects.
107 )))
108 |(((
109 mavenSettingsConfig
110 )))|(((
111 ''
112 )))|(((
113 Select a maven settings element from File Config Provider. The settings element in the settings.xml file contains elements used to define values which configure Maven execution in various ways, like the pom.xml, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
114
115 See also [[doc:Jenkins.Using Maven Artifact Repositories in Jenkins.WebHome]].
116 )))
117 |(((
118 nodejs
119 )))|(((
120 'nodejs'
121 )))|(((
122 Node.js to use for all node operations like e.g. calling npm. Refers to a symbolic name of a nodejs tool configuration in Jenkins.
123 )))
124 |(((
125 npmCommand
126 )))|(((
127 'npm install && npm run build ~-~-prod'
128 )))|(((
129 npm command to execute for building Node.JS projects.
130 )))
131 |= |go|'go'|Golang version to use.
132 Refers to a symbolic name of a go tool configuration in Jenkins.
133 |= |goBuildCommand|(((
134 'go build -o app cmd/server/main.go'
135 )))|go build run. Should be overridden for your project.
136 |= |goTestCommand|'gotestsum ~-~-format pkgname ~-~-junitfile report.xml ~-~- -failfast -race -coverprofile=coverage.out -tags=test ./...'|Runs gotestsum tool which in turn calls 'go test' for all packages in the project. Should be overridden for your project. The gotestsum tool is available out-of-the-box and produces a report file which is picked up by Jenkins automatically.
137 |=(% rowspan="10" %)(((
138 Docker build
139 )))|(((
140 dockerBuildPath
141 )))|(((
142 '.' (current directory)
143 )))|(((
144 Path to use for building the Docker container.
145 )))
146 |(((
147 dockerBuildArgs
148 )))|(((
149 '' (empty string)
150 )))|(((
151 Any additional arguments for Docker build.
152 )))
153 |(((
154 dockerfile
155 )))|(((
156 dockerBuildPath/Dockerfile
157 )))|(((
158 Dockerfile to use for building the Docker container.
159 )))
160 |(((
161 imageName
162 )))|(((
163 artifactId from pom.xml for maven projects
164
165 name of the build job for all other project types
166 )))|(((
167 Name to be used for the built Docker image.
168 )))
169 |(((
170 imagePath
171 )))|(((
172 Name of the project folder in Jenkins. That's the PROJECTKEY from the self-service portal
173 )))|(((
174 Path to prepend before the imageName.
175 )))
176 |(((
177 imageTag
178 )))|(((
179 nothing
180 )))|(((
181 Additional tag to set on the container. It will be automatically prefixed with the branch name, except for the defaultBranch.
182 )))
183 |(((
184 gitHashLength
185 )))|(((
186 7
187 )))|(((
188 Number of digits from the git hash that will be used as an image tag on the container image to label the build.
189 )))
190 |(((
191 gitCredentialsId
192 )))|(((
193 'PROJECTKEY-git' (credential which was added to your project folder in Jenkins when the project was set up by the self-service portal)
194 )))|(((
195 Name of credentials used to connect to Bitbucket API. May be used to connect to alternative SCM tools in the future.
196 )))
197 |(((
198 pullDockerRegistry
199 )))|(((
200 '[[https:~~/~~/registry-CUSTOMER.devops.t-systems.net>>url:https://registry-CUSTOMER.devops.t-systems.net||shape="rect"]]' (docker registry of your DOaaS instance)
201 )))|(((
202 If you need to pull base images during the Docker build from a docker registry that requires authentication you have to use this to specify it.
203 )))
204 |(((
205 pullDockerRegistryCredentialsId
206 )))|(((
207 'doaas-PROJECTKEY+jenkins-push-harbor' or 'PROJECTKEY-jenkins' (which were added to the credentials of your project folder in Jenkins when the project was set up by the DevOps Portal. While the first is added for Harbor, the second is added for Nexus OSS. That means that the library will automatically choose the best default for you. Please note that Harbor will be prefered, if both tools are used in the project.)
208 )))|(((
209 Id of the Jenkins Credentials which have to be used to authenticate to the //pullDockerRegistry//.
210 )))
211 |=(% rowspan="7" %)(((
212 Docker container test
213 )))|(((
214 skipSmokeTest
215 )))|(((
216 false
217 )))|(((
218 Set to true to skip the container smoke test after the build.
219 )))
220 |(((
221 containerArgs
222 )))|(((
223 '' (empty string)
224 )))|(((
225 Arguments to pass to the container for the smoke test.
226 )))
227 |(((
228 containerPort
229 )))|(((
230 80
231 )))|(((
232 Exposed port of the container that is used to check for an answer during the smoke test.
233 )))
234 |(((
235 containerProtocol
236 )))|(((
237 'http'
238 )))|(((
239 Protocol to use when trying to connect to the port of the container. Possible values: 'http', 'tcp', 'udp'. 'http' will be tested with curl, 'tcp' and 'udp' will be tested with ncat.
240 )))
241 |(((
242 containerContextPath
243 )))|(((
244 '' (empty string)
245 )))|(((
246 contextPath to query for the smoke test if the container protocol is 'http'
247 )))
248 |(((
249 containerMaxLoglineTime
250 )))|(((
251 15
252 )))|(((
253 After starting the container the smoke tests monitors stdout of the container for loglines. After containerMaxLoglineTime which is specified in seconds have passed without a new logline found, the container is expected to be up and running and the test query is performed. Increase if your container doesn't write loglines that often and seems to be not ready when the test query is performed.
254 )))
255 |(((
256 containerMaxStartupTime
257 )))|(((
258 180 (3 minutes)
259 )))|(((
260 Total time in seconds after which the container is expected to be up and running even if it's still writing loglines to stdout. After this time has passed the container will be queried for an answer.
261 )))
262 |=(% rowspan="2" %)(((
263 Docker push
264 )))|(((
265 pushDockerRegistry
266 )))|(((
267 '[[https:~~/~~/registry-CUSTOMER.devops.t-systems.net>>url:https://registry-CUSTOMER.devops.t-systems.net||shape="rect"]]' (docker registry of your DOaaS instance)
268 )))|(((
269 Docker registry to which the built image will be pushed after a successful smoke test.
270 )))
271 |(((
272 pushDockerRegistryCredentialsId
273 )))|(((
274 'doaas-PROJECTKEY+jenkins-push-harbor' or 'PROJECTKEY-jenkins' (which were added to the credentials of your project folder in Jenkins when the project was set up by the DevOps Portal. While the first is added for Harbor, the second is added for Nexus OSS. That means that the library will automatically choose the best default for you. Please note that Harbor will be prefered, if both tools are used in the project.)
275 )))|(((
276 Id of the Jenkins Credentials which have to be used to authenticate to the //pullDockerRegistry//.
277 )))
278 |=(% rowspan="6" %)(((
279 Helm chart
280 )))|(((
281 helmChartPath
282 )))|(((
283 './chart'
284 )))|(((
285 Specifies the path to the YAML files for the helm command.
286 )))
287 |(((
288 appName
289 )))|(((
290 artifactId from pom.xml for maven projects
291
292 name of the build job for all other project types
293 )))|(((
294 Name of the application. Used to build the name of the Helm chart.
295 )))
296 |(((
297 appVersion
298 )))|(((
299 version from pom.xml for maven projects
300
301 '1.0.0' for all other project types
302 )))|(((
303 Version of the application. Used to set the app version of the Helm chart.
304 )))
305 |(((
306 chartVersion
307 )))|(((
308 appVersion with '00' appended
309 )))|(((
310 Version of the Helm chart. Used to set the chart version of the Helm chart.
311 )))
312 |(((
313 helmRegistry
314 )))|(((
315 Nexus registry of your DOaaS instance
316 )))|(((
317 Name of registry to which the packaged Helm chart is uploaded.
318 )))
319 |(((
320 helmRegistryCredentialsId
321 )))|(((
322 'doaas-PROJECTKEY+jenkins-push-harbor' or 'PROJECTKEY-jenkins' (which were added to the credentials of your project folder in Jenkins when the project was set up by the DevOps Portal. While the first is added for Harbor, the second is added for Nexus OSS. That means that the library will automatically choose the best default for you. Please note that Harbor will be prefered, if both tools are used in the project.)
323 )))|(((
324 Id of the Jenkins Credentials which have to be used to authenticate to the Helm registry for acccessing Helm charts.
325 )))
326 |=(% rowspan="4" %)(((
327 Container image signature
328 )))|(((
329 signImages
330 )))|(((
331 false
332 )))|(((
333 When set to true, it activates signing of generated Docker images.
334 )))
335 |(((
336 signingNotaryServer
337 )))|(((
338 '[[https:~~/~~/notary.external.otc.telekomcloud.com>>url:https://notary.external.otc.telekomcloud.com||shape="rect"]]' (Magenta Trusted Registry)
339 )))|(((
340 Specifies the Notary service to be used for signing.
341 )))
342 |(((
343 signingPassphraseCredentialsId
344 )))|(((
345 'docker-trust-PROJECTKEY-passphrase'
346 )))|(((
347 Id of the Jenkins Credentials for passphrase of signers keyfile.
348 )))
349 |(((
350 signingKeyfileCredentialsId
351 )))|(((
352 'docker-trust-PROJECTKEY-keyfile'
353 )))|(((
354 Id of the Jenkins Credentials for signers private keyfile.
355 )))
356 |=(% colspan="1" rowspan="12" %)(((
357 Static Source Code Analysis
358 )))|(((
359 checkstyleConfig
360 )))|(((
361 best-practice releaxed configuration
362 )))|(((
363 Name of a config file to use for checkstyle. If not set a best-practice[[ relaxed configuration >>url:https://prd.sdc.t-systems.net/bitbucket/projects/DEVOPSAAS/repos/sdcloud-caas-jenkins-libs/browse/resources/com/tsystems/sdc/jenkinslib/checkstyle.xml||shape="rect"]]is used which is different from the original  Sun[[ Java Style>>url:https://checkstyle.org/sun_style.html||shape="rect"]].
364 To get the old behavior simply specify 'sun_checks.xml' to get the original Sun Checks. As an alternative 'google_checks.xml' can be used for the Google Checks which is another ruleset predefined in the checkstyle scanner tool.
365 For a custom configuration specify a filesystem path, a URL, or a classpath resource. This parameter expects that the contents of the location conforms to the xml format (Checkstyle Checker module) configuration of rulesets.
366 )))
367 |(((
368 skipBlames
369 )))|(((
370 false
371 )))|(((
372 If set to true all recordIssues steps will skip creating the SCM blames. This speeds up the processing of the results of static source code analyis. As a consequence you will not be able to see who introduced a problem into the code.
373 )))
374 |(((
375 yamlConfig
376 )))|(((
377 best-practice releaxed configuration
378 )))|(((
379 Name of a config file to use for yamllint. If not set a best-practice[[ relaxed configuration >>url:https://prd.sdc.t-systems.net/bitbucket/projects/DEVOPSAAS/repos/sdcloud-caas-jenkins-libs/browse/resources/com/tsystems/sdc/jenkinslib/yamllint.yml||shape="rect"]]is used which is different from the original yamllint[[ config>>url:https://yamllint.readthedocs.io/en/stable/configuration.html#default-configuration||shape="rect"]].
380 )))
381 |skipDependencyCheck|false|Set to true to skip the dependency-check.
382 |(((
383 dependencyCheckTool
384 )))|(((
385 'dependency-check'
386 )))|(((
387 Defines which named dependency-check tool should be used.
388 )))
389 |(((
390 dependencyCheckArgs
391 )))|(((
392 '~-~-disableAssembly ~-~-nvdValidForHours 720'
393 )))|(((
394 Addtional arguments which are be passed to dependency-check. See [[Dependency>>url:https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html||shape="rect"]][[ Check CLI Arguments>>url:https://jeremylong.github.io/DependencyCheck/dependency-check-cli/arguments.html||shape="rect"]] for more information.
395 )))
396 |(((
397 dependencyCheckNvdApiKeyCredentialsId
398 )))|(((
399 'dependency-check-nvdapikey'
400 )))|(((
401 If you have your own NVD API Key, set it as a credential of type text in Jenkins. Then specify the credential id using this argument. It will be automatically passed to dependency-check. There will be no error if no credential is found. Just the NVD download will be slower. Please note, on DevOps-as-a-Service a shared NVD API Key is automatically supplied for the default credential id.
402 )))
403 |(((
404 sonarQube
405 )))|(((
406 true for the defaultBranch and for pull-requests, if a SonarQube version is detected which supports scanning multiple branches
407
408 false for all other branches
409 )))|(((
410 Set this to true to force a SonarQube scan for the current branch. Usually this makes only sense if you explicitly want to scan feature and bugfix branches.
411
412 If not set or set to false, the default branch will be scanned automatically as well as pull-requests, if a SonarQube version is detected which supports scanning multiple branches. This is currently the case for SonarQube Developer and Enterprise editions. The free SonarQube Community edition supports just one branch.
413 )))
414 |(((
415 sonarScanMavenOpts
416 )))|(((
417 ''
418 )))|(((
419 For huge source codes it can happen that the sonar scanner aborts with java.lang.OutOfMemoryError. In this case the memory that is availalbe for the sonar scanner needs to be increased. Try something like '-Xmx512m' to set a larger heap space for the JVM that is executing the maven-based sonar scan. '-Xmx3g' should be enough for most source codes, but make sure that your Jenkins agent has enough memory to cope with that.
420 )))
421 |sonarScanOpts|''|For huge source codes it can happen that the sonar scanner aborts with java.lang.OutOfMemoryError. In this case the memory that is availalbe for the sonar scanner needs to be increased. Try something like '-Xmx512m' to set a larger heap space for the JVM that is executing the
422 sonar scan. '-Xmx3g' should be enough for most source codes, but make sure that your Jenkins agent has enough memory to cope with that.
423 |(((
424 sonarSources
425 )))|(((
426 'src/main' for maven projects
427
428 null for non-maven projects
429 )))|(((
430 (% class="content-wrapper" %)
431 (((
432 Comma-separated paths to directories containing main source files to scan with SonarQube. Defaults to 'src/main' and therefore will automatically discover folders like src/main/java, src/main/webapp or src/main/resources. This makes sure to not only scan Java sources, but also for example JSP, CSS and HTML files.
433
434 Sonar scanning will fail if the configured directory itself is not found at all. This can happen if you have defined an alternative <sourceDirectory> in your pom.xml. If this is the case, you can disable sonar scanning by adding
435
436 {{code language="xml"}}
437 <properties>
438 <sonar.skip>true</sonar.skip>
439 </properties>
440 {{/code}}
441
442 to the pom.xml. If this is not what you want, set sonarSources to {{code language="none"}}null{{/code}}. This will make sure that sonar.sources are not explicitly passed to the sonar scanner. This will allow you to specify sonar.sources in the pom.xml like in the following example:
443
444 {{code language="xml"}}
445 <properties>
446 <sonar.source>src/main/java,src/main/webapp</sonar.sources>
447 </properties>
448 {{/code}}
449 )))
450 )))
451 |sonarQualityGate| |Sets the desired quality gate to use for the scan result in SonarQube.
452 If not specified, the quality gate is not changed.
453 As a default, SonarQube will use the quality gate "Sonar way" for new scan results.
454 |=(% colspan="1" rowspan="2" %)Dependency Track|depTrackCredentialsId|'PROJECTKEY-deptrack-projectcreator'|(((
455 Id of the Jenkins Credential which has to be used to authenticate to Dependency Track for publishing the SBOM.
456 )))
457 |depTrackClassifier|'application'|The component type (e.g. application, library, firmware, ...) that should be set in the SBOM file.
458 Will be later shown as classifier for the project in Dependency Track.
459 See [[CycloneDX Metadata Component Type>>https://cyclonedx.org/docs/1.6/json/#metadata_component_type]] for supported values.
460 |=(% colspan="1" rowspan="2" %)Trivy|trivySeverity|'High'|String which sets the minimum severity of Trivy findings that has to be reached to mark the Trivy Results stage as unstable.
461 Possible values are: "None", "Unknown", "Negligible", "Low", "Medium", "High", "Critical".
462 |trivyBuildResult|'SUCCESS'|String which sets the overall build result when the result of the Trivy scan reaches trivyServerity.
463 Possible values are: "SUCCESS", "UNSTABLE" or "FAILURE"
464 |=(% rowspan="7" %)(((
465 Deployment
466 )))|(((
467 deployHelmChart
468 )))|(((
469 false
470 )))|(((
471 Boolean that activates or deactivates the automatic deployment of the Helm-Chart.
472 )))
473 |(((
474 kubeconfigCredentialsId
475 )))|(((
476 'kubeconfig-deployer-PROJECTKEY'
477 )))|(((
478 Id of the Jenkins credential which contains the kubeconfig file that should be used for deployment. The file is required to authorize access to the Kubernetes cluster.
479 )))
480 |(((
481 kubernetesNamespace
482 )))|(((
483 'default'
484 )))|(((
485 Name of the namespace in Kubernetes, to which the Chart will be deployed.
486 )))
487 |(((
488 helmValuesOverrideFile
489 )))|(((
490 'chart/values.yaml'
491 )))|(((
492 Name of the YAML file which contains specific values that should be overridden for the automatic deployment. The location needs to be specified relative to the Jenkinsfile.
493 )))
494 |(((
495 helmSetValues
496 )))|(((
497 ''
498 )))|(((
499 Set values using the format "key1=val1,key2=val2,..." for the automatic deployment.
500
501 While helmValuesOverrideFile is usally something static you can use this to specify different values depending on e.g. conditions in your Jenkinsfile.
502
503 Will be ignored if set to null, empty string or just white space.
504 )))
505 |(((
506 helmReleaseName
507 )))|(((
508 artifactId from pom.xml for maven projects
509
510 name of the build job for all other project types
511 )))|(((
512 Name of the Helm Release which will be installed or upgraded in your cluster.
513 )))
514 |(((
515 helmLockResource
516 )))|(((
517 null
518 )))|(((
519 Using [[lock>>url:https://www.jenkins.io/doc/pipeline/steps/lockable-resources/#lock-lock-shared-resource||shape="rect"]] the specified resource will be locked for the execution of any
520
521 (% class="code" %)
522 (((
523 helm upgrade
524 )))
525
526 or
527
528 (% class="code" %)
529 (((
530 helm uninstall
531 )))
532
533 command. This makes sense if deployHelmChart is used to upgrade an deployment in an environment which is currently used, e.g. for automated testing. In this case wrap your test in a lock statement with the same resource name. Defaults to null, which will not lock any resource.
534 )))
© 2018-2025 T-Systems International GmbH