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>Playbook</b><br/>
264 releng/builder/packer/common-packer/provision/baseline.yaml</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>Playbook</b><br/> releng/builder/packer/provision/robot.yaml</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/> ubuntu1604-mininet-ovs-25-2c-2g</td>
296 <td><b>Minion Template names</b><br/> ubuntu1604-mininet-ovs-25-2c-2g</td>
297 <td><b>Packer Template</b><br/> releng/builder/packer/templates/mininet-ovs-2.5.json</td>
298 <td><b>Playbook</b><br/> releng/builder/packer/provision//mininet-ovs-2.5.yaml</td>
302 Basic Ubuntu 16.04 (Xenial) system with ovs 2.5 and mininet 2.2.1
307 <td><b>Jenkins Labels</b><br/> ubuntu1604-mininet-ovs-26-2c-2g</td>
308 <td><b>Minion Template names</b><br/> ubuntu1604-mininet-ovs-26-2c-2g</td>
309 <td><b>Packer Template</b><br/> releng/builder/packer/templates/mininet-ovs-2.6.json</td>
310 <td><b>Playbook</b><br/> releng/builder/packer/provision//mininet-ovs-2.6.yaml</td>
314 Ubuntu 16.04 (Xenial) system with ovs 2.6 and mininet 2.2.1
319 <td><b>Jenkins Labels</b><br/> ubuntu1604-mininet-ovs-28-2c-2g</td>
320 <td><b>Minion Template names</b><br/> ubuntu1604-mininet-ovs-28-2c-2g</td>
321 <td><b>Packer Template</b><br/> releng/builder/packer/templates/mininet-ovs-2.8.json</td>
322 <td><b>Playbook</b><br/> releng/builder/packer/provision//mininet-ovs-2.8.yaml</td>
326 Ubuntu 16.04 (Xenial) system with ovs 2.8 and mininet 2.2.1
331 <td><b>Jenkins Labels</b><br/> centos7-devstack-2c-4g</td>
332 <td><b>Minion Template names</b><br/> centos7-devstack-2c-4g</td>
333 <td><b>Packer Template</b><br/> releng/builder/packer/templates/devstack.json</td>
334 <td><b>Playbook</b><br/> releng/builder/packer/provision/devstack.yaml</td>
338 CentOS 7 system purpose built for doing OpenStack testing using
339 DevStack. This minion is primarily targeted at the needs of the OVSDB
340 project. It has OpenJDK 1.7 (aka Java7) and OpenJDK 1.8 (Java8) and
341 other basic DevStack related bits installed.
346 <td><b>Jenkins Labels</b><br/> centos7-docker-2c-4g</td>
347 <td><b>Minion Template names</b><br/> centos7-docker-2c-4g</td>
348 <td><b>Packer Template</b><br/> releng/builder/packer/templates/docker.json</td>
349 <td><b>Playbook</b><br/> releng/builder/packer/common-packer/provision/docker.yaml</td>
353 CentOS 7 system configured with OpenJDK 1.7 (aka Java7),
354 OpenJDK 1.8 (Java8) and Docker. This system was originally custom
355 built for the test needs of the OVSDB project but other projects have
356 expressed interest in using it.
361 <td><b>Jenkins Labels</b><br/> ubuntu1604-gbp-2c-2g</td>
362 <td><b>Minion Template names</b><br/> ubuntu1604-gbp-2c-2g</td>
363 <td><b>Packer Template</b><br/> releng/builder/packer/templates/gbp.json</td>
364 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/gpb.sh</td>
368 Ubuntu 16.04 (Xenial) node with latest OVS and docker installed. Used by Group Based Policy.
374 Pool: ODLVEX - HOT (Heat Orchestration Templates)
375 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
377 HOT integration enables to spin up integration labs servers for CSIT jobs
378 using heat, rathar than using jclouds (deprecated). Image names are updated
379 on the project specific job templates using the variable
380 `{odl,docker,openstack,tools}_system_image` followed by image name in the
381 format `<platform> - <template> - <date-stamp>`.
383 .. include:: cloud-images.rst
385 Creating Jenkins Jobs
386 ---------------------
388 Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format
389 and uses them to configure Jenkins.
391 * `Jenkins Job Builder (JJB) documentation <jjb-docs_>`_
392 * `RelEng/Builder Gerrit <releng-builder-gerrit_>`_
393 * `RelEng/Builder Git repository <releng-builder-repo_>`_
395 Getting Jenkins Job Builder
396 ---------------------------
398 OpenDaylight uses Jenkins Job Builder to translate our in-repo YAML job
399 configuration into job descriptions suitable for consumption by Jenkins.
400 When testing new Jenkins Jobs in the `Jenkins Sandbox`_, you'll
401 need to use the `jenkins-jobs` executable to translate a set of jobs into
402 their XML descriptions and upload them to the sandbox Jenkins server.
404 We document `installing <Installing Jenkins Job Builder_>`_ `jenkins-jobs`
407 Installing Jenkins Job Builder
408 ------------------------------
410 We recommend using `pip <Installing JJB using pip_>`_ to assist with JJB
412 also document `installing from a git repository manually
413 <Installing JJB Manually_>`_.
414 For both, we recommend using Python `Virtual Environments`_
415 to isolate JJB and its dependencies.
417 The `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file contains the currently
418 recommended JJB version. Because JJB is fairly unstable, it may be necessary
419 to debug things by installing different versions. This is documented for both
420 `pip-assisted <Installing JJB using pip_>`_ and `manual
421 <Installing JJB Manually_>`_ installs.
426 For both `pip-assisted <Installing JJB using pip_>`_ and `manual
427 <Installing JJB Manually_>`_ JJB
428 installs, we recommend using `Python Virtual Environments <python-virtualenv_>`_
429 to manage JJB and its
430 Python dependencies. The `python-virtualenvwrapper`_ tool can help you do so.
432 Documentation is available for installing `python-virtualenvwrapper`_. On Linux
433 systems with pip (typical), they amount to:
437 sudo pip install virtualenvwrapper
439 A virtual environment is simply a directory that you install Python programs
440 into and then append to the front of your path, causing those copies to be
441 found before any system-wide versions.
443 Create a new virtual environment for JJB.
447 # Virtaulenvwrapper uses this dir for virtual environments
449 /home/daniel/.virtualenvs
450 # Make a new virtual environment
452 # A new venv dir was created
453 (jjb)$ ls -rc $WORKON_HOME | tail -n 1
455 # The new venv was added to the front of this shell's path
457 /home/daniel/.virtualenvs/jjb/bin:<my normal path>
458 # Software installed to venv, like pip, is found before system-wide copies
459 (jjb)$ command -v pip
460 /home/daniel/.virtualenvs/jjb/bin/pip
462 With your virtual environment active, you should install JJB. Your install will
463 be isolated to that virtual environment's directory and only visible when the
464 virtual environment is active.
466 You can easily leave and return to your venv. Make sure you activate it before
472 $ command -v jenkins-jobs
473 # No jenkins-jobs executable found
475 (jjb)$ command -v jenkins-jobs
476 $WORKON_HOME/jjb/bin/jenkins-jobs
478 Installing JJB using pip
479 ------------------------
481 The recommended way to install JJB is via pip.
483 First, clone the latest version of the `releng-builder-repo`_.
487 $ git clone --recursive https://git.opendaylight.org/gerrit/p/releng/builder.git
489 Before actually installing JJB and its dependencies, make sure you've `created
490 and activated <Virtual Environments_>`_ a virtual environment for JJB.
496 The recommended version of JJB to install is the version specified in the
497 `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file.
501 # From the root of the releng/builder repo
502 (jjb)$ pip install -r jjb/requirements.txt
504 To validate that JJB was successfully installed you can run this command:
508 (jjb)$ jenkins-jobs --version
510 TODO: Explain that only the currently merged jjb/requirements.txt is supported,
511 other options described below are for troubleshooting only.
513 To change the version of JJB specified by `builder/jjb/requirements.txt
514 <odl-jjb-requirements.txt_>`_
515 to install from the latest commit to the master branch of JJB's git repository:
519 $ cat jjb/requirements.txt
520 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder#egg=jenkins-job-builder
522 To install from a tag, like 1.4.0:
526 $ cat jjb/requirements.txt
527 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder@1.4.0#egg=jenkins-job-builder
529 Updating releng/builder repo or global-jjb
530 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
532 Follow these steps to update the releng/builder repo. The repo uses a submodule from
533 a global-jjb repo so that common source can be shared across different projects. This
534 requires updating the releng/builder repo periodically to pick up the changes. New
535 versions of jjb could also require updating the releng/builder repo. Follow the
536 previous steps earlier for updating jenkins-jobs using the
537 `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file. Ensure that the
538 version listed in the file is the currently supported version, otherwise install a
539 different version or simply upgrade using `pip install --upgrade jenkins-job-builder`.
541 The example below assumes the user has cloned releng/builder to `~/git/releng/builder`.
542 Update the repo, update the submodules and then submit a test to verify it works.
546 cd ~/git/releng/builder
549 git submodule update --init --recursive
550 jenkins-jobs --conf jenkins.ini test jjb/ netvirt-csit-1node-openstack-queens-upstream-stateful-fluorine
552 Installing JJB Manually
553 -----------------------
555 This section documents installing JJB from its manually cloned repository.
557 Note that `installing via pip <Installing JJB using pip_>`_ is typically simpler.
559 Checkout the version of JJB's source you'd like to build.
561 For example, using master:
565 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
567 Using a tag, like 1.4.0:
571 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
572 $ cd jenkins-job-builder
573 $ git checkout tags/1.4.0
575 Before actually installing JJB and its dependencies, make sure you've `created
576 and activated <Virtual Environments_>`_ a virtual environment for JJB.
582 You can then use JJB's `requirements.txt <jjb-requirements.txt_>`_ file to
584 dependencies. Note that we're not using `sudo` to install as root, since we want
585 to make use of the venv we've configured for our current user.
589 # In the cloned JJB repo, with the desired version of the code checked out
590 (jjb)$ pip install -r requirements.txt
592 Then install JJB from the repo with:
598 To validate that JJB was successfully installed you can run this command:
602 (jjb)$ jenkins-jobs --version
605 Jenkins Job Templates
606 ---------------------
608 The OpenDaylight `RelEng/Builder <releng-builder-wiki_>`_ project provides
609 `jjb-templates`_ that can be used to define basic jobs.
611 The *Gerrit Trigger* listed in the jobs are keywords that can be used to
612 trigger the job to run manually by simply leaving a comment in Gerrit for the
613 patch you wish to trigger against.
615 All jobs have a default build-timeout value of 360 minutes (6 hrs) but can be
616 overrided via the opendaylight-infra-wrappers' build-timeout property.
618 TODO: Group jobs into categories: every-patch, after-merge, on-demand, etc.
619 TODO: Reiterate that "remerge" triggers all every-patch jobs at once,
620 because when only a subset of jobs is triggered, Gerrit forgets valid -1 from jobs outside the subset.
621 TODO: Document that only drafts and commit-message-only edits do not trigger every-patch jobs.
622 TODO: Document test-{project}-{feature} and test-{project}-all.
626 <table class="table table-bordered">
628 <td><b>Job Template</b><br/>{project}-distribution-check-{stream}</td>
629 <td><b>Gerrit Trigger</b><br/>recheck</td>
633 This job runs the PROJECT-distribution-check-BRANCH job which is
634 building also integration/distribution project in order to run SingleFeatureTest.
635 It also performs various other checks in order to prevent the change to break autorelease.
640 <td><b>Job Template</b><br/>{project}-integration-{stream}</td>
645 The Integration Job Template creates a job which runs when a project that your
646 project depends on is successfully built. This job type is basically the same
647 as a verify job except that it triggers from other Jenkins jobs instead of via
648 Gerrit review updates. The dependencies that triger integration jobs are listed
649 in your project.cfg file under the <b>DEPENDENCIES</b> variable.
651 If no dependencies are listed then this job type is disabled by default.
656 <td><b>Job Template</b><br/>{project}-merge-{stream}</td>
657 <td><b>Gerrit Trigger</b><br/>remerge</td>
661 This job will trigger once a Gerrit patch is merged into the repo.
662 It will build HEAD of the current project branch and also run the Maven goals
663 <b>source:jar</b> and <b>javadoc:jar</b>.
664 Artifacts are uploaded to OpenDaylight's
665 <a href="https://nexus.opendaylight.org">Nexus</a> on completion.
667 A distribution-merge-{stream} job is triggered to add the new artifacts to the
668 integration distribution.
670 Running the "remerge" trigger is possible before a Change is merged,
671 it would still build the actual HEAD. This job does not alter Gerrit votes.
676 <td><b>Job Template</b><br/>{project}-sonar</td>
677 <td><b>Gerrit Trigger</b><br/>run-sonar</td>
681 This job runs Sonar analysis and reports the results to
682 OpenDaylight's <a href="https://sonar.opendaylight.org">Sonar</a>
685 The Sonar Job Template creates a job which will run against the
686 master branch, or if BRANCHES are specified in the CFG file it will
687 create a job for the <b>First</b> branch listed.
689 <div class="admonition note">
690 <p class="first admonition-title">Note</p>
692 Running the "run-sonar" trigger will cause Jenkins to remove
693 its existing vote if it's already -1'd or +1'd a comment. You
694 will need to re-run your verify job (recheck) after running
695 this to get Jenkins to re-vote.
702 <td><b>Job Template</b><br/>{project}-validate-autorelease-{stream}</td>
703 <td><b>Gerrit Trigger</b><br/>recheck</td>
707 This job runs the PROJECT-validate-autorelease-BRANCH job which is
708 used as a quick sanity test to ensure that a patch does not depend on
709 features that do not exist in the current release.
714 <td><b>Job Template</b><br/>{project}-verify-{stream}-{maven}-{jdks}</td>
715 <td><b>Gerrit Trigger</b><br/>recheck</td>
719 The Verify job template creates a Gerrit Trigger job that will
720 trigger when a new patch is submitted to Gerrit.
721 The job only builds the project code (including unit and integration tests).
726 <td><b>Job Template</b><br/>{project}-verify-node-{stream}</td>
727 <td><b>Gerrit Trigger</b><br/>recheck</td>
731 This job template can be used by a project that is NodeJS based. It
732 simply installs a python virtualenv and uses that to install nodeenv
733 which is then used to install another virtualenv for nodejs. It then
734 calls <b>npm install</b> and <b>npm test</b> to run the unit tests.
735 When using this template you need to provide a {nodedir} and
736 {nodever} containing the directory relative to the project root
737 containing the nodejs package.json and version of node you wish to
743 <td><b>Job Template</b><br/>{project}-verify-python-{stream} | {project}-verify-tox-{stream}</td>
744 <td><b>Gerrit Trigger</b><br/>recheck</td>
748 This job template can be used by a project that uses Tox to build. It
749 simply installs a Python virtualenv and uses tox to run the tests
750 defined in the project's tox.ini file. If the tox.ini is anywhere
751 other than the project's repo root, the path to its directory
752 relative to the project's repo root should be passed as {toxdir}.
754 The 2 template names verify-python & verify-tox are identical and are
755 aliases to each other. This allows the project to use the naming that
756 is most reasonable for them.
761 <td><b>Job Template</b><br/>integration-patch-test-{stream}</td>
762 <td><b>Gerrit Trigger</b><br/>test-integration</td>
766 This job builds a distribution against your Java patch and triggers distribution sanity CSIT jobs.
767 Leave a comment with trigger keyword above to activate it for a particular patch.
768 This job should not alter Gerrit votes for a given patch.
770 The list of CSIT jobs to trigger is defined in csit-list
771 <a href="https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/integration/integration-test-jobs.yaml">here</a>.
773 Some considerations when using this job:
776 The patch test verification takes some time (~2 hours) + consumes a lot of
777 resources so it is not meant to be used for every patch.
780 The system tests for master patches will fail most of the times because both
781 code and test are unstable during the release cycle (should be good by the
785 Because of the above, patch test results typically have to be interpreted by
786 system test experts. The <a href="https://wiki.opendaylight.org/view/Integration/Test">Integration/Test</a>
787 project can help with that.
793 <td><b>Job Template</b><br/>integration-multipatch-test-{stream}</td>
794 <td><b>Gerrit Trigger</b><br/>multipatch-build</td>
798 This job builds a list of patches provided in an specific order, and finally builds
799 a distribution from either provided patch or latest code in branch.
800 For example if someone leaves the following comment in a patch:
801 multipatch-build:controller=61/29761/5:45/29645/6,neutron=51/65551/4,netvirt:59/60259/17
802 the job will checkout controller patch 61/29761/5, cherry-pick 45/29645/6 and build controller,
803 checkout neutron patch 51/65551/4 and build neutron, checkout latest netvirt code,
804 cherry-pick 59/60259/17 and build netvirt, finally it will checkout latest distribution
805 code and build a distribution. The resulting distribution is stored in Nexus and the URL
806 is stored in a variable called BUNDLE_URL visible in the job console.
807 This job also accepts a gerrit topic, for example: multipatch-build:topic=binding-tlc-rpc,
808 in this case the job will find all patches in the topic binding-tlc-rpc for the projects
809 specified in the BUILD_ORDER parameter and will build all projects from the first a patch
810 has been found, for successive projects the branch HEAD is used if no patch is found.
811 The job uses patch numbers to sort patches in the same project.
812 Use multipatch-build-fast (vs multipatch-build) for building projects fast (-Pq).
813 This job should not alter Gerrit votes for a given patch, nor will do anything with the
814 given patch unless the patch is added to the build list.
823 We provide a properties which your job can take advantage of if you want to do
824 trigger a different configuration depending on job type. You can create a
825 profile that activates on a property listed below. The JJB templated jobs will
826 activate the profile during the build to run any custom code configuration you
827 wish to run for this job type.
831 -Dmerge : The Merge job sets this flag and is the same as setting the
832 Maven property <merge>true</merge>.
833 -Dsonar : The Sonar job sets this flag and is the same as setting the
834 Maven property <sonar>true</sonar>.
836 .. _odl-jenkins-sandbox:
841 URL: https://jenkins.opendaylight.org/sandbox
843 Jenkins Sandbox documentation is available in the
844 :doc:`LF Jenkins Sandbox Guide <lfdocs:jenkins-sandbox>`.
846 .. _example-jenkins.ini: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins.ini.example
847 .. _integration-test-wiki: https://wiki.opendaylight.org/view/Integration/Test
848 .. _jenkins-master: https://jenkins.opendaylight.org/releng
849 .. _jenkins.ini: http://docs.openstack.org/infra/jenkins-job-builder/execution.html#configuration-file
850 .. _jjb-autoupdate-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-autoupdate-project.py
851 .. _jjb-docs: http://ci.openstack.org/jenkins-job-builder/
852 .. _jjb-init-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-init-project.py
853 .. _jjb-repo: https://github.com/openstack-infra/jenkins-job-builder
854 .. _jjb-requirements.txt: https://github.com/openstack-infra/jenkins-job-builder/blob/master/requirements.txt
855 .. _jjb-templates: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jjb
856 .. _odl-jjb-requirements.txt: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/requirements.txt
857 .. _odl-nexus: https://nexus.opendaylight.org
858 .. _odl-sonar: https://sonar.opendaylight.org
859 .. _python-virtualenv: https://virtualenv.readthedocs.org/en/latest/
860 .. _python-virtualenvwrapper: https://virtualenvwrapper.readthedocs.org/en/latest/
861 .. _releng-wiki: https://wiki.opendaylight.org/view/RelEng:Main
862 .. _releng-builder-gerrit: https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder
863 .. _releng-builder-repo: https://git.opendaylight.org/gerrit/gitweb?p=releng%2Fbuilder.git;a=summary
864 .. _releng-global-jjb: https://gerrit.linuxfoundation.org/infra/#/q/project:releng/global-jjb
865 .. _releng-builder-wiki: https://wiki.opendaylight.org/view/RelEng/Builder
866 .. _streams-design-background: https://lists.opendaylight.org/pipermail/release/2015-July/003139.html
867 .. _spinup-scripts: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jenkins-scripts
868 .. _spinup-scripts-basic_settings.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/basic_settings.sh
869 .. _spinup-scripts-controller.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/controller.sh