1 The [Release Engineering project][0] consolidates the Jenkins jobs from
2 project-specific VMs to a single Jenkins server. Each OpenDaylight project
3 has a tab for their jobs on the [RelEng Jenkins server][3]. The system utilizes
4 [Jenkins Job Builder][11] \(JJB\) for the creation and management of the
9 * [Jenkins Master](#jenkins_master)
10 * [Build Slaves](#build_slaves)
11 * [Creating Jenkins Jobs](#creating_jenkins_jobs)
12 * [Getting Jenkins Job Builder](#jjb)
13 * [Installing Jenkins Job Builder](#jjb_install)
14 * [Virtual Environments](#jjb_install_venv)
15 * [Installing JJB using pip](#jjb_install_pip)
16 * [Installing JJB Manually](#jjb_install_manual)
17 * [Jenkins Job Builder Docker Image](#jjb_install_docker)
18 * [Jenkins Job Templates](#jjb_templates)
19 * [Jenkins Job Basic Configuration](#jjb_basic_configuration)
20 * [Jenkins Job Maven Properties](#jjb_maven_properties)
21 * [Jenkins Sandbox](#jenkins_sandbox)
22 * [Configuration](#sandbox_config)
23 * [Manual Method](#jjb_use_manual)
24 * [Docker Method](#jjb_use_docker)
26 # <a name="jenkins_master">Jenkins Master</a>
28 The [Jenkins master server][3] is the home for all project's Jenkins jobs. All
29 maintenance and configuration of these jobs must be done via JJB through the
30 [RelEng repo][4]. Project contributors can no longer edit the Jenkins jobs
31 directly on the server.
33 # <a name="build_slaves">Build Slaves</a>
35 The Jenkins jobs are run on build slaves (executors) which are created on an
36 as-needed basis. If no idle build slaves are available a new VM is brought
37 up. This process can take up to 2 minutes. Once the build slave has finished a
38 job, it will remain online for 45 minutes before shutting down. Subsequent
39 jobs will use an idle build slave if available.
41 Our Jenkins master supports many types of dynamic build slaves. If you are
42 creating custom jobs then you will need to have an idea of what type of slaves
43 are available. The following are the current slave types and descriptions.
44 Slave Template Names are needed for jobs that take advantage of multiple
45 slaves as they must be specifically called out by template name instead of
48 ## Adding New Components to the Slaves
50 If your project needs something added to one of the slaves used during build
51 and test you can help us get things added faster by doing one of the following:
53 * Submit a patch to RelEng/Builder for the [Jenkins spinup script][5] that
54 configures your new piece of software.
55 * Submit a patch to RelEng/Builder for the [Vagrant template's bootstrap.sh][6]
56 that configures your new piece of software.
58 Going the first route will be faster in the short term as we can inspect the
59 changes and make test modifications in the sandbox to verify that it works.
61 The second route, however, is better for the community as a whole as it will
62 allow others that utilize our Vagrant setups to replicate our systems more
63 closely. It is, however, more time consuming as an image snapshot needs to be
64 created based on the updated Vagrant definition before it can be attached to
65 the sandbox for validation testing.
67 In either case, the changes must be validated in the sandbox with tests to
68 make sure that we don't break current jobs and that the new software features
69 are operating as intended. Once this is done the changes will be merged and
70 the updates applied to the RelEng Jenkins production silo.
72 Please note that the combination of a Vagrant slave snapshot and a Jenkins
73 spinup script is what defines a given slave. For instance, a slave may be
74 defined by the [`releng/builder/vagrant/basic-java-node/`][8] Vagrant definition
75 and the [`releng/builder/jenkins-script/controller.sh`][9] Jenkins spinup script
76 (as the dynamic\_controller slave is). The pair provides the full definition of
77 the realized slave. Jenkins starts a slave using the last-spun Vagrant snapshot
78 for the specified definition. Once the base Vagrant instance is online Jenkins
79 checks out the RelEng/Builder repo on it and executes two scripts. The first is
80 [`basic_settings.sh`][10], which is a baseline for all of the slaves. The second is
81 the specialized spinup script, which handles any system updates, new software
82 installs or extra environment tweaks that don't make sense in a snapshot. After
83 all of these scripts have executed Jenkins will finally attach the slave as an
84 actual slave and start handling jobs on it.
86 ### Pool: Rackspace - Docker
88 <table class="table table-bordered">
90 <td><b>Jenkins Label</b><br/> dynamic_docker</td>
91 <td><b>Slave Template name</b><br/> rk-f20-docker</td>
92 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ovsdb-docker</td>
93 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/docker.sh</td>
97 A Fedora 20 system that is configured with OpenJDK 1.7 (aka Java7) and
98 Docker. This system was originally custom built for the test needs of
99 the OVSDB project but other projects have expressed interest in using
105 ### Pool: Rackspace DFW
107 <table class="table table-bordered">
109 <td><b>Jenkins Label</b><br/> dynamic_verify</td>
110 <td><b>Slave Template name</b><br/> rk-c-el65-build</td>
111 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-builder</td>
112 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/builder.sh</td>
116 A CentOS 6 build slave. This system has OpenJDK 1.7 (Java7) and OpenJDK
117 1.8 (Java8) installed on it along with all the other components and
118 libraries needed for building any current OpenDaylight project. This is
119 the label that is used for all basic -verify and -daily- builds for
125 <table class="table table-bordered">
127 <td><b>Jenkins Label</b><br/> dynamic_merge</td>
128 <td><b>Slave Template name</b><br/> rk-c-el65-build</td>
129 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-builder</td>
130 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/builder.sh</td>
134 See dynamic_verify (same image on the back side). This is the label that
135 is used for all basic -merge and -integration- builds for projects.
140 ### Pool: Rackspace DFW - Devstack
142 <table class="table table-bordered">
144 <td><b>Jenkins Label</b><br/> dynamic_devstack</td>
145 <td><b>Slave Template name</b><br/> rk-c7-devstack</td>
146 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ovsdb-devstack</td>
147 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/devstack.sh</td>
151 A CentOS 7 system purpose built for doing OpenStack testing using
152 DevStack. This slave is primarily targeted at the needs of the OVSDB
153 project. It has OpenJDK 1.7 (aka Java7) and other basic DevStack related
159 ### Pool: Rackspace DFW - Integration
161 <table class="table table-bordered">
163 <td><b>Jenkins Label</b><br/> dynamic_robot</td>
164 <td><b>Slave Template name</b><br/> rk-c-el6-robot</td>
165 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/integration-robotframework</td>
166 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/robot.sh</td>
170 A CentOS 6 slave that is configured with OpenJDK 1.7 (Java7) and all the
171 current packages used by the integration project for doing robot driven
172 jobs. If you are executing robot framework jobs then your job should be
173 using this as the slave that you are tied to. This image does not
174 contain the needed libraries for building components of OpenDaylight,
175 only for executing robot tests.
180 ### Pool: Rackspace DFW - Integration Dynamic Lab
182 <table class="table table-bordered">
184 <td><b>Jenkins Label</b><br/> dynamic_controller</td>
185 <td><b>Slave Template name</b><br/> rk-c-el6-java</td>
186 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-java-node</td>
187 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/controller.sh</td>
191 A CentOS 6 slave that has the basic OpenJDK 1.7 (Java7) installed and is
192 capable of running the controller, not building.
197 <table class="table table-bordered">
199 <td><b>Jenkins Label</b><br/> dynamic_java</td>
200 <td><b>Slave Template name</b><br/> rk-c-el6-java</td>
201 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-java-node</td>
202 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/controller.sh</td>
206 See dynamic_controller as it is currently the same image.
211 <table class="table table-bordered">
213 <td><b>Jenkins Label</b><br/> dynamic_mininet</td>
214 <td><b>Slave Template name</b><br/> rk-c-el6-mininet</td>
215 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-mininet-node</td>
216 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet.sh</td>
220 A CentOS 6 image that has mininet, openvswitch v2.0.x, netopeer and
221 PostgreSQL 9.3 installed. This system is targeted at playing the role of
222 a mininet system for integration tests. Netopeer is installed as it is
223 needed for various tests by Integration. PostgreSQL 9.3 is installed as
224 the system is also capable of being used as a VTN project controller and
225 VTN requires PostgreSQL 9.3.
230 <table class="table table-bordered">
232 <td><b>Jenkins Label</b><br/> dynamic_mininet_fedora</td>
233 <td><b>Slave Template name</b><br/> rk-f21-mininet</td>
234 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-mininet-fedora-node</td>
235 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-fedora.sh</td>
239 Basic Fedora 21 system with ovs v2.3.x and mininet 2.2.1
244 <table class="table table-bordered">
246 <td><b>Jenkins Label</b><br/> ubuntu_mininet</td>
247 <td><b>Slave Template name</b><br/> ubuntu-trusty-mininet</td>
248 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ubuntu-mininet</td>
249 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
253 Basic Ubuntu system with ovs 2.0.2 and mininet 2.1.0
258 <table class="table table-bordered">
260 <td><b>Jenkins Label</b><br/> ubuntu_mininet_ovs_23</td>
261 <td><b>Slave Template name</b><br/> ubuntu-trusty-mininet-ovs-23</td>
262 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ubuntu-mininet-ovs-23</td>
263 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
267 Basic Ubuntu system with ovs 2.3 and mininet 2.2.1
272 ### Pool: Rackspace DFW - Matrix
274 <table class="table table-bordered">
276 <td><b>Jenkins Label</b><br/> matrix_master</td>
277 <td><b>Slave Template name</b><br/> rk-c-el6-matrix</td>
278 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-java-node</td>
279 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/matrix.sh</td>
283 This is a very minimal system that is designed to spin up with 2 build
284 instances on it. The purpose is to have a location that is not the
285 Jenkins master itself for jobs that are executing matrix operations
286 since they need a director location. This image should not be used for
287 anything but tying matrix jobs before the matrx defined label ties.
292 # <a name="creating_jenkins_jobs">Creating Jenkins Jobs</a>
294 Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format
295 and uses them to configure Jenkins.
297 * [Jenkins Job Builder][11] \(JJB\) documentation
298 * [RelEng/Builder Gerrit][12]
299 * [RelEng/Builder Git repository][13]
301 ## <a name="jjb">Getting Jenkins Job Builder</a>
303 OpenDaylight uses Jenkins Job Builder to translate our in-repo YAML job
304 configuration into job descriptions suitable for consumption by Jenkins.
305 When testing new Jenkins Jobs in the [sandbox](#jenkins_sandbox), you'll
306 need to use the `jenkins-jobs` executable to translate a set of jobs into
307 their XML descriptions and upload them to the sandbox Jenkins server.
309 We document [installing](#jjb_install) `jenkins-jobs` below. We also provide
310 a [pre-built Docker image](#jjb_docker) with `jenkins-jobs` already installed.
312 ### <a name="jjb_install">Installing Jenkins Job Builder</a>
314 For users who aren't already experienced with Docker or otherwise don't want
315 to use our [pre-built JJB Docker image](#jjb_docker), installing JJB into a
316 virtual environment is an equally good option.
318 We recommend using [pip](#jjb_install_pip) to assist with JJB installs, but we
319 also document [installing from a git repository manually](#jjb_install_manual).
320 For both, we [recommend][17] using [virtual environments](#jjb_install_venv)
321 to isolate JJB and its dependencies.
323 The [`builder/jjb/requirements.txt`][33] file contains the currently
324 recommended JJB version. Because JJB is fairly unstable, it may be necessary
325 to debug things by installing different versions. This is documented for both
326 [pip-assisted](#jjb_install_pip) and [manual](#jjb_install_manual) installs.
328 #### <a name="jjb_install_venv">Virtual Environments</a>
330 For both [pip-assisted](#jjb_install_pip) and [manual](#jjb_install_manual) JJB
331 installs, we [recommend using virtual environments][17] to manage JJB and its
332 Python dependencies. The [Virtualenvwrapper][30] tool can help you do so.
334 There are good docs for [installing Virtualenvwrapper][31]. On Linux systems
335 with pip (typical), they amount to:
337 sudo pip install virtualenvwrapper
339 A virtual environment is simply a directory that you install Python programs
340 into and then append to the front of your path, causing those copies to be
341 found before any system-wide versions.
343 Create a new virtual environment for JJB.
345 # Virtaulenvwrapper uses this dir for virtual environments
347 /home/daniel/.virtualenvs
348 # Make a new virtual environment
350 # A new venv dir was created
351 (jjb)$ ls -rc $WORKON_HOME | tail -n 1
353 # The new venv was added to the front of this shell's path
355 /home/daniel/.virtualenvs/jjb/bin:<my normal path>
356 # Software installed to venv, like pip, is found before system-wide copies
357 (jjb)$ command -v pip
358 /home/daniel/.virtualenvs/jjb/bin/pip
360 With your virtual environment active, you should install JJB. Your install will
361 be isolated to that virtual environment's directory and only visible when the
362 virtual environment is active.
364 You can easily leave and return to your venv. Make sure you activate it before
368 $ command -v jenkins-jobs
369 # No jenkins-jobs executable found
371 (jjb)$ command -v jenkins-jobs
372 $WORKON_HOME/jjb/bin/jenkins-jobs
374 #### <a name="jjb_install_pip">Installing JJB using pip</a>
376 The recommended way to install JJB is via pip.
378 Clone the latest version of the [`releng/builder`][4] repo.
380 $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git
382 Before actually installing JJB and its dependencies, make sure you've [created
383 and activated](#jjb_install_venv) a virtual environment for JJB.
387 When in doubt, the best version of JJB to attempt to use is the version
388 specified in the [`builder/jjb/requirements.txt`][33] file.
390 # From the root of the releng/builder repo
391 (jjb)$ pip install -r jjb/requirements.txt
393 To change the version of JJB specified by [`builder/jjb/requirements.txt`][33]
394 to install from the latest commit to the master branch of JJB's git repository:
396 $ cat jjb/requirements.txt
397 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder#egg=jenkins-job-builder
399 To install from a tag, like 1.4.0:
401 $ cat jjb/requirements.txt
402 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder@1.4.0#egg=jenkins-job-builder
404 #### <a name="jjb_install_manual">Installing JJB Manually</a>
406 This section documents installing JJB from its manually cloned repository.
408 Note that [installing via pip](#jjb_install_pip) is typically simpler.
410 Checkout the version of JJB's source you'd like to build.
412 For example, using master:
414 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
416 Using a tag, like 1.4.0:
418 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
419 $ cd jenkins-job-builder
420 $ git checkout tags/1.4.0
422 Before actually installing JJB and its dependencies, make sure you've [created
423 and activated](#jjb_install_venv) a virtual environment for JJB.
427 You can then use [JJB's `requirements.txt`][20] file to install its
430 # In the cloned JJB repo, with the desired version of the code checked out
431 (jjb)$ pip install -r requirements.txt
433 Finally, install JJB.
435 # In the cloned JJB repo, with the desired version of the code checked out
436 (jjb)$ python setup.py sdist
437 (jjb)$ pip install dist/jenkins-job-builder-*.tar.gz
439 Note that we're not using `sudo` to install as root, since we want to make
440 use of the venv we've configured for our current user.
442 ### <a name="jjb_install_docker">JJB Docker Image</a>
444 [Docker][14] is an open platform used to create virtualized Linux containers
445 for shipping self-contained applications. Docker leverages LinuX Containers
446 \(LXC\) running on the same operating system as the host machine, whereas a
447 traditional VM runs an operating system over the host.
449 docker pull zxiiro/jjb-docker
450 docker run --rm -v ${PWD}:/jjb jjb-docker
452 [This Dockerfile][15] created the [zxiiro/jjb-docker image][29]. By default it
457 You'll need to use the `-v/--volume=[]` parameter to mount a directory
458 containing your YAML files, as well as a configured `jenkins.ini` file if you
459 wish to upload your jobs to the [sandbox](#jenkins_sandbox).
461 ## <a name="jjb_templates">Jenkins Job Templates</a>
463 The OpenDaylight [RelEng/Builder][21] project provides [JJB job templates][2]
464 that can be used to define basic jobs.
466 ### Verify Job Template
470 The Verify job template creates a Gerrit Trigger job that will trigger when a
471 new patch is submitted to Gerrit.
473 Verify jobs can be retriggered in Gerrit by leaving a comment that says
476 ### Merge Job Template
480 The Merge job template is similar to the Verify Job Template except it will
481 trigger once a Gerrit patch is merged into the repo. It also automatically
482 runs the Maven goals **source:jar** and **javadoc:jar**.
484 This job will upload artifacts to [OpenDaylight's Nexus][22] on completion.
486 Merge jobs can be retriggered in Gerrit by leaving a comment that says
489 ### Daily Job Template
491 The Daily (or Nightly) Job Template creates a job which will run on a build on
492 a Daily basis as a sanity check to ensure the build is still working day to
495 ### Sonar Job Template
497 Trigger: **run-sonar**
499 This job runs Sonar analysis and reports the results to [OpenDaylight's Sonar
502 **Note:** Running the "run-sonar" trigger will cause Jenkins to remove its
503 existing vote if it's already -1'd or +1'd a comment. You will need to re-run
504 your verify job (recheck) after running this to get Jenkins to re-vote.
506 The Sonar Job Template creates a job which will run against the master branch,
507 or if BRANCHES are specified in the CFG file it will create a job for the
508 **First** branch listed.
510 ### Integration Job Template
512 The Integration Job Template creates a job which runs when a project that your
513 project depends on is successfully built. This job type is basically the same
514 as a verify job except that it triggers from other Jenkins jobs instead of via
515 Gerrit review updates. The dependencies that triger integration jobs are listed
516 in your project.cfg file under the **DEPENDENCIES** variable.
518 If no dependencies are listed then this job type is disabled by default.
520 ### <a name="distribution_test_job">Distribution Test Job</a>
522 Trigger: **test-distribution**
524 This job builds a distrbution against your patch, passes distribution sanity test
525 and reports back the results to Gerrit. Leave a comment with trigger keyword above
526 to activate it for a particular patch.
528 This job is maintained by the [Integration/Test][1] project.
530 **Note:** Running the "test-distribution" trigger will cause Jenkins to remove
531 it's existing vote if it's already -1 or +1'd a comment. You will need to
532 re-run your verify job (recheck) after running this to get Jenkins to put back
535 ### <a name="patch_test_job">Patch Test Job</a>
537 Trigger: **test-integration**
539 This job runs a full integration test suite against your patch and reports
540 back the results to Gerrit. Leave a comment with trigger keyword above to activate it
541 for a particular patch.
543 This job is maintained by the [Integration/Test][1] project.
545 **Note:** Running the "test-integration" trigger will cause Jenkins to remove
546 it's existing vote if it's already -1 or +1'd a comment. You will need to
547 re-run your verify job (recheck) after running this to get Jenkins to put back
550 Some considerations when using this job:
552 * The patch test verification takes some time (~2 hours) + consumes a lot of
553 resources so it is not meant to be used for every patch.
554 * The system tests for master patches will fail most of the times because both
555 code and test are unstable during the release cycle (should be good by the
557 * Because of the above, patch test results typically have to be interpreted by
558 system test experts. The [Integration/Test][1] project can help with that.
561 ### Autorelease Validate Job
563 Trigger: **revalidate**
565 This job runs the PROJECT-validate-autorelease-BRANCH job which is used as a
566 quick sanity test to ensure that a patch does not depend on features that do
567 not exist in the current release.
569 The **revalidate** trigger is useful in cases where a project's verify job
570 passed however validate failed due to infra problems or intermittent issues.
571 It will retrigger just the validate-autorelease job.
573 ## <a name="jjb_basic_configuration">Basic Job Configuration</a>
575 To create jobs based on existing [templates](#jjb_templates), use the
576 [`jjb-init-project.py`][24] helper script. When run from the root of
577 [RelEng/Builder's repo][13], it will produce a file in
578 `jjb/<project>/<project>.yaml` containing your project's base template.
580 $ python scripts/jjb-init-project.py --help
581 usage: jjb-init-project.py [-h] [-c CONF] [-d DEPENDENCIES] [-t TEMPLATES]
582 [-s STREAMS] [-p POM] [-g MVN_GOALS] [-o MVN_OPTS]
583 [-a ARCHIVE_ARTIFACTS]
586 positional arguments:
590 -h, --help show this help message and exit
591 -c CONF, --conf CONF Config file
592 -d DEPENDENCIES, --dependencies DEPENDENCIES
593 Project dependencies A comma-seperated (no spaces)
594 list of projects your project depends on. This is used
595 to create an integration job that will trigger when a
596 dependent project-merge job is built successfully.
597 Example: aaa,controller,yangtools
598 -t TEMPLATES, --templates TEMPLATES
600 -s STREAMS, --streams STREAMS
601 Release streams to fill with default options
602 -p POM, --pom POM Path to pom.xml to use in Maven build (Default:
604 -g MVN_GOALS, --mvn-goals MVN_GOALS
606 -o MVN_OPTS, --mvn-opts MVN_OPTS
608 -a ARCHIVE_ARTIFACTS, --archive-artifacts ARCHIVE_ARTIFACTS
609 Comma-seperated list of patterns of artifacts to
610 archive on build completion. See:
611 http://ant.apache.org/manual/Types/fileset.html
613 If all your project requires is the basic verify, merge, and daily jobs then
614 using the job template should be all you need to configure for your jobs.
616 ### Auto-Update Job Templates
618 The first line of the job YAML file produced by the [init script][24] will
619 contain the words `# REMOVE THIS LINE IF...`. Leaving this line will allow the
620 RelEng/Builder [auto-update script][25] to maintain this file for your project,
621 should the base templates ever change. It is a good idea to leave this line if
622 you do not plan to create any complex jobs outside of the provided template.
624 However, if your project needs more control over your jobs or if you have any
625 additional configuration outside of the standard configuration provided by the
626 template, then this line should be removed.
628 #### Tuning Templates
630 Allowing the auto-updated to manage your templates doesn't prevent you from
631 doing some configuration changes. Parameters can be passed to templates via
632 a `<project>.cfg` in your `builder/jjb/<project>` directory. An example is
633 provided below, others can be found in the repos of other projects. Tune as
634 necessary. Unnecessary paramaters can be removed or commented out with a "#"
637 JOB_TEMPLATES: verify,merge,sonar
641 jdks: openjdk7,openjdk8
644 branch: stable/lithium
647 MVN_GOALS: clean install javadoc:aggregate -DrepoBuild -Dmaven.repo.local=$WORKSPACE/.m2repo -Dorg.ops4j.pax.url.mvn.localRepository=$WORKSPACE/.m2repo
648 MVN_OPTS: -Xmx1024m -XX:MaxPermSize=256m
649 DEPENDENCIES: aaa,controller,yangtools
650 ARCHIVE_ARTIFACTS: *.logs, *.patches
652 Note: [STREAMS][26] is a list of branches you want JJB to generate jobs for.
653 The first branch will be the branch that reports Sonar analysis. Each branch
654 must define a "jdks:" section listing the JDKs the verify jobs should run tests
655 against for the branch. The first JDK listed will be used as the default JDK
656 for non-verify type jobs.
658 Note: Projects that are participating in the simultanious release should set
659 "autorelease: true" under the streams they are participating in autorelease
660 for. This enables a new job type validate-autorelease which is used to help
661 identify if Gerrit patches might break autorelease or not.
665 It is also possible to take advantage of both the auto-updater and creating
666 your own jobs. To do this, create a YAML file in your project's sub-directory
667 with any name other than \<project\>.yaml. The auto-update script will only
668 search for files with the name \<project\>.yaml. The normal \<project\>.yaml
669 file can then be left in tact with the "# REMOVE THIS LINE IF..." comment so
670 it will be automatically updated.
672 ## <a name="jjb_maven_properties">Maven Properties</a>
674 We provide a properties which your job can take advantage of if you want to do
675 something different depending on the job type that is run. If you create a
676 profile that activates on a property listed blow. The JJB templated jobs will
677 be able to activate the profile during the build to run any custom code you
678 wish to run in your project.
680 -Dmerge : This flag is passed in our Merge job and is equivalent to the
683 -Dsonar : This flag is passed in our Sonar job and is equivalent to the
687 # <a name="jenkins_sandbox">Jenkins Sandbox</a>
689 The [sandbox instance][27]'s purpose is to allow projects to test their JJB
690 setups before merging their code over to the RelEng master silo. It is
691 configured similarly to the master instance, although it cannot publish
692 artifacts or vote in Gerrit.
694 If your project requires access to the sandbox please open an OpenDaylight
695 Helpdesk ticket (<helpdesk@opendaylight.org>) and provide your ODL ID.
697 ## Notes Regarding the Sandbox
699 * Jobs are automatically deleted every Saturday at 08:00 UTC
700 * Committers can login and configure Jenkins jobs in the sandbox directly
701 (unlike with the master silo)
702 * Sandbox configuration mirrors the master silo when possible
703 * Sandbox jobs can NOT upload artifacts to Nexus
704 * Sandbox jobs can NOT vote on Gerrit
706 ## <a name="sandbox_config">Configuration</a>
708 Make sure you have Jenkins Job Builder [properly installed](#jjb_install).
710 If you do not already have access, open an OpenDaylight Helpdesk ticket
711 (<helpdesk@opendaylight.org>) to request access to ODL's sandbox instance.
712 [Integration/Test][1] committers have access by default.
714 JJB reads user-specific configuration from a [`jenkins.ini` file][7]. An
715 example is provided at [`builder/jenkins.ini.example`][28].
717 # If you don't have RelEng/Builder's repo, clone it
718 $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git
719 # Make a copy of the example JJB config file (in the builder/ directory)
720 $ cp jenkins.ini.example jenkins.ini
721 # Edit jenkins.ini with your username, API token and ODL's sandbox URL
725 user=<your ODL username>
726 password=<your ODL Jenkins sandbox API token>
727 url=https://jenkins.opendaylight.org/sandbox
730 To get your API token, [login to the Jenkins **sandbox** instance][32] (_not
731 the main master Jenkins instance, different tokens_), go to your user page (by
732 clicking on your username, for example), click "Configure" and then "Show API
735 ## <a name="jjb_use_manual">Manual Method</a>
737 If you [installed JJB locally into a virtual environment](#jjb_install),
738 you should now activate that virtual environment to access the `jenkins-jobs`
744 You'll want to work from the root of the RelEng/Builder repo, and you should
745 have your `jenkins.ini` file [properly configured](#sandbox_config).
747 ### <a name="jjb_manual_test">Testing Jobs</a>
749 It's good practice to use the `test` command to validate your JJB files before
752 jenkins-jobs --conf jenkins.ini test jjb/ <job-name>
754 If the job you'd like to test is a template with variables in its name, it
755 must be manually expanded before use. For example, the commonly used template
756 `{project}-csit-verify-1node-{functionality}` might expand to
757 `ovsdb-csit-verify-1node-netvirt`.
759 jenkins-jobs --conf jenkins.ini test jjb/ ovsdb-csit-verify-1node-netvirt
761 Successful tests output the XML description of the Jenkins job described by
762 the specified JJB job name.
764 ### <a name="jjb_manual_push">Pushing Jobs</a>
766 Once you've [configured your `jenkins.ini`](#sandbox_config) and [verified your
767 JJB jobs](#jjb_manual_test) produce valid XML descriptions of Jenkins jobs you
768 can push them to the Jenkins sandbox.
770 > _**Important Note:** When pushing with `jenkins-jobs`, a log message with
771 > the number of jobs you're pushing will be issued, typically to stdout.
772 > **If the number is greater than 1** (or the number of jobs you passed to
773 > the command to push) then you are pushing too many jobs and should **`ctrl+c`
774 > to cancel the upload**. Else you will flood the system with jobs._
776 > INFO:jenkins_jobs.builder:Number of jobs generated: 1
778 > _**Failing to provide the final `<job-name>` param will push all jobs!**_
780 # Don't push all jobs by omitting the final param! (ctrl+c to abort)
781 jenkins-jobs --conf jenkins.ini update jjb/ <job-name>
783 ## <a name="jjb_use_docker">Docker Method</a>
785 If [using Docker](#jjb_install_docker):
788 docker run --rm -v ${PWD}:/jjb zxiiro/jjb-docker
790 > _**Important Note:** When pushing with `jenkins-jobs`, a log message with
791 > the number of jobs you're pushing will be issued, typically to stdout.
792 > **If the number is greater than 1** (or the number of jobs you passed to
793 > the command to push) then you are pushing too many jobs and should **`ctrl+c`
794 > to cancel the upload**. Else you will flood the system with jobs._
796 > INFO:jenkins_jobs.builder:Number of jobs generated: 1
798 > _**Failing to provide the final `<job-name>` param will push all jobs!**_
800 # To upload jobs to the sandbox
801 # Please ensure that you include a configured jenkins.ini in your volume mount
802 # Making sure not to push more jobs than expected, ctrl+c to abort
803 docker run --rm -v ${PWD}:/jjb zxiiro/jjb-docker jenkins-jobs --conf jenkins.ini update . openflowplugin-csit-periodic-1node-cds-longevity-only-master
805 [0]: https://wiki.opendaylight.org/view/RelEng:Main "ODL RelEng parent project wiki"
806 [1]: https://wiki.opendaylight.org/view/Integration/Test "ODL Integration/Test wiki"
807 [2]: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jenkins-scripts;h=371193b89f418de2ca0ffcb78be4a2d8046701ae;hb=refs/heads/master "JJB Templates Directory"
808 [3]: https://jenkins.opendaylight.org/releng "RelEng Jenkins"
809 [4]: https://git.opendaylight.org/gerrit/gitweb?p=releng%2Fbuilder.git;a=summary "RelEng/Builder gitweb"
810 [5]: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jenkins-scripts;h=69252dd61ece511bd2018039b40e7836a8d49d21;hb=HEAD "Directory of Jenkins slave spinup scripts"
811 [6]: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=vagrant;h=409a2915d48bbdeea9edc811e1661ae17ca28280;hb=HEAD "Directory of Jenkins slave Vagrant definitions"
812 [7]: http://docs.openstack.org/infra/jenkins-job-builder/execution.html#configuration-file "JJB config file docs"
813 [8]: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=vagrant/basic-java-node;h=7197b26b747deba38c08f30a569c233fd9636d72;hb=HEAD "Example Jenkins slave Vagrant defition"
814 [9]: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/controller.sh;h=893a04118a9bd9c55ae2a4a6af833fa089e0e0b4;hb=HEAD "Jenkins spinup script specialized for a slave"
815 [10]: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/basic_settings.sh;h=9f6d2a89948d0a25a8a4a24102630ada494e8623;hb=HEAD "Jenkins spinup script common to all slaves"
816 [11]: http://ci.openstack.org/jenkins-job-builder/ "JJB docs"
817 [12]: https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder "ODL RelEng/Builder Gerrit"
818 [13]: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=summary "ODL RelEng/Builder repo"
819 [14]: https://www.docker.com/whatisdocker/ "Docker docs"
820 [15]: https://github.com/zxiiro/jjb-docker/blob/master/Dockerfile "Custom ODL JJB Dockerfile"
821 [16]: https://github.com/openstack-infra/jenkins-job-builder "JJB repo"
822 [17]: https://lists.opendaylight.org/pipermail/integration-dev/2015-April/003016.html "Recommendation to use venvs"
823 [18]: https://virtualenv.readthedocs.org/en/latest/ "Virtualenv docs"
824 [19]: http://virtualenv.readthedocs.org/en/latest/installation.html "Virtualenv install docs"
825 [20]: https://github.com/openstack-infra/jenkins-job-builder/blob/master/requirements.txt "JJB Python dependencies"
826 [21]: https://wiki.opendaylight.org/view/RelEng/Builder "ODL RelEng/Builder wiki"
827 [22]: https://nexus.opendaylight.org "OpenDaylight's Nexus portal"
828 [23]: https://sonar.opendaylight.org "OpenDaylight's Sonar portal"
829 [24]: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-init-project.py;h=2133475a4ff9e1f4b18cc288654a4dc050bf808f;hb=refs/heads/master "JJB project config init helper script"
830 [25]: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-autoupdate-project.py;h=56769bdb7ad5149404f4f50923f4d10af98d8248;hb=refs/heads/master "JJB project config auto-update helper script"
831 [26]: https://lists.opendaylight.org/pipermail/release/2015-July/003139.html "STREAMS vs BRANCHES design background"
832 [27]: https://jenkins.opendaylight.org/sandbox/ "OpenDaylight JJB Sandbox"
833 [28]: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins.ini.example;h=c8486f89af99741f4706c23cd6717df9b417ae10;hb=refs/heads/master "JJB sandbox user config example"
834 [29]: https://hub.docker.com/r/zxiiro/jjb-docker/ "Custom JJB Docker image"
835 [30]: https://virtualenvwrapper.readthedocs.org/en/latest/ "Virtualenvwrapper docs"
836 [31]: https://virtualenvwrapper.readthedocs.org/en/latest/install.html "Virtualenvwrapper install docs"
837 [32]: https://jenkins.opendaylight.org/sandbox/login "ODL Jenkins sandbox login"
838 [33]: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/requirements.txt;h=0a4df2c2a575eb10d3abddb0fb2f4d048645e378;hb=refs/heads/master "ODL JJB requirements.txt file"