11 Recommended jobs that should be deployed for CI using Gerrit.
15 - gerrit-jenkins-cfg-merge
16 - gerrit-jenkins-sandbox-cleanup
17 - gerrit-jjb-deploy-job
21 {project-name}-github-ci-jobs
22 -----------------------------
24 Recommended jobs that should be deployed CI using GitHub.
28 - github-jenkins-cfg-merge
29 - github-jenkins-sandbox-cleanup
30 - github-jjb-deploy-job
34 {project-name}-info-yaml-jobs
35 -----------------------------
37 Jobs to verify INFO.yaml file changes.
41 - gerrit-info-yaml-verify
43 {project-name}-github-info-yaml-jobs
44 ------------------------------------
46 Jobs to verify INFO.yaml file changes using Github.
50 - github-info-yaml-verify
52 {project-name}-packer-jobs
53 --------------------------
55 Jobs related to Packer builds for CI using Gerrit.
60 - gerrit-packer-verify
62 {project-name}-github-packer-jobs
63 ---------------------------------
65 Jobs related to Packer builds for CI using GitHub.
70 - github-packer-verify
75 lf-infra-jjb-parameters
76 -----------------------
80 :jjb-version: Version of Jenkins Job Builder (JJB) to install and use in
86 Deploys Jenkins Cloud configuration read from the ``jenkins-clouds`` directory
87 in ci-management repositories.
91 Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
92 config definitions for "production" and "sandbox" systems.
96 :jenkins-silos: Space-separated list of Jenkins silos to update
97 configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
99 lf-jenkins-cfg-global-vars
100 --------------------------
102 Manages the Global Jenkins variables. This macro will clear all exist macros
103 in Jenkins and replaces them with the ones defined by the
104 ci-management/jenkins-config/global-vars-SILO.sh script.
108 Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
109 config definitions for "production" and "sandbox" systems.
111 :Required parameters:
113 :jenkins-silos: Space-separated list of Jenkins silos to update
114 configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
119 Provides jenkins_jobs.ini configuration for Jenkins.
121 lf-infra-jjbini-sandbox
122 -----------------------
124 Provides jenkins_jobs.ini configuration for Jenkins sandbox.
126 .. todo:: This needs to be consolidated into lf-infra-jjbini when JJB 2.0 is available
131 Common packer configuration.
136 Gerrit file-paths for packer jobs.
141 Parameters useful for packer related tasks.
145 :packer-version: Version of packer to install / use.
146 (shell: PACKER_VERSION)
148 lf-packer-verify-file-paths
149 ---------------------------
151 Gerrit file-paths for packer verify jobs.
159 Job submits a patch to lock or unlock a project's branch.
162 - {project-name}-gerrit-branch-lock-{stream}
166 .. _lf-global-jjb-jenkins-cfg-merge:
168 Jenkins Configuration Merge
169 ---------------------------
171 Jenkins job to manage Global Jenkins configuration.
175 Requires the jjbini file in Jenkins CFP to contain JJB 2.0 style
176 config definitions for "production" and "sandbox" systems.
180 - {project-name}-jenkins-cfg-merge
181 - gerrit-jenkins-cfg-merge
182 - github-jenkins-cfg-merge
184 :Optional parameters:
186 :branch: Git branch to build against. (default: master)
187 :cron: How often to run the job on a cron schedule. (default: @daily)
188 :git-url: URL to clone project from. (default: $GIT_URL/$GERRIT_PROJECT)
189 :jenkins-silos: Space separated list of Jenkins silos to update
190 configuration for as defined in ~/.config/jenkins_jobs/jenkins_jobs.ini
191 (default: production sandbox)
193 Typically this template is automatically pulled in by the
194 "{project-name}-ci-jobs" job-group and does not need to be explicitly called if
195 the job group is being used.
199 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-minimal.yaml
204 .. literalinclude:: ../../.jjb-test/lf-ci-jobs/jenkins-cfg-merge-full.yaml
207 .. _jenkins-cfg-envvar:
209 Global Environment Variables
210 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
212 Global Environment Variables are managed via the
213 ``jenkins-config/global-vars-SILO.sh`` file in ci-management. Replace SILO with
214 the name of the Jenkins silo the variable configuration is for.
216 The format for this file is ``KEY=value`` for example::
218 GERRIT_URL=https://git.opendaylight.org/gerrit
219 GIT_BASE=git://devvexx.opendaylight.org/mirror/$PROJECT
220 GIT_URL=git://devvexx.opendaylight.org/mirror
221 JENKINS_HOSTNAME=vex-yul-odl-jenkins-2
222 LOGS_SERVER=https://logs.opendaylight.org
223 NEXUS_URL=https://nexus.opendaylight.org
224 ODLNEXUSPROXY=https://nexus.opendaylight.org
226 SONAR_URL=https://sonar.opendaylight.org
231 This configuration requires the OpenStack Cloud plugin in Jenkins and is
232 currently the only cloud plugin supported.
234 OpenStack Cloud plugin version supported:
239 Cloud configuration are managed via a directory structure in ci-management as
242 - jenkins-config/clouds/openstack/
243 - jenkins-config/clouds/openstack/cattle/cloud.cfg
244 - jenkins-config/clouds/openstack/cattle/centos7-builder-2c-2g.cfg
245 - jenkins-config/clouds/openstack/cattle/centos7-builder-4c-4g.cfg
246 - jenkins-config/clouds/openstack/cattle/centos7-docker-4c-4g.cfg
248 The directory name inside of the "openstack" directory is used as the name of
249 the cloud configuration. In this case "cattle" is being used as the cloud name.
251 The ``cloud.cfg`` file is a special file used to configure the main cloud
252 configuration in the format ``KEY=value``.
256 :CLOUD_URL: API endpoint URL for Keystone.
258 :CLOUD_IGNORE_SSL: Ignore unverified SSL certificates. (default: false)
259 :CLOUD_ZONE: OpenStack region to use. (default: "")
260 :CLOUD_CREDENTIAL_ID: Credential to use for authentication to OpenStack.
261 (default: "os-cloud")
262 :INSTANCE_CAP: Total number of instances the cloud will allow spin up.
264 :SANDBOX_CAP: Total number of instances the clodu will allow to
265 spin up. This applies to "sandbox" systems and overrides the
266 INSTANCE_CAP setting. (default: null)
268 :Template Parameters:
272 In the case of template definitions of a parameter below is not passed
273 the one defined in default clouds will be inherited.
275 :IMAGE_NAME: The image name to use for this template.
277 :LABELS: Labels to assign to the vm. (default: FILE_NAME)
278 :HARDWARE_ID: OpenStack flavor to use. (default: "")
279 :NETWORK_ID: OpenStack network to use. (default: "")
280 :USER_DATA_ID: User Data to pass into the instance.
281 (default: jenkins-init-script)
282 :INSTANCE_CAP: Total number of instances of this type that can be launched
283 at one time. When defined in clouds.cfg it defines the total for the
284 entire cloud. (default: null)
285 :SANDBOX_CAP: Total number of instances of this type that can be launched
286 at one time. When defined in clouds.cfg it defines the total for the
287 entire cloud. This applies to "sandbox" systems and overrides the
288 INSTANCE_CAP setting. (default: null)
289 :FLOATING_IP_POOL: Floating ip pool to use. (default: "")
290 :SECURITY_GROUPS: Security group to use. (default: "default")
291 :AVAILABILITY_ZONE: OpenStack availability zone to use. (default: "")
292 :START_TIMEOUT: Number of milliseconds to wait for the agent to be
293 provisioned and connected. (default: 600000)
294 :KEY_PAIR_NAME: SSH Public Key Pair to use for authentication.
296 :NUM_EXECUTORS: Number of executors to enable for the instance.
298 :JVM_OPTIONS: JVM Options to pass to Java. (default: "")
299 :FS_ROOT: File system root for the workspace. (default: "/w")
300 :RETENTION_TIME: Number of minutes to wait for an idle slave to be used
301 again before it's removed. If set to -1, the slave will be kept
302 forever. (default: 0)
303 :CONNECTION_TYPE: The connection type for Jenkins to connect to the build
304 minion. Valid options: JNLP, SSH. (default: "SSH")
306 For a live example see the OpenDaylight project jenkins-config directory.
307 https://github.com/opendaylight/releng-builder/tree/master/jenkins-config
312 :Cloud Configuration:
314 The directory ``groovy-inserts`` contains the groovy script output that is
315 used to push to Jenkins. In the event of a job failure this file can be
319 Jenkins Sandbox Cleanup
320 -----------------------
322 Cleanup Jenkins Sandbox of jobs and views periodically.
326 - {project-name}-jenkins-sandbox-cleanup
327 - gerrit-jenkins-sandbox-cleanup
328 - github-jenkins-sandbox-cleanup
330 :Comment Trigger: NONE
332 :Required parameters:
334 :build-node: The node to run build on.
335 :jenkins-ssh-credential: Credential to use for SSH. (Generally
336 should be configured in defaults.yaml)
338 :Optional parameters:
340 :cron: Schedule to run job. (default: '0 8 * * 6')
346 Deploy jobs to jenkins-sandbox system via code review comment
348 This job checks out the current code review patch and then runs a
349 `jenkins-jobs update` to push a patch defined by the comment.
353 - {project-name}-jjb-deploy-job
354 - gerrit-jjb-deploy-job
355 - github-jjb-deploy-job
357 :Comment Trigger: jjb-deploy JOB_NAME
361 JOB_NAME can include the * wildcard character to push multiple jobs
362 matching the pattern. For example `jjb-deploy builder-jjb-*`` will push
363 all builder-jjb-* jobs to the sandbox system.
365 :Required parameters:
367 :build-node: The node to run build on.
368 :jenkins-ssh-credential: Credential to use for SSH. (Generally
369 should be configured in defaults.yaml)
371 :Optional parameters:
373 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
374 :gerrit_jjb_deploy_job_triggers: Override Gerrit Triggers.
380 Runs `jenkins-jobs update` to update production job configuration
383 - {project-name}-jjb-merge
387 :Comment Trigger: remerge
389 :Required parameters:
391 :build-node: The node to run build on.
392 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
393 be configured in defaults.yaml)
395 :Optional parameters:
397 :branch: Git branch to fetch for the build. (default: master)
398 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
399 :build-timeout: Timeout in minutes before aborting build. (default: 10)
400 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
401 :stream: Keyword that can be used to represent a release code-name.
402 Often the same as the branch. (default: master)
403 :submodule-recursive: Whether to checkout submodules recursively.
406 :gerrit_merge_triggers: Override Gerrit Triggers.
407 :gerrit_trigger_file_paths: Override file paths which can be used to
408 filter which file modifications will trigger a build.
409 (default defined by lf_jjb_common)
415 Runs `jenkins-jobs test` to validate JJB syntax
418 - {project-name}-jjb-verify
422 :Comment Trigger: recheck|reverify
424 :Required parameters:
426 :build-node: The node to run build on.
427 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
428 be configured in defaults.yaml)
430 :Optional parameters:
432 :branch: Git branch to fetch for the build. (default: master)
433 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
434 :build-timeout: Timeout in minutes before aborting build. (default: 10)
435 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
436 :stream: Keyword that can be used to represent a release code-name.
437 Often the same as the branch. (default: master)
438 :submodule-recursive: Whether to checkout submodules recursively.
441 :gerrit_verify_triggers: Override Gerrit Triggers.
442 :gerrit_trigger_file_paths: Override file paths which can be used to
443 filter which file modifications will trigger a build.
444 (default defined by lf_jjb_common)
446 .. _info-yaml-verify:
451 Info YAML Verify job validates that INFO.yaml file changes are kept isolated from
452 other file changes. Verifies INFO.yaml files follow the schema defined in
453 `global-jjb/info-schema`.
456 - {project-name}-info-yaml-verify
457 - gerrit-info-yaml-verify
458 - github-info-yaml-verify
460 :Required parameters:
462 :build-node: The node to run build on.
463 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
464 be configured in defaults.yaml)
466 :Optional parameters:
468 :branch: Git branch to fetch for the build. (default: master)
469 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
470 :build-timeout: Timeout in minutes before aborting build. (default: 10)
471 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
472 :stream: Keyword that can be used to represent a release code-name.
473 Often the same as the branch. (default: master)
474 :submodule-recursive: Whether to checkout submodules recursively.
476 :gerrit_verify_triggers: Override Gerrit Triggers.
483 Job to scan projects for files missing license headers.
486 - {project-name}-license-check
487 - gerrit-license-check
488 - github-license-check
490 :Optional parameters:
492 :build-timeout: Timeout in minutes before aborting build. (default: 15)
493 :file-patterns: Space-separated list of file patterns to scan.
494 (default: \*.go \*.groovy \*.java \*.py \*.sh)
495 :spdx-disable: Disable the SPDX-Identifier checker. (default: false)
496 :lhc-version: Version of LHC to use. (default: 0.2.0)
497 :license-exclude-paths: Comma-separated list of paths to exclude from the
498 license checker. The paths used here will be matched using a contains
499 rule so it is best to be as precise with the path as possible.
500 For example a path of '/src/generated/' will be searched as
501 '**/src/generated/**'.
502 Example: org/opendaylight/yang/gen,protobuff/messages
504 :licenses-allowed: Comma-separated list of allowed licenses.
505 (default: Apache-2.0,EPL-1.0,MIT)
506 :project-pattern: The ANT based pattern for Gerrit Trigger to choose which
507 projects to trigger job against. (default: '**')
509 .. _gjjb-packer-merge:
514 Packer Merge job runs `packer build` to build system images in the cloud.
517 - {project-name}-packer-merge-{platforms}-{templates}
518 - gerrit-packer-merge
519 - github-packer-merge
521 :Comment Trigger: remerge
523 :Required parameters:
525 :build-node: The node to run build on.
526 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
527 be configured in defaults.yaml)
528 :mvn-settings: The name of settings file containing credentials for
530 :platforms: Platform or distribution to build. Typically json file
531 found in the packer/vars directory. (Example: centos)
532 :template: System template to build. Typically shell script found in
533 the packer/provision directory. (Example: java-builder)
535 :Optional parameters:
537 :cron: Time when the packer image should be rebuilt (default: @monthly)
538 :branch: Git branch to fetch for the build. (default: master)
539 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
540 :build-timeout: Timeout in minutes before aborting build. (default: 90)
541 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
542 :packer-cloud-settings: Name of settings file containing credentials
543 for the cloud that packer will build on. (default: packer-cloud-env)
544 :packer-version: Version of packer to install / use in build. (default: 1.0.2)
545 :stream: Keyword that can be used to represent a release code-name.
546 Often the same as the branch. (default: master)
547 :submodule-recursive: Whether to checkout submodules recursively.
550 :gerrit_verify_triggers: Override Gerrit Triggers.
553 .. _gjjb-packer-verify:
558 Packer Verify job runs `packer validate` to verify packer configuration.
561 - {project-name}-packer-verify
562 - gerrit-packer-verify
563 - github-packer-verify
565 :Comment Trigger: recheck|reverify
567 :Required parameters:
569 :build-node: The node to run build on.
570 :jenkins-ssh-credential: Credential to use for SSH. (Generally should
571 be configured in defaults.yaml)
572 :mvn-settings: The name of settings file containing credentials for
575 :Optional parameters:
577 :branch: Git branch to fetch for the build. (default: master)
578 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
579 :build-timeout: Timeout in minutes before aborting build. (default: 10)
580 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
581 :packer-cloud-settings: Name of settings file containing credentials
582 for the cloud that packer will build on. (default: packer-cloud-env)
583 :packer-version: Version of packer to install / use in build. (default: 1.0.2)
584 :stream: Keyword that can be used to represent a release code-name.
585 Often the same as the branch. (default: master)
586 :submodule-recursive: Whether to checkout submodules recursively.
589 :gerrit_verify_triggers: Override Gerrit Triggers.
590 :gerrit_trigger_file_paths: Override file paths which can be used to
591 filter which file modifications will trigger a build.