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
256 <table class="table table-bordered">
258 <td><b>Jenkins Labels</b><br/>
259 centos7-builder-2c-1g,<br/>
260 centos7-builder-2c-2g,<br/>
261 centos7-builder-2c-8g,<br/>
262 centos7-builder-4c-4g,<br/>
263 centos7-builder-8c-8g,<br/>
264 centos7-autorelease-4c-16g
266 <td><b>Minion Template names</b><br/>
267 prd-centos7-builder-2c-1g,<br/>
268 prd-centos7-builder-2c-2g,<br/>
269 prd-centos7-builder-2c-8g,<br/>
270 prd-centos7-builder-4c-4g,<br/>
271 prd-centos7-builder-8c-8g,<br/>
272 prd-centos7-autorelease-4c-16g
273 <td><b>Packer Template</b><br/>
274 releng/builder/packer/templates/builder.json</td>
275 <td><b>Spinup Script</b><br/>
276 releng/builder/jenkins-scripts/builder.sh</td>
280 CentOS 7 build minion configured with OpenJDK 1.7 (Java7) and OpenJDK
281 1.8 (Java8) along with all the other components and libraries needed
282 for building any current OpenDaylight project. This is the label that
283 is used for all basic verify, merge and daily builds for
289 <td><b>Jenkins Labels</b><br/> centos7-robot-2c-2g</td>
290 <td><b>Minion Template names</b><br/> centos7-robot-2c-2g</td>
291 <td><b>Packer Template</b><br/>
292 releng/builder/packer/templates/robot.json</td>
293 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/robot.sh</td>
297 CentOS 7 minion configured with OpenJDK 1.7 (Java7), OpenJDK
298 1.8 (Java8) and all the current packages used by the integration
299 project for doing robot driven jobs. If you are executing robot
300 framework jobs then your job should be using this as the minion that
301 you are tied to. This image does not contain the needed libraries for
302 building components of OpenDaylight, only for executing robot tests.
307 <td><b>Jenkins Labels</b><br/> ubuntu1404-mininet-2c-2g</td>
308 <td><b>Minion Template names</b><br/> ubuntu1404-mininet-2c-2g</td>
309 <td><b>Packer Template</b><br/>
310 releng/builder/packer/teamplates/mininet.json</td>
311 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
315 Basic Ubuntu 14.04 (Trusty) system with ovs 2.0.2 and mininet 2.1.0
320 <td><b>Jenkins Labels</b><br/> ubuntu1404-mininet-ovs-23-2c-2g</td>
321 <td><b>Minion Template names</b><br/> ubuntu1404-mininet-ovs-23-2c-2g</td>
322 <td><b>Packer Template</b><br/> releng/builder/packer/templates/mininet-ovs-2.3.json</td>
323 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
327 Ubuntu 16.04 (Xenial) system with ovs 2.5 and mininet 2.2.1
332 <td><b>Jenkins Labels</b><br/> centos7-devstack-2c-4g</td>
333 <td><b>Minion Template names</b><br/> centos7-devstack-2c-4g</td>
334 <td><b>Packer Template</b><br/> releng/builder/packer/templates/devstack.json</td>
335 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/devstack.sh</td>
339 CentOS 7 system purpose built for doing OpenStack testing using
340 DevStack. This minion is primarily targeted at the needs of the OVSDB
341 project. It has OpenJDK 1.7 (aka Java7) and OpenJDK 1.8 (Java8) and
342 other basic DevStack related bits installed.
347 <td><b>Jenkins Labels</b><br/> centos7-docker-2c-4g</td>
348 <td><b>Minion Template names</b><br/> centos7-docker-2c-4g</td>
349 <td><b>Packer Template</b><br/> releng/builder/packer/templates/docker.json</td>
350 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/docker.sh</td>
354 CentOS 7 system configured with OpenJDK 1.7 (aka Java7),
355 OpenJDK 1.8 (Java8) and Docker. This system was originally custom
356 built for the test needs of the OVSDB project but other projects have
357 expressed interest in using it.
362 <td><b>Jenkins Labels</b><br/> ubuntu1404-gbp-2c-2g</td>
363 <td><b>Minion Template names</b><br/> ubuntu1404-gbp-2c-2g</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 14.04 (Trusty) node with latest OVS and docker installed. Used by Group Based Policy.
374 <td><b>Jenkins Labels</b><br/> ubuntu1604-gbp-2c-4g</td>
375 <td><b>Minion Template names</b><br/> ubuntu1604-gbp-2c-4g</td>
376 <td><b>Packer Template</b><br/> releng/builder/packer/templates/gbp.json</td>
377 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/ubuntu-docker-ovs.sh</td>
381 Ubuntu 16.04 (Xenial) node with latest OVS and docker installed. Used by Group Based Policy.
387 Pool: ODLVEX - HOT (Heat Orchestration Templates)
388 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
390 HOT integration enables to spin up integration labs servers for CSIT jobs
391 using heat, rathar than using jclouds (deprecated). Image names are updated
392 on the project specific job templates using the variable
393 `{odl,docker,openstack,tools}_system_image` followed by image name in the
394 format `<platform> - <template> - <date-stamp>`.
396 .. include:: cloud-images.rst
398 Creating Jenkins Jobs
399 ---------------------
401 Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format
402 and uses them to configure Jenkins.
404 * `Jenkins Job Builder (JJB) documentation <jjb-docs_>`_
405 * `RelEng/Builder Gerrit <releng-builder-gerrit_>`_
406 * `RelEng/Builder Git repository <releng-builder-repo_>`_
408 Getting Jenkins Job Builder
409 ---------------------------
411 OpenDaylight uses Jenkins Job Builder to translate our in-repo YAML job
412 configuration into job descriptions suitable for consumption by Jenkins.
413 When testing new Jenkins Jobs in the `Jenkins Sandbox`_, you'll
414 need to use the `jenkins-jobs` executable to translate a set of jobs into
415 their XML descriptions and upload them to the sandbox Jenkins server.
417 We document `installing <Installing Jenkins Job Builder_>`_ `jenkins-jobs`
420 Installing Jenkins Job Builder
421 ------------------------------
423 We recommend using `pip <Installing JJB using pip_>`_ to assist with JJB
425 also document `installing from a git repository manually
426 <Installing JJB Manually_>`_.
427 For both, we recommend using Python `Virtual Environments`_
428 to isolate JJB and its dependencies.
430 The `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file contains the currently
431 recommended JJB version. Because JJB is fairly unstable, it may be necessary
432 to debug things by installing different versions. This is documented for both
433 `pip-assisted <Installing JJB using pip_>`_ and `manual
434 <Installing JJB Manually_>`_ installs.
439 For both `pip-assisted <Installing JJB using pip_>`_ and `manual
440 <Installing JJB Manually_>`_ JJB
441 installs, we recommend using `Python Virtual Environments <python-virtualenv_>`_
442 to manage JJB and its
443 Python dependencies. The `python-virtualenvwrapper`_ tool can help you do so.
445 Documentation is available for installing `python-virtualenvwrapper`_. On Linux
446 systems with pip (typical), they amount to:
450 sudo pip install virtualenvwrapper
452 A virtual environment is simply a directory that you install Python programs
453 into and then append to the front of your path, causing those copies to be
454 found before any system-wide versions.
456 Create a new virtual environment for JJB.
460 # Virtaulenvwrapper uses this dir for virtual environments
462 /home/daniel/.virtualenvs
463 # Make a new virtual environment
465 # A new venv dir was created
466 (jjb)$ ls -rc $WORKON_HOME | tail -n 1
468 # The new venv was added to the front of this shell's path
470 /home/daniel/.virtualenvs/jjb/bin:<my normal path>
471 # Software installed to venv, like pip, is found before system-wide copies
472 (jjb)$ command -v pip
473 /home/daniel/.virtualenvs/jjb/bin/pip
475 With your virtual environment active, you should install JJB. Your install will
476 be isolated to that virtual environment's directory and only visible when the
477 virtual environment is active.
479 You can easily leave and return to your venv. Make sure you activate it before
485 $ command -v jenkins-jobs
486 # No jenkins-jobs executable found
488 (jjb)$ command -v jenkins-jobs
489 $WORKON_HOME/jjb/bin/jenkins-jobs
491 Installing JJB using pip
492 ------------------------
494 The recommended way to install JJB is via pip.
496 First, clone the latest version of the `releng-builder-repo`_.
500 $ git clone --recursive https://git.opendaylight.org/gerrit/p/releng/builder.git
502 Before actually installing JJB and its dependencies, make sure you've `created
503 and activated <Virtual Environments_>`_ a virtual environment for JJB.
509 The recommended version of JJB to install is the version specified in the
510 `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file.
514 # From the root of the releng/builder repo
515 (jjb)$ pip install -r jjb/requirements.txt
517 To validate that JJB was successfully installed you can run this command:
521 (jjb)$ jenkins-jobs --version
523 TODO: Explain that only the currently merged jjb/requirements.txt is supported,
524 other options described below are for troubleshooting only.
526 To change the version of JJB specified by `builder/jjb/requirements.txt
527 <odl-jjb-requirements.txt_>`_
528 to install from the latest commit to the master branch of JJB's git repository:
532 $ cat jjb/requirements.txt
533 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder#egg=jenkins-job-builder
535 To install from a tag, like 1.4.0:
539 $ cat jjb/requirements.txt
540 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder@1.4.0#egg=jenkins-job-builder
542 Installing JJB Manually
543 -----------------------
545 This section documents installing JJB from its manually cloned repository.
547 Note that `installing via pip <Installing JJB using pip_>`_ is typically simpler.
549 Checkout the version of JJB's source you'd like to build.
551 For example, using master:
555 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
557 Using a tag, like 1.4.0:
561 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
562 $ cd jenkins-job-builder
563 $ git checkout tags/1.4.0
565 Before actually installing JJB and its dependencies, make sure you've `created
566 and activated <Virtual Environments_>`_ a virtual environment for JJB.
572 You can then use JJB's `requirements.txt <jjb-requirements.txt_>`_ file to
574 dependencies. Note that we're not using `sudo` to install as root, since we want
575 to make use of the venv we've configured for our current user.
579 # In the cloned JJB repo, with the desired version of the code checked out
580 (jjb)$ pip install -r requirements.txt
582 Then install JJB from the repo with:
588 To validate that JJB was successfully installed you can run this command:
592 (jjb)$ jenkins-jobs --version
595 Jenkins Job Templates
596 ---------------------
598 The OpenDaylight `RelEng/Builder <releng-builder-wiki_>`_ project provides
599 `jjb-templates`_ that can be used to define basic jobs.
601 The *Gerrit Trigger* listed in the jobs are keywords that can be used to
602 trigger the job to run manually by simply leaving a comment in Gerrit for the
603 patch you wish to trigger against.
605 All jobs have a default build-timeout value of 360 minutes (6 hrs) but can be
606 overrided via the opendaylight-infra-wrappers' build-timeout property.
608 TODO: Group jobs into categories: every-patch, after-merge, on-demand, etc.
609 TODO: Reiterate that "remerge" triggers all every-patch jobs at once,
610 because when only a subset of jobs is triggered, Gerrit forgets valid -1 from jobs outside the subset.
611 TODO: Document that only drafts and commit-message-only edits do not trigger every-patch jobs.
612 TODO: Document test-{project}-{feature} and test-{project}-all.
616 <table class="table table-bordered">
618 <td><b>Job Template</b><br/>{project}-distribution-check-{stream}</td>
619 <td><b>Gerrit Trigger</b><br/>recheck</td>
623 This job runs the PROJECT-distribution-check-BRANCH job which is
624 building also integration/distribution project in order to run SingleFeatureTest.
625 It also performs various other checks in order to prevent the change to break autorelease.
630 <td><b>Job Template</b><br/>{project}-integration-{stream}</td>
635 The Integration Job Template creates a job which runs when a project that your
636 project depends on is successfully built. This job type is basically the same
637 as a verify job except that it triggers from other Jenkins jobs instead of via
638 Gerrit review updates. The dependencies that triger integration jobs are listed
639 in your project.cfg file under the <b>DEPENDENCIES</b> variable.
641 If no dependencies are listed then this job type is disabled by default.
646 <td><b>Job Template</b><br/>{project}-merge-{stream}</td>
647 <td><b>Gerrit Trigger</b><br/>remerge</td>
651 This job will trigger once a Gerrit patch is merged into the repo.
652 It will build HEAD of the current project branch and also run the Maven goals
653 <b>source:jar</b> and <b>javadoc:jar</b>.
654 Artifacts are uploaded to OpenDaylight's
655 <a href="https://nexus.opendaylight.org">Nexus</a> on completion.
657 A distribution-merge-{stream} job is triggered to add the new artifacts to the
658 integration distribution.
660 Running the "remerge" trigger is possible before a Change is merged,
661 it would still build the actual HEAD. This job does not alter Gerrit votes.
666 <td><b>Job Template</b><br/>{project}-sonar</td>
667 <td><b>Gerrit Trigger</b><br/>run-sonar</td>
671 This job runs Sonar analysis and reports the results to
672 OpenDaylight's <a href="https://sonar.opendaylight.org">Sonar</a>
675 The Sonar Job Template creates a job which will run against the
676 master branch, or if BRANCHES are specified in the CFG file it will
677 create a job for the <b>First</b> branch listed.
679 <div class="admonition note">
680 <p class="first admonition-title">Note</p>
682 Running the "run-sonar" trigger will cause Jenkins to remove
683 its existing vote if it's already -1'd or +1'd a comment. You
684 will need to re-run your verify job (recheck) after running
685 this to get Jenkins to re-vote.
692 <td><b>Job Template</b><br/>{project}-validate-autorelease-{stream}</td>
693 <td><b>Gerrit Trigger</b><br/>recheck</td>
697 This job runs the PROJECT-validate-autorelease-BRANCH job which is
698 used as a quick sanity test to ensure that a patch does not depend on
699 features that do not exist in the current release.
704 <td><b>Job Template</b><br/>{project}-verify-{stream}-{maven}-{jdks}</td>
705 <td><b>Gerrit Trigger</b><br/>recheck</td>
709 The Verify job template creates a Gerrit Trigger job that will
710 trigger when a new patch is submitted to Gerrit.
711 The job only builds the project code (including unit and integration tests).
716 <td><b>Job Template</b><br/>{project}-verify-node-{stream}</td>
717 <td><b>Gerrit Trigger</b><br/>recheck</td>
721 This job template can be used by a project that is NodeJS based. It
722 simply installs a python virtualenv and uses that to install nodeenv
723 which is then used to install another virtualenv for nodejs. It then
724 calls <b>npm install</b> and <b>npm test</b> to run the unit tests.
725 When using this template you need to provide a {nodedir} and
726 {nodever} containing the directory relative to the project root
727 containing the nodejs package.json and version of node you wish to
733 <td><b>Job Template</b><br/>{project}-verify-python-{stream} | {project}-verify-tox-{stream}</td>
734 <td><b>Gerrit Trigger</b><br/>recheck</td>
738 This job template can be used by a project that uses Tox to build. It
739 simply installs a Python virtualenv and uses tox to run the tests
740 defined in the project's tox.ini file. If the tox.ini is anywhere
741 other than the project's repo root, the path to its directory
742 relative to the project's repo root should be passed as {toxdir}.
744 The 2 template names verify-python & verify-tox are identical and are
745 aliases to each other. This allows the project to use the naming that
746 is most reasonable for them.
751 <td><b>Job Template</b><br/>integration-patch-test-{stream}</td>
752 <td><b>Gerrit Trigger</b><br/>test-integration</td>
756 This job builds a distribution against your Java patch and triggers distribution sanity CSIT jobs.
757 Leave a comment with trigger keyword above to activate it for a particular patch.
758 This job should not alter Gerrit votes for a given patch.
760 The list of CSIT jobs to trigger is defined in csit-list
761 <a href="https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/integration/integration-test-jobs.yaml">here</a>.
763 Some considerations when using this job:
766 The patch test verification takes some time (~2 hours) + consumes a lot of
767 resources so it is not meant to be used for every patch.
770 The system tests for master patches will fail most of the times because both
771 code and test are unstable during the release cycle (should be good by the
775 Because of the above, patch test results typically have to be interpreted by
776 system test experts. The <a href="https://wiki.opendaylight.org/view/Integration/Test">Integration/Test</a>
777 project can help with that.
783 <td><b>Job Template</b><br/>integration-multipatch-test-{stream}</td>
784 <td><b>Gerrit Trigger</b><br/>multipatch-build</td>
788 This job builds a list of patches provided in an specific order, and finally builds
789 a distribution from either provided patch or latest code in branch.
790 For example if someone leaves the following comment in a patch:
791 multipatch-build:controller=61/29761/5:45/29645/6,neutron=51/65551/4,netvirt:59/60259/17
792 the job will checkout controller patch 61/29761/5, cherry-pick 45/29645/6 and build controller,
793 checkout neutron patch 51/65551/4 and build neutron, checkout latest netvirt code,
794 cherry-pick 59/60259/17 and build netvirt, finally it will checkout latest distribution
795 code and build a distribution. The resulting distribution is stored in Nexus and the URL
796 is stored in a variable called BUNDLE_URL visible in the job console.
797 This job should not alter Gerrit votes for a given patch, nor will do anything with the
798 given patch unless the patch is added to the build list.
807 We provide a properties which your job can take advantage of if you want to do
808 something different depending on the job type that is run. If you create a
809 profile that activates on a property listed blow. The JJB templated jobs will
810 be able to activate the profile during the build to run any custom code you
811 wish to run in your project.
815 -Dmerge : This flag is passed in our Merge job and is equivalent to the
818 -Dsonar : This flag is passed in our Sonar job and is equivalent to the
822 .. _odl-jenkins-sandbox:
827 The `jenkins-sandbox`_ instance's purpose is to allow projects to test their JJB
828 setups before merging their code over to the RelEng master silo. It is
829 configured similarly to the master instance, although it cannot publish
830 artifacts or vote in Gerrit.
832 If your project requires access to the sandbox please open an OpenDaylight
833 Helpdesk ticket (<helpdesk@opendaylight.org>) and provide your ODL ID.
835 Notes Regarding the Sandbox
836 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
838 * Jobs are automatically deleted every Saturday at 08:00 UTC
839 * Committers can login and configure Jenkins jobs in the sandbox directly
840 (unlike with the master silo)
841 * Sandbox configuration mirrors the master silo when possible
842 * Sandbox jobs can NOT upload artifacts to Nexus
843 * Sandbox jobs can NOT vote on Gerrit
848 Make sure you have Jenkins Job Builder [properly installed](#jjb_install).
850 If you do not already have access, open an OpenDaylight Helpdesk ticket
851 (<helpdesk@opendaylight.org>) to request access to ODL's sandbox instance.
852 Integration/Test (`integration-test-wiki`_) committers have access by default.
854 JJB reads user-specific configuration from a `jenkins.ini`_. An
855 example is provided by releng/builder at `example-jenkins.ini`_.
859 # If you don't have RelEng/Builder's repo, clone it
860 $ git clone --recursive https://git.opendaylight.org/gerrit/p/releng/builder.git
861 # Make a copy of the example JJB config file (in the builder/ directory)
862 $ cp jenkins.ini.example jenkins.ini
863 # Edit jenkins.ini with your username, API token and ODL's sandbox URL
867 user=<your ODL username>
868 password=<your ODL Jenkins sandbox API token>
869 url=https://jenkins.opendaylight.org/sandbox
872 To get your API token, `login to the Jenkins **sandbox** instance
873 <jenkins-sandbox-login_>`_ (*not
874 the main master Jenkins instance, different tokens*), go to your user page (by
875 clicking on your username, for example), click "Configure" and then "Show API
881 If you `installed JJB locally into a virtual environment
882 <Installing Jenkins Job Builder_>`_,
883 you should now activate that virtual environment to access the `jenkins-jobs`
891 You'll want to work from the root of the RelEng/Builder repo, and you should
892 have your `jenkins.ini` file [properly configured](#sandbox_config).
897 It's good practice to use the `test` command to validate your JJB files before
902 jenkins-jobs --conf jenkins.ini test jjb/ <job-name>
904 If the job you'd like to test is a template with variables in its name, it
905 must be manually expanded before use. For example, the commonly used template
906 `{project}-csit-verify-1node-{functionality}` might expand to
907 `ovsdb-csit-verify-1node-netvirt`.
911 jenkins-jobs --conf jenkins.ini test jjb/ ovsdb-csit-verify-1node-netvirt
913 Successful tests output the XML description of the Jenkins job described by
914 the specified JJB job name.
919 Once you've `configured your \`jenkins.ini\` <Configuration_>`_ and `verified your
920 JJB jobs <Testing Jobs_>`_ produce valid XML descriptions of Jenkins jobs you
921 can push them to the Jenkins sandbox.
925 When pushing with `jenkins-jobs`, a log message with the number
926 of jobs you're pushing will be issued, typically to stdout.
927 **If the number is greater than 1** (or the number of jobs you
928 passed to the command to push) then you are pushing too many
929 jobs and should **`ctrl+c` to cancel the upload**. Else you will
930 flood the system with jobs.
934 INFO:jenkins_jobs.builder:Number of jobs generated: 1
936 **Failing to provide the final `<job-name>` param will push all
941 # Don't push all jobs by omitting the final param! (ctrl+c to abort)
942 jenkins-jobs --conf jenkins.ini update jjb/ <job-name>
944 Alternatively, you can push a job to the Jenkins sandbox with a special comment in a
945 releng/builder gerrit patch. The job will be based off of the code your patch is
946 based upon. Meaning, if your patch is changing something related to the job you are
947 pushing, those changes will exist in the sandbox job. The format of the comment is::
949 jjb-deploy <job name>
953 Also note that wildcards can be used in <job name> which
954 will expand all jobs that exist for the pattern.
959 Once you have your Jenkins job configuration `pushed to the
960 Sandbox <Pushing Jobs_>`_ you can trigger it to run.
962 Find your newly-pushed job on the `Sandbox's web UI <jenkins-sandbox_>`_. Click
963 on its name to see the job's details.
965 Make sure you're `logged in <jenkins-sandbox-login_>`_ to the Sandbox.
967 Click "Build with Parameters" and then "Build".
969 Wait for your job to be scheduled and run. Click on the job number to see
970 details, including console output.
972 Make changes to your JJB configuration, re-test, re-push and re-run until
976 .. _example-jenkins.ini: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins.ini.example
977 .. _integration-test-wiki: https://wiki.opendaylight.org/view/Integration/Test
978 .. _jenkins-master: https://jenkins.opendaylight.org/releng
979 .. _jenkins-sandbox: https://jenkins.opendaylight.org/sandbox
980 .. _jenkins-sandbox-login: https://jenkins.opendaylight.org/sandbox/login
981 .. _jenkins.ini: http://docs.openstack.org/infra/jenkins-job-builder/execution.html#configuration-file
982 .. _jjb-autoupdate-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-autoupdate-project.py
983 .. _jjb-docs: http://ci.openstack.org/jenkins-job-builder/
984 .. _jjb-init-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-init-project.py
985 .. _jjb-repo: https://github.com/openstack-infra/jenkins-job-builder
986 .. _jjb-requirements.txt: https://github.com/openstack-infra/jenkins-job-builder/blob/master/requirements.txt
987 .. _jjb-templates: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jjb
988 .. _odl-jjb-requirements.txt: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/requirements.txt
989 .. _odl-nexus: https://nexus.opendaylight.org
990 .. _odl-sonar: https://sonar.opendaylight.org
991 .. _python-virtualenv: https://virtualenv.readthedocs.org/en/latest/
992 .. _python-virtualenvwrapper: https://virtualenvwrapper.readthedocs.org/en/latest/
993 .. _releng-wiki: https://wiki.opendaylight.org/view/RelEng:Main
994 .. _releng-builder-gerrit: https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder
995 .. _releng-builder-repo: https://git.opendaylight.org/gerrit/gitweb?p=releng%2Fbuilder.git;a=summary
996 .. _releng-global-jjb: https://gerrit.linuxfoundation.org/infra/#/q/project:releng/global-jjb
997 .. _releng-builder-wiki: https://wiki.opendaylight.org/view/RelEng/Builder
998 .. _streams-design-background: https://lists.opendaylight.org/pipermail/release/2015-July/003139.html
999 .. _spinup-scripts: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jenkins-scripts
1000 .. _spinup-scripts-basic_settings.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/basic_settings.sh
1001 .. _spinup-scripts-controller.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/controller.sh