Skip to Content

Wiki source code of Jenkins Shared Library

Version 6.1 by Boris Folgmann on 2025/11/03 08:48
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 |= |goBuildCommand|(((
132 'go build -o app cmd/server/main.go'
133 )))|go build run. Should be overridden for your project.
134 |= |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.
135 |=(% rowspan="10" %)(((
136 Docker build
137 )))|(((
138 dockerBuildPath
139 )))|(((
140 '.' (current directory)
141 )))|(((
142 Path to use for building the Docker container.
143 )))
144 |(((
145 dockerBuildArgs
146 )))|(((
147 '' (empty string)
148 )))|(((
149 Any additional arguments for Docker build.
150 )))
151 |(((
152 dockerfile
153 )))|(((
154 dockerBuildPath/Dockerfile
155 )))|(((
156 Dockerfile to use for building the Docker container.
157 )))
158 |(((
159 imageName
160 )))|(((
161 artifactId from pom.xml for maven projects
162
163 name of the build job for all other project types
164 )))|(((
165 Name to be used for the built Docker image.
166 )))
167 |(((
168 imagePath
169 )))|(((
170 Name of the project folder in Jenkins. That's the PROJECTKEY from the self-service portal
171 )))|(((
172 Path to prepend before the imageName.
173 )))
174 |(((
175 imageTag
176 )))|(((
177 nothing
178 )))|(((
179 Additional tag to set on the container. It will be automatically prefixed with the branch name, except for the defaultBranch.
180 )))
181 |(((
182 gitHashLength
183 )))|(((
184 7
185 )))|(((
186 Number of digits from the git hash that will be used as an image tag on the container image to label the build.
187 )))
188 |(((
189 gitCredentialsId
190 )))|(((
191 'PROJECTKEY-git' (credential which was added to your project folder in Jenkins when the project was set up by the self-service portal)
192 )))|(((
193 Name of credentials used to connect to Bitbucket API. May be used to connect to alternative SCM tools in the future.
194 )))
195 |(((
196 pullDockerRegistry
197 )))|(((
198 '[[https:~~/~~/registry-CUSTOMER.devops.t-systems.net>>url:https://registry-CUSTOMER.devops.t-systems.net||shape="rect"]]' (docker registry of your DOaaS instance)
199 )))|(((
200 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.
201 )))
202 |(((
203 pullDockerRegistryCredentialsId
204 )))|(((
205 '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.)
206 )))|(((
207 Id of the Jenkins Credentials which have to be used to authenticate to the //pullDockerRegistry//.
208 )))
209 |=(% rowspan="7" %)(((
210 Docker container test
211 )))|(((
212 skipSmokeTest
213 )))|(((
214 false
215 )))|(((
216 Set to true to skip the container smoke test after the build.
217 )))
218 |(((
219 containerArgs
220 )))|(((
221 '' (empty string)
222 )))|(((
223 Arguments to pass to the container for the smoke test.
224 )))
225 |(((
226 containerPort
227 )))|(((
228 80
229 )))|(((
230 Exposed port of the container that is used to check for an answer during the smoke test.
231 )))
232 |(((
233 containerProtocol
234 )))|(((
235 'http'
236 )))|(((
237 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.
238 )))
239 |(((
240 containerContextPath
241 )))|(((
242 '' (empty string)
243 )))|(((
244 contextPath to query for the smoke test if the container protocol is 'http'
245 )))
246 |(((
247 containerMaxLoglineTime
248 )))|(((
249 15
250 )))|(((
251 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.
252 )))
253 |(((
254 containerMaxStartupTime
255 )))|(((
256 180 (3 minutes)
257 )))|(((
258 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.
259 )))
260 |=(% rowspan="2" %)(((
261 Docker push
262 )))|(((
263 pushDockerRegistry
264 )))|(((
265 '[[https:~~/~~/registry-CUSTOMER.devops.t-systems.net>>url:https://registry-CUSTOMER.devops.t-systems.net||shape="rect"]]' (docker registry of your DOaaS instance)
266 )))|(((
267 Docker registry to which the built image will be pushed after a successful smoke test.
268 )))
269 |(((
270 pushDockerRegistryCredentialsId
271 )))|(((
272 '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.)
273 )))|(((
274 Id of the Jenkins Credentials which have to be used to authenticate to the //pullDockerRegistry//.
275 )))
276 |=(% rowspan="6" %)(((
277 Helm chart
278 )))|(((
279 helmChartPath
280 )))|(((
281 './chart'
282 )))|(((
283 Specifies the path to the YAML files for the helm command.
284 )))
285 |(((
286 appName
287 )))|(((
288 artifactId from pom.xml for maven projects
289
290 name of the build job for all other project types
291 )))|(((
292 Name of the application. Used to build the name of the Helm chart.
293 )))
294 |(((
295 appVersion
296 )))|(((
297 version from pom.xml for maven projects
298
299 '1.0.0' for all other project types
300 )))|(((
301 Version of the application. Used to set the app version of the Helm chart.
302 )))
303 |(((
304 chartVersion
305 )))|(((
306 appVersion with '00' appended
307 )))|(((
308 Version of the Helm chart. Used to set the chart version of the Helm chart.
309 )))
310 |(((
311 helmRegistry
312 )))|(((
313 Nexus registry of your DOaaS instance
314 )))|(((
315 Name of registry to which the packaged Helm chart is uploaded.
316 )))
317 |(((
318 helmRegistryCredentialsId
319 )))|(((
320 '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.)
321 )))|(((
322 Id of the Jenkins Credentials which have to be used to authenticate to the Helm registry for acccessing Helm charts.
323 )))
324 |=(% rowspan="4" %)(((
325 Container image signature
326 )))|(((
327 signImages
328 )))|(((
329 false
330 )))|(((
331 When set to true, it activates signing of generated Docker images.
332 )))
333 |(((
334 signingNotaryServer
335 )))|(((
336 '[[https:~~/~~/notary.external.otc.telekomcloud.com>>url:https://notary.external.otc.telekomcloud.com||shape="rect"]]' (Magenta Trusted Registry)
337 )))|(((
338 Specifies the Notary service to be used for signing.
339 )))
340 |(((
341 signingPassphraseCredentialsId
342 )))|(((
343 'docker-trust-PROJECTKEY-passphrase'
344 )))|(((
345 Id of the Jenkins Credentials for passphrase of signers keyfile.
346 )))
347 |(((
348 signingKeyfileCredentialsId
349 )))|(((
350 'docker-trust-PROJECTKEY-keyfile'
351 )))|(((
352 Id of the Jenkins Credentials for signers private keyfile.
353 )))
354 |=(% colspan="1" rowspan="12" %)(((
355 Static Source Code Analysis
356 )))|(((
357 checkstyleConfig
358 )))|(((
359 best-practice releaxed configuration
360 )))|(((
361 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"]].
362 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.
363 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.
364 )))
365 |(((
366 skipBlames
367 )))|(((
368 false
369 )))|(((
370 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.
371 )))
372 |(((
373 yamlConfig
374 )))|(((
375 best-practice releaxed configuration
376 )))|(((
377 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"]].
378 )))
379 |skipDependencyCheck|false|Set to true to skip the dependency-check.
380 |(((
381 dependencyCheckTool
382 )))|(((
383 'dependency-check'
384 )))|(((
385 Defines which named dependency-check tool should be used.
386 )))
387 |(((
388 dependencyCheckArgs
389 )))|(((
390 '~-~-disableAssembly ~-~-nvdValidForHours 720'
391 )))|(((
392 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.
393 )))
394 |(((
395 dependencyCheckNvdApiKeyCredentialsId
396 )))|(((
397 'dependency-check-nvdapikey'
398 )))|(((
399 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.
400 )))
401 |(((
402 sonarQube
403 )))|(((
404 true for the defaultBranch and for pull-requests, if a SonarQube version is detected which supports scanning multiple branches
405
406 false for all other branches
407 )))|(((
408 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.
409
410 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.
411 )))
412 |(((
413 sonarScanMavenOpts
414 )))|(((
415 ''
416 )))|(((
417 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.
418 )))
419 |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
420 sonar scan. '-Xmx3g' should be enough for most source codes, but make sure that your Jenkins agent has enough memory to cope with that.
421 |(((
422 sonarSources
423 )))|(((
424 'src/main' for maven projects
425
426 null for non-maven projects
427 )))|(((
428 (% class="content-wrapper" %)
429 (((
430 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.
431
432 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
433
434 {{code language="xml"}}
435 <properties>
436 <sonar.skip>true</sonar.skip>
437 </properties>
438 {{/code}}
439
440 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:
441
442 {{code language="xml"}}
443 <properties>
444 <sonar.source>src/main/java,src/main/webapp</sonar.sources>
445 </properties>
446 {{/code}}
447 )))
448 )))
449 |sonarQualityGate| |Sets the desired quality gate to use for the scan result in SonarQube.
450 If not specified, the quality gate is not changed.
451 As a default, SonarQube will use the quality gate "Sonar way" for new scan results.
452 |=(% colspan="1" rowspan="2" %)Dependency Track|depTrackCredentialsId|'PROJECTKEY-deptrack-projectcreator'|(((
453 Id of the Jenkins Credential which has to be used to authenticate to Dependency Track for publishing the SBOM.
454 )))
455 |depTrackClassifier|'application'|The component type (e.g. application, library, firmware, ...) that should be set in the SBOM file.
456 Will be later shown as classifier for the project in Dependency Track.
457 See [[CycloneDX Metadata Component Type>>https://cyclonedx.org/docs/1.6/json/#metadata_component_type]] for supported values.
458 |=(% 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.
459 Possible values are: "None", "Unknown", "Negligible", "Low", "Medium", "High", "Critical".
460 |trivyBuildResult|'SUCCESS'|String which sets the overall build result when the result of the Trivy scan reaches trivyServerity.
461 Possible values are: "SUCCESS", "UNSTABLE" or "FAILURE"
462 |=(% rowspan="7" %)(((
463 Deployment
464 )))|(((
465 deployHelmChart
466 )))|(((
467 false
468 )))|(((
469 Boolean that activates or deactivates the automatic deployment of the Helm-Chart.
470 )))
471 |(((
472 kubeconfigCredentialsId
473 )))|(((
474 'kubeconfig-deployer-PROJECTKEY'
475 )))|(((
476 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.
477 )))
478 |(((
479 kubernetesNamespace
480 )))|(((
481 'default'
482 )))|(((
483 Name of the namespace in Kubernetes, to which the Chart will be deployed.
484 )))
485 |(((
486 helmValuesOverrideFile
487 )))|(((
488 'chart/values.yaml'
489 )))|(((
490 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.
491 )))
492 |(((
493 helmSetValues
494 )))|(((
495 ''
496 )))|(((
497 Set values using the format "key1=val1,key2=val2,..." for the automatic deployment.
498
499 While helmValuesOverrideFile is usally something static you can use this to specify different values depending on e.g. conditions in your Jenkinsfile.
500
501 Will be ignored if set to null, empty string or just white space.
502 )))
503 |(((
504 helmReleaseName
505 )))|(((
506 artifactId from pom.xml for maven projects
507
508 name of the build job for all other project types
509 )))|(((
510 Name of the Helm Release which will be installed or upgraded in your cluster.
511 )))
512 |(((
513 helmLockResource
514 )))|(((
515 null
516 )))|(((
517 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
518
519 (% class="code" %)
520 (((
521 helm upgrade
522 )))
523
524 or
525
526 (% class="code" %)
527 (((
528 helm uninstall
529 )))
530
531 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.
532 )))
© 2018-2025 T-Systems International GmbH