6 The `Release Engineering Project <releng-wiki_>`_ consolidates the Jenkins jobs from
7 project-specific VMs to a single Jenkins server. Each OpenDaylight project
8 has a tab for their jobs on the `jenkins-master`_. The system utilizes
9 `Jenkins Job Builder <jjb-docs_>`_ for the creation and management of the
18 New Project Quick Start
19 -----------------------
21 This section attempts to provide details on how to get going as a new project
22 quickly with minimal steps. The rest of the guide should be read and understood
23 by those who need to create and contribute new job types that is not already
24 covered by the existing job templates provided by OpenDaylight's JJB repo.
26 As a new project you will be mainly interested in getting your jobs to appear
27 in the jenkins-master_ silo and this can be achieved by simply creating a
28 <project>.yaml in the releng/builder project's jjb directory.
32 git clone --recursive https://git.opendaylight.org/gerrit/releng/builder
34 mkdir jjb/<new-project>
38 releng/global-jjb is a submodule of releng/builder repository which
39 requires a git submodule update --init or using --recursive with git clone.
42 Where <new-project> should be the same name as your project's git repo in
43 Gerrit. If your project is called "aaa" then create a new jjb/aaa directory.
45 Next we will create <new-project>.yaml as follows:
51 name: <NEW_PROJECT>-carbon
53 - '{project-name}-clm-{stream}'
54 - '{project-name}-integration-{stream}'
55 - '{project-name}-merge-{stream}'
56 - '{project-name}-verify-{stream}-{maven}-{jdks}'
58 project: '<NEW_PROJECT>'
59 project-name: '<NEW_PROJECT>'
68 mvn-settings: '<NEW_PROJECT>-settings'
69 mvn-goals: 'clean install -Dmaven.repo.local=/tmp/r -Dorg.ops4j.pax.url.mvn.localRepository=/tmp/r'
70 mvn-opts: '-Xmx1024m -XX:MaxPermSize=256m'
71 dependencies: 'odlparent-merge-{stream},yangtools-merge-{stream},controller-merge-{stream}'
72 email-upstream: '[<NEW_PROJECT>] [odlparent] [yangtools] [controller]'
76 name: <NEW_PROJECT>-sonar
78 - '{project-name}-sonar'
80 project: '<NEW_PROJECT>'
81 project-name: '<NEW_PROJECT>'
83 mvn-settings: '<NEW_PROJECT>-settings'
84 mvn-goals: 'clean install -Dmaven.repo.local=/tmp/r -Dorg.ops4j.pax.url.mvn.localRepository=/tmp/r'
85 mvn-opts: '-Xmx1024m -XX:MaxPermSize=256m'
87 Replace all instances of <new-project> with the name of your project. This will
88 create the jobs with the default job types we recommend for Java projects. If
89 your project is participating in the simultanious-release and ultimately will
90 be included in the final distribution, it is required to add the following job
91 types into the job list for the release you are participating.
96 - '{project-name}-distribution-check-{stream}'
97 - '{project-name}-validate-autorelease-{stream}'
99 If you'd like to explore the additional tweaking options available
100 please refer to the `Jenkins Job Templates`_ section.
102 Finally we need to push these files to Gerrit for review by the releng/builder
103 team to push your jobs to Jenkins.
107 git add jjb/<new-project>
108 git commit -sm "Add <new-project> jobs to Jenkins"
111 This will push the jobs to Gerrit and your jobs will appear in Jenkins once the
112 releng/builder team has reviewed and merged your patch.
117 The `jenkins-master`_ is the home for all project's Jenkins jobs. All
118 maintenance and configuration of these jobs must be done via JJB through the
119 `releng-builder-repo`_. Project contributors can no longer edit the Jenkins jobs
120 directly on the server.
125 The Jenkins jobs are run on build minions (executors) which are created on an
126 as-needed basis. If no idle build minions are available a new VM is brought
127 up. This process can take up to 2 minutes. Once the build minion has finished a
128 job, it will be destroyed.
130 Our Jenkins master supports many types of dynamic build minions. If you are
131 creating custom jobs then you will need to have an idea of what type of minions
132 are available. The following are the current minion types and descriptions.
133 Minion Template Names are needed for jobs that take advantage of multiple
134 minions as they must be specifically called out by template name instead of
137 Adding New Components to the Minions
138 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
140 If your project needs something added to one of the minions, you can help us
141 get things added faster by doing one of the following:
143 * Submit a patch to RelEng/Builder for the appropriate `jenkins-scripts`
144 definition which configure software during minion boot up.
145 * Submit a patch to RelEng/Builder for the `packer/provision` scripts that
146 configures software during minion instance imaging.
147 * Submit a patch to RelEng/Builder for the Packer's templates in
148 the `packer/templates` directory that configures a new instance definition
149 along with changes in `packer/provision`.
151 Going the first route will be faster in the short term as we can inspect the
152 changes and make test modifications in the sandbox to verify that it works.
156 The first route may add additional setup time considering this is run every
157 time the minion is booted.
159 The second and third routes, however, is better for the community as a whole as
160 it will allow others to utilize our Packer setups to replicate our systems more
161 closely. It is, however, more time consuming as an image snapshot needs to be
162 created based on the updated Packer definitions before it can be attached to the
163 Jenkins configuration on sandbox for validation testing.
165 In either case, the changes must be validated in the sandbox with tests to
166 make sure that we don't break current jobs and that the new software features
167 are operating as intended. Once this is done the changes will be merged and
168 the updates applied to the RelEng Jenkins production silo. Any changes to
169 files under `releng/builder/packer` will be validated and images would be built
170 triggered by verify-packer and merge-packer jobs.
172 Please note that the combination of a Packer definitions from `vars`, `templates`
173 and the `provision` scripts is what defines a given minion. For instance, a minion
174 may be defined as `centos7-builder` which is a combination of Packer OS image
175 definitions from `vars/centos.json`, Packer template definitions from
176 `templates/builder.json` and spinup scripts from `provision/builder.sh`.
177 This combination provides the full definition of the realized minion.
179 Jenkins starts a minion using the latest image which is built and linked into the
180 Jenkins configuration. Once the base instance is online Jenkins checks out the
181 RelEng/Builder repo on it and executes two scripts. The first is
182 `provision/baseline.sh`, which is a baseline for all of the minions.
184 The second is the specialized script, which handles any system updates,
185 new software installs or extra environment tweaks that don't make sense in a
186 snapshot. Examples could include installing new package or setting up a virtual
187 environment. Its imperative to ensure modifications to these spinup scripts have
188 considered time taken to install the packages, as this could increase the build
189 time for every job which runs on the image. After all of these scripts have
190 executed Jenkins will finally attach the minion as an actual minion and start
196 Performance flavors come with dedicated CPUs and are not shared with other
197 accounts in the cloud so should ensure consistent performance.
199 .. list-table:: Flavors
244 <table class="table table-bordered">
246 <td><b>Jenkins Labels</b><br/>
247 centos7-builder-2c-1g,<br/>
248 centos7-builder-2c-2g,<br/>
249 centos7-builder-2c-8g,<br/>
250 centos7-builder-4c-4g,<br/>
251 centos7-builder-8c-8g,<br/>
252 centos7-autorelease-4c-16g
254 <td><b>Minion Template names</b><br/>
255 prd-centos7-builder-2c-1g,<br/>
256 prd-centos7-builder-2c-2g,<br/>
257 prd-centos7-builder-2c-8g,<br/>
258 prd-centos7-builder-4c-4g,<br/>
259 prd-centos7-builder-8c-8g,<br/>
260 prd-centos7-autorelease-4c-16g
261 <td><b>Packer Template</b><br/>
262 releng/builder/packer/templates/builder.json</td>
263 <td><b>Spinup Script</b><br/>
264 releng/builder/jenkins-scripts/builder.sh</td>
268 CentOS 7 build minion configured with OpenJDK 1.7 (Java7) and OpenJDK
269 1.8 (Java8) along with all the other components and libraries needed
270 for building any current OpenDaylight project. This is the label that
271 is used for all basic verify, merge and daily builds for
277 <td><b>Jenkins Labels</b><br/> centos7-robot-2c-2g</td>
278 <td><b>Minion Template names</b><br/> centos7-robot-2c-2g</td>
279 <td><b>Packer Template</b><br/>
280 releng/builder/packer/templates/robot.json</td>
281 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/robot.sh</td>
285 CentOS 7 minion configured with OpenJDK 1.7 (Java7), OpenJDK
286 1.8 (Java8) and all the current packages used by the integration
287 project for doing robot driven jobs. If you are executing robot
288 framework jobs then your job should be using this as the minion that
289 you are tied to. This image does not contain the needed libraries for
290 building components of OpenDaylight, only for executing robot tests.
295 <td><b>Jenkins Labels</b><br/> ubuntu1404-mininet-2c-2g</td>
296 <td><b>Minion Template names</b><br/> ubuntu1404-mininet-2c-2g</td>
297 <td><b>Packer Template</b><br/>
298 releng/builder/packer/teamplates/mininet.json</td>
299 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
303 Basic Ubuntu 14.04 (Trusty) system with ovs 2.0.2 and mininet 2.1.0
308 <td><b>Jenkins Labels</b><br/> ubuntu1404-mininet-ovs-23-2c-2g</td>
309 <td><b>Minion Template names</b><br/> ubuntu1404-mininet-ovs-23-2c-2g</td>
310 <td><b>Packer Template</b><br/> releng/builder/packer/templates/mininet-ovs-2.3.json</td>
311 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
315 Ubuntu 16.04 (Xenial) system with ovs 2.5 and mininet 2.2.1
320 <td><b>Jenkins Labels</b><br/> centos7-devstack-2c-4g</td>
321 <td><b>Minion Template names</b><br/> centos7-devstack-2c-4g</td>
322 <td><b>Packer Template</b><br/> releng/builder/packer/templates/devstack.json</td>
323 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/devstack.sh</td>
327 CentOS 7 system purpose built for doing OpenStack testing using
328 DevStack. This minion is primarily targeted at the needs of the OVSDB
329 project. It has OpenJDK 1.7 (aka Java7) and OpenJDK 1.8 (Java8) and
330 other basic DevStack related bits installed.
335 <td><b>Jenkins Labels</b><br/> centos7-docker-2c-4g</td>
336 <td><b>Minion Template names</b><br/> centos7-docker-2c-4g</td>
337 <td><b>Packer Template</b><br/> releng/builder/packer/templates/docker.json</td>
338 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/docker.sh</td>
342 CentOS 7 system configured with OpenJDK 1.7 (aka Java7),
343 OpenJDK 1.8 (Java8) and Docker. This system was originally custom
344 built for the test needs of the OVSDB project but other projects have
345 expressed interest in using it.
350 <td><b>Jenkins Labels</b><br/> ubuntu1404-gbp-2c-2g</td>
351 <td><b>Minion Template names</b><br/> ubuntu1404-gbp-2c-2g</td>
352 <td><b>Packer Template</b><br/> releng/builder/packer/templates/gbp.json</td>
353 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/ubuntu-docker-ovs.sh</td>
357 Ubuntu 14.04 (Trusty) node with latest OVS and docker installed. Used by Group Based Policy.
362 <td><b>Jenkins Labels</b><br/> ubuntu1604-gbp-2c-4g</td>
363 <td><b>Minion Template names</b><br/> ubuntu1604-gbp-2c-4g</td>
364 <td><b>Packer Template</b><br/> releng/builder/packer/templates/gbp.json</td>
365 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/ubuntu-docker-ovs.sh</td>
369 Ubuntu 16.04 (Xenial) node with latest OVS and docker installed. Used by Group Based Policy.
375 Pool: ODLVEX - HOT (Heat Orchestration Templates)
376 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
378 HOT integration enables to spin up integration labs servers for CSIT jobs
379 using heat, rathar than using jclouds (deprecated). Image names are updated
380 on the project specific job templates using the variable
381 `{odl,docker,openstack,tools}_system_image` followed by image name in the
382 format `<platform> - <template> - <date-stamp>`.
384 .. include:: cloud-images.rst
386 Creating Jenkins Jobs
387 ---------------------
389 Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format
390 and uses them to configure Jenkins.
392 * `Jenkins Job Builder (JJB) documentation <jjb-docs_>`_
393 * `RelEng/Builder Gerrit <releng-builder-gerrit_>`_
394 * `RelEng/Builder Git repository <releng-builder-repo_>`_
396 Getting Jenkins Job Builder
397 ---------------------------
399 OpenDaylight uses Jenkins Job Builder to translate our in-repo YAML job
400 configuration into job descriptions suitable for consumption by Jenkins.
401 When testing new Jenkins Jobs in the `Jenkins Sandbox`_, you'll
402 need to use the `jenkins-jobs` executable to translate a set of jobs into
403 their XML descriptions and upload them to the sandbox Jenkins server.
405 We document `installing <Installing Jenkins Job Builder_>`_ `jenkins-jobs`
408 Installing Jenkins Job Builder
409 ------------------------------
411 We recommend using `pip <Installing JJB using pip_>`_ to assist with JJB
413 also document `installing from a git repository manually
414 <Installing JJB Manually_>`_.
415 For both, we recommend using Python `Virtual Environments`_
416 to isolate JJB and its dependencies.
418 The `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file contains the currently
419 recommended JJB version. Because JJB is fairly unstable, it may be necessary
420 to debug things by installing different versions. This is documented for both
421 `pip-assisted <Installing JJB using pip_>`_ and `manual
422 <Installing JJB Manually_>`_ installs.
427 For both `pip-assisted <Installing JJB using pip_>`_ and `manual
428 <Installing JJB Manually_>`_ JJB
429 installs, we recommend using `Python Virtual Environments <python-virtualenv_>`_
430 to manage JJB and its
431 Python dependencies. The `python-virtualenvwrapper`_ tool can help you do so.
433 Documentation is available for installing `python-virtualenvwrapper`_. On Linux
434 systems with pip (typical), they amount to:
438 sudo pip install virtualenvwrapper
440 A virtual environment is simply a directory that you install Python programs
441 into and then append to the front of your path, causing those copies to be
442 found before any system-wide versions.
444 Create a new virtual environment for JJB.
448 # Virtaulenvwrapper uses this dir for virtual environments
450 /home/daniel/.virtualenvs
451 # Make a new virtual environment
453 # A new venv dir was created
454 (jjb)$ ls -rc $WORKON_HOME | tail -n 1
456 # The new venv was added to the front of this shell's path
458 /home/daniel/.virtualenvs/jjb/bin:<my normal path>
459 # Software installed to venv, like pip, is found before system-wide copies
460 (jjb)$ command -v pip
461 /home/daniel/.virtualenvs/jjb/bin/pip
463 With your virtual environment active, you should install JJB. Your install will
464 be isolated to that virtual environment's directory and only visible when the
465 virtual environment is active.
467 You can easily leave and return to your venv. Make sure you activate it before
473 $ command -v jenkins-jobs
474 # No jenkins-jobs executable found
476 (jjb)$ command -v jenkins-jobs
477 $WORKON_HOME/jjb/bin/jenkins-jobs
479 Installing JJB using pip
480 ------------------------
482 The recommended way to install JJB is via pip.
484 First, clone the latest version of the `releng-builder-repo`_.
488 $ git clone --recursive https://git.opendaylight.org/gerrit/p/releng/builder.git
490 Before actually installing JJB and its dependencies, make sure you've `created
491 and activated <Virtual Environments_>`_ a virtual environment for JJB.
497 The recommended version of JJB to install is the version specified in the
498 `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file.
502 # From the root of the releng/builder repo
503 (jjb)$ pip install -r jjb/requirements.txt
505 To validate that JJB was successfully installed you can run this command:
509 (jjb)$ jenkins-jobs --version
511 TODO: Explain that only the currently merged jjb/requirements.txt is supported,
512 other options described below are for troubleshooting only.
514 To change the version of JJB specified by `builder/jjb/requirements.txt
515 <odl-jjb-requirements.txt_>`_
516 to install from the latest commit to the master branch of JJB's git repository:
520 $ cat jjb/requirements.txt
521 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder#egg=jenkins-job-builder
523 To install from a tag, like 1.4.0:
527 $ cat jjb/requirements.txt
528 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder@1.4.0#egg=jenkins-job-builder
530 Updating releng/builder repo or global-jjb
531 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
533 Follow these steps to update the releng/builder repo. The repo uses a submodule from
534 a global-jjb repo so that common source can be shared across different projects. This
535 requires updating the releng/builder repo periodically to pick up the changes. New
536 versions of jjb could also require updating the releng/builder repo. Follow the
537 previous steps earlier for updating jenkins-jobs using the
538 `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file. Ensure that the
539 version listed in the file is the currently supported version, otherwise install a
540 different version or simply upgrade using `pip install --upgrade jenkins-job-builder`.
542 The example below assumes the user has cloned releng/builder to `~/git/releng/builder`.
543 Update the repo, update the submodules and then submit a test to verify it works.
547 cd ~/git/releng/builder
550 git submodule update --init --recursive
551 jenkins-jobs --conf jenkins.ini test jjb/ netvirt-csit-1node-openstack-queens-upstream-stateful-fluorine
553 Installing JJB Manually
554 -----------------------
556 This section documents installing JJB from its manually cloned repository.
558 Note that `installing via pip <Installing JJB using pip_>`_ is typically simpler.
560 Checkout the version of JJB's source you'd like to build.
562 For example, using master:
566 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
568 Using a tag, like 1.4.0:
572 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
573 $ cd jenkins-job-builder
574 $ git checkout tags/1.4.0
576 Before actually installing JJB and its dependencies, make sure you've `created
577 and activated <Virtual Environments_>`_ a virtual environment for JJB.
583 You can then use JJB's `requirements.txt <jjb-requirements.txt_>`_ file to
585 dependencies. Note that we're not using `sudo` to install as root, since we want
586 to make use of the venv we've configured for our current user.
590 # In the cloned JJB repo, with the desired version of the code checked out
591 (jjb)$ pip install -r requirements.txt
593 Then install JJB from the repo with:
599 To validate that JJB was successfully installed you can run this command:
603 (jjb)$ jenkins-jobs --version
606 Jenkins Job Templates
607 ---------------------
609 The OpenDaylight `RelEng/Builder <releng-builder-wiki_>`_ project provides
610 `jjb-templates`_ that can be used to define basic jobs.
612 The *Gerrit Trigger* listed in the jobs are keywords that can be used to
613 trigger the job to run manually by simply leaving a comment in Gerrit for the
614 patch you wish to trigger against.
616 All jobs have a default build-timeout value of 360 minutes (6 hrs) but can be
617 overrided via the opendaylight-infra-wrappers' build-timeout property.
619 TODO: Group jobs into categories: every-patch, after-merge, on-demand, etc.
620 TODO: Reiterate that "remerge" triggers all every-patch jobs at once,
621 because when only a subset of jobs is triggered, Gerrit forgets valid -1 from jobs outside the subset.
622 TODO: Document that only drafts and commit-message-only edits do not trigger every-patch jobs.
623 TODO: Document test-{project}-{feature} and test-{project}-all.
627 <table class="table table-bordered">
629 <td><b>Job Template</b><br/>{project}-distribution-check-{stream}</td>
630 <td><b>Gerrit Trigger</b><br/>recheck</td>
634 This job runs the PROJECT-distribution-check-BRANCH job which is
635 building also integration/distribution project in order to run SingleFeatureTest.
636 It also performs various other checks in order to prevent the change to break autorelease.
641 <td><b>Job Template</b><br/>{project}-integration-{stream}</td>
646 The Integration Job Template creates a job which runs when a project that your
647 project depends on is successfully built. This job type is basically the same
648 as a verify job except that it triggers from other Jenkins jobs instead of via
649 Gerrit review updates. The dependencies that triger integration jobs are listed
650 in your project.cfg file under the <b>DEPENDENCIES</b> variable.
652 If no dependencies are listed then this job type is disabled by default.
657 <td><b>Job Template</b><br/>{project}-merge-{stream}</td>
658 <td><b>Gerrit Trigger</b><br/>remerge</td>
662 This job will trigger once a Gerrit patch is merged into the repo.
663 It will build HEAD of the current project branch and also run the Maven goals
664 <b>source:jar</b> and <b>javadoc:jar</b>.
665 Artifacts are uploaded to OpenDaylight's
666 <a href="https://nexus.opendaylight.org">Nexus</a> on completion.
668 A distribution-merge-{stream} job is triggered to add the new artifacts to the
669 integration distribution.
671 Running the "remerge" trigger is possible before a Change is merged,
672 it would still build the actual HEAD. This job does not alter Gerrit votes.
677 <td><b>Job Template</b><br/>{project}-sonar</td>
678 <td><b>Gerrit Trigger</b><br/>run-sonar</td>
682 This job runs Sonar analysis and reports the results to
683 OpenDaylight's <a href="https://sonar.opendaylight.org">Sonar</a>
686 The Sonar Job Template creates a job which will run against the
687 master branch, or if BRANCHES are specified in the CFG file it will
688 create a job for the <b>First</b> branch listed.
690 <div class="admonition note">
691 <p class="first admonition-title">Note</p>
693 Running the "run-sonar" trigger will cause Jenkins to remove
694 its existing vote if it's already -1'd or +1'd a comment. You
695 will need to re-run your verify job (recheck) after running
696 this to get Jenkins to re-vote.
703 <td><b>Job Template</b><br/>{project}-validate-autorelease-{stream}</td>
704 <td><b>Gerrit Trigger</b><br/>recheck</td>
708 This job runs the PROJECT-validate-autorelease-BRANCH job which is
709 used as a quick sanity test to ensure that a patch does not depend on
710 features that do not exist in the current release.
715 <td><b>Job Template</b><br/>{project}-verify-{stream}-{maven}-{jdks}</td>
716 <td><b>Gerrit Trigger</b><br/>recheck</td>
720 The Verify job template creates a Gerrit Trigger job that will
721 trigger when a new patch is submitted to Gerrit.
722 The job only builds the project code (including unit and integration tests).
727 <td><b>Job Template</b><br/>{project}-verify-node-{stream}</td>
728 <td><b>Gerrit Trigger</b><br/>recheck</td>
732 This job template can be used by a project that is NodeJS based. It
733 simply installs a python virtualenv and uses that to install nodeenv
734 which is then used to install another virtualenv for nodejs. It then
735 calls <b>npm install</b> and <b>npm test</b> to run the unit tests.
736 When using this template you need to provide a {nodedir} and
737 {nodever} containing the directory relative to the project root
738 containing the nodejs package.json and version of node you wish to
744 <td><b>Job Template</b><br/>{project}-verify-python-{stream} | {project}-verify-tox-{stream}</td>
745 <td><b>Gerrit Trigger</b><br/>recheck</td>
749 This job template can be used by a project that uses Tox to build. It
750 simply installs a Python virtualenv and uses tox to run the tests
751 defined in the project's tox.ini file. If the tox.ini is anywhere
752 other than the project's repo root, the path to its directory
753 relative to the project's repo root should be passed as {toxdir}.
755 The 2 template names verify-python & verify-tox are identical and are
756 aliases to each other. This allows the project to use the naming that
757 is most reasonable for them.
762 <td><b>Job Template</b><br/>integration-patch-test-{stream}</td>
763 <td><b>Gerrit Trigger</b><br/>test-integration</td>
767 This job builds a distribution against your Java patch and triggers distribution sanity CSIT jobs.
768 Leave a comment with trigger keyword above to activate it for a particular patch.
769 This job should not alter Gerrit votes for a given patch.
771 The list of CSIT jobs to trigger is defined in csit-list
772 <a href="https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/integration/integration-test-jobs.yaml">here</a>.
774 Some considerations when using this job:
777 The patch test verification takes some time (~2 hours) + consumes a lot of
778 resources so it is not meant to be used for every patch.
781 The system tests for master patches will fail most of the times because both
782 code and test are unstable during the release cycle (should be good by the
786 Because of the above, patch test results typically have to be interpreted by
787 system test experts. The <a href="https://wiki.opendaylight.org/view/Integration/Test">Integration/Test</a>
788 project can help with that.
794 <td><b>Job Template</b><br/>integration-multipatch-test-{stream}</td>
795 <td><b>Gerrit Trigger</b><br/>multipatch-build</td>
799 This job builds a list of patches provided in an specific order, and finally builds
800 a distribution from either provided patch or latest code in branch.
801 For example if someone leaves the following comment in a patch:
802 multipatch-build:controller=61/29761/5:45/29645/6,neutron=51/65551/4,netvirt:59/60259/17
803 the job will checkout controller patch 61/29761/5, cherry-pick 45/29645/6 and build controller,
804 checkout neutron patch 51/65551/4 and build neutron, checkout latest netvirt code,
805 cherry-pick 59/60259/17 and build netvirt, finally it will checkout latest distribution
806 code and build a distribution. The resulting distribution is stored in Nexus and the URL
807 is stored in a variable called BUNDLE_URL visible in the job console.
808 This job also accepts a gerrit topic, for example: multipatch-build:topic=binding-tlc-rpc,
809 in this case the job will find all patches in the topic binding-tlc-rpc for the projects
810 specified in the BUILD_ORDER parameter and will build all projects from the first a patch
811 has been found, for successive projects the branch HEAD is used if no patch is found.
812 The job uses patch numbers to sort patches in the same project.
813 Use multipatch-build-fast (vs multipatch-build) for building projects fast (-Pq).
814 This job should not alter Gerrit votes for a given patch, nor will do anything with the
815 given patch unless the patch is added to the build list.
824 We provide a properties which your job can take advantage of if you want to do
825 something different depending on the job type that is run. If you create a
826 profile that activates on a property listed blow. The JJB templated jobs will
827 be able to activate the profile during the build to run any custom code you
828 wish to run in your project.
832 -Dmerge : This flag is passed in our Merge job and is equivalent to the
835 -Dsonar : This flag is passed in our Sonar job and is equivalent to the
839 .. _odl-jenkins-sandbox:
844 The `jenkins-sandbox`_ instance's purpose is to allow projects to test their JJB
845 setups before merging their code over to the RelEng master silo. It is
846 configured similarly to the master instance, although it cannot publish
847 artifacts or vote in Gerrit.
849 If your project requires access to the sandbox please open an OpenDaylight
850 Helpdesk ticket (<helpdesk@opendaylight.org>) and provide your ODL ID.
852 Notes Regarding the Sandbox
853 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
855 * Jobs are automatically deleted every Saturday at 08:00 UTC
856 * Committers can login and configure Jenkins jobs in the sandbox directly
857 (unlike with the master silo)
858 * Sandbox configuration mirrors the master silo when possible
859 * Sandbox jobs can NOT upload artifacts to Nexus
860 * Sandbox jobs can NOT vote on Gerrit
865 Make sure you have Jenkins Job Builder [properly installed](#jjb_install).
867 If you do not already have access, open an OpenDaylight Helpdesk ticket
868 (<helpdesk@opendaylight.org>) to request access to ODL's sandbox instance.
869 Integration/Test (`integration-test-wiki`_) committers have access by default.
871 JJB reads user-specific configuration from a `jenkins.ini`_. An
872 example is provided by releng/builder at `example-jenkins.ini`_.
876 # If you don't have RelEng/Builder's repo, clone it
877 $ git clone --recursive https://git.opendaylight.org/gerrit/p/releng/builder.git
878 # Make a copy of the example JJB config file (in the builder/ directory)
879 $ cp jenkins.ini.example jenkins.ini
880 # Edit jenkins.ini with your username, API token and ODL's sandbox URL
884 user=<your ODL username>
885 password=<your ODL Jenkins sandbox API token>
886 url=https://jenkins.opendaylight.org/sandbox
889 To get your API token, `login to the Jenkins **sandbox** instance
890 <jenkins-sandbox-login_>`_ (*not
891 the main master Jenkins instance, different tokens*), go to your user page (by
892 clicking on your username, for example), click "Configure" and then "Show API
898 If you `installed JJB locally into a virtual environment
899 <Installing Jenkins Job Builder_>`_,
900 you should now activate that virtual environment to access the `jenkins-jobs`
908 You'll want to work from the root of the RelEng/Builder repo, and you should
909 have your `jenkins.ini` file [properly configured](#sandbox_config).
914 It's good practice to use the `test` command to validate your JJB files before
919 jenkins-jobs --conf jenkins.ini test jjb/ <job-name>
921 If the job you'd like to test is a template with variables in its name, it
922 must be manually expanded before use. For example, the commonly used template
923 `{project}-csit-verify-1node-{functionality}` might expand to
924 `ovsdb-csit-verify-1node-netvirt`.
928 jenkins-jobs --conf jenkins.ini test jjb/ ovsdb-csit-verify-1node-netvirt
930 Successful tests output the XML description of the Jenkins job described by
931 the specified JJB job name.
936 Once you've `configured your \`jenkins.ini\` <Configuration_>`_ and `verified your
937 JJB jobs <Testing Jobs_>`_ produce valid XML descriptions of Jenkins jobs you
938 can push them to the Jenkins sandbox.
942 When pushing with `jenkins-jobs`, a log message with the number
943 of jobs you're pushing will be issued, typically to stdout.
944 **If the number is greater than 1** (or the number of jobs you
945 passed to the command to push) then you are pushing too many
946 jobs and should **`ctrl+c` to cancel the upload**. Else you will
947 flood the system with jobs.
951 INFO:jenkins_jobs.builder:Number of jobs generated: 1
953 **Failing to provide the final `<job-name>` param will push all
958 # Don't push all jobs by omitting the final param! (ctrl+c to abort)
959 jenkins-jobs --conf jenkins.ini update jjb/ <job-name>
961 Alternatively, you can push a job to the Jenkins sandbox with a special comment in a
962 releng/builder gerrit patch. The job will be based off of the code your patch is
963 based upon. Meaning, if your patch is changing something related to the job you are
964 pushing, those changes will exist in the sandbox job. The format of the comment is::
966 jjb-deploy <job name>
970 Also note that wildcards can be used in <job name> which
971 will expand all jobs that exist for the pattern.
976 Once you have your Jenkins job configuration `pushed to the
977 Sandbox <Pushing Jobs_>`_ you can trigger it to run.
979 Find your newly-pushed job on the `Sandbox's web UI <jenkins-sandbox_>`_. Click
980 on its name to see the job's details.
982 Make sure you're `logged in <jenkins-sandbox-login_>`_ to the Sandbox.
984 Click "Build with Parameters" and then "Build".
986 Wait for your job to be scheduled and run. Click on the job number to see
987 details, including console output.
989 Make changes to your JJB configuration, re-test, re-push and re-run until
993 .. _example-jenkins.ini: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins.ini.example
994 .. _integration-test-wiki: https://wiki.opendaylight.org/view/Integration/Test
995 .. _jenkins-master: https://jenkins.opendaylight.org/releng
996 .. _jenkins-sandbox: https://jenkins.opendaylight.org/sandbox
997 .. _jenkins-sandbox-login: https://jenkins.opendaylight.org/sandbox/login
998 .. _jenkins.ini: http://docs.openstack.org/infra/jenkins-job-builder/execution.html#configuration-file
999 .. _jjb-autoupdate-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-autoupdate-project.py
1000 .. _jjb-docs: http://ci.openstack.org/jenkins-job-builder/
1001 .. _jjb-init-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-init-project.py
1002 .. _jjb-repo: https://github.com/openstack-infra/jenkins-job-builder
1003 .. _jjb-requirements.txt: https://github.com/openstack-infra/jenkins-job-builder/blob/master/requirements.txt
1004 .. _jjb-templates: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jjb
1005 .. _odl-jjb-requirements.txt: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/requirements.txt
1006 .. _odl-nexus: https://nexus.opendaylight.org
1007 .. _odl-sonar: https://sonar.opendaylight.org
1008 .. _python-virtualenv: https://virtualenv.readthedocs.org/en/latest/
1009 .. _python-virtualenvwrapper: https://virtualenvwrapper.readthedocs.org/en/latest/
1010 .. _releng-wiki: https://wiki.opendaylight.org/view/RelEng:Main
1011 .. _releng-builder-gerrit: https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder
1012 .. _releng-builder-repo: https://git.opendaylight.org/gerrit/gitweb?p=releng%2Fbuilder.git;a=summary
1013 .. _releng-global-jjb: https://gerrit.linuxfoundation.org/infra/#/q/project:releng/global-jjb
1014 .. _releng-builder-wiki: https://wiki.opendaylight.org/view/RelEng/Builder
1015 .. _streams-design-background: https://lists.opendaylight.org/pipermail/release/2015-July/003139.html
1016 .. _spinup-scripts: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jenkins-scripts
1017 .. _spinup-scripts-basic_settings.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/basic_settings.sh
1018 .. _spinup-scripts-controller.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/controller.sh