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 ### Pool: Rackspace DFW - Matrix
246 <table class="table table-bordered">
248 <td><b>Jenkins Label</b><br/> matrix_master</td>
249 <td><b>Slave Template name</b><br/> rk-c-el6-matrix</td>
250 <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-java-node</td>
251 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/matrix.sh</td>
255 This is a very minimal system that is designed to spin up with 2 build
256 instances on it. The purpose is to have a location that is not the
257 Jenkins master itself for jobs that are executing matrix operations
258 since they need a director location. This image should not be used for
259 anything but tying matrix jobs before the matrx defined label ties.
264 # <a name="creating_jenkins_jobs">Creating Jenkins Jobs</a>
266 Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format
267 and uses them to configure Jenkins.
269 * [Jenkins Job Builder][11] \(JJB\) documentation
270 * [RelEng/Builder Gerrit][12]
271 * [RelEng/Builder Git repository][13]
273 ## <a name="jjb">Getting Jenkins Job Builder</a>
275 OpenDaylight uses Jenkins Job Builder to translate our in-repo YAML job
276 configuration into job descriptions suitable for consumption by Jenkins.
277 When testing new Jenkins Jobs in the [sandbox](#jenkins_sandbox), you'll
278 need to use the `jenkins-jobs` executable to translate a set of jobs into
279 their XML descriptions and upload them to the sandbox Jenkins server.
281 We document [installing](#jjb_install) `jenkins-jobs` below. We also provide
282 a [pre-built Docker image](#jjb_docker) with `jenkins-jobs` already installed.
284 ### <a name="jjb_install">Installing Jenkins Job Builder</a>
286 For users who aren't already experienced with Docker or otherwise don't want
287 to use our [pre-built JJB Docker image](#jjb_docker), installing JJB into a
288 virtual environment is an equally good option.
290 We recommend using [pip](#jjb_install_pip) to assist with JJB installs, but we
291 also document [installing from a git repository manually](#jjb_install_manual).
292 For both, we [recommend][17] using [virtual environments](#jjb_install_venv)
293 to isolate JJB and its dependencies.
295 The [`builder/jjb/requirements.txt`][33] file contains the currently
296 recommended JJB version. Because JJB is fairly unstable, it may be necessary
297 to debug things by installing different versions. This is documented for both
298 [pip-assisted](#jjb_install_pip) and [manual](#jjb_install_manual) installs.
300 #### <a name="jjb_install_venv">Virtual Environments</a>
302 For both [pip-assisted](#jjb_install_pip) and [manual](#jjb_install_manual) JJB
303 installs, we [recommend using virtual environments][17] to manage JJB and its
304 Python dependencies. The [Virtualenvwrapper][30] tool can help you do so.
306 There are good docs for [installing Virtualenvwrapper][31]. On Linux systems
307 with pip (typical), they amount to:
309 sudo pip install virtualenvwrapper
311 A virtual environment is simply a directory that you install Python programs
312 into and then append to the front of your path, causing those copies to be
313 found before any system-wide versions.
315 Create a new virtual environment for JJB.
317 # Virtaulenvwrapper uses this dir for virtual environments
319 /home/daniel/.virtualenvs
320 # Make a new virtual environment
322 # A new venv dir was created
323 (jjb)$ ls -rc $WORKON_HOME | tail -n 1
325 # The new venv was added to the front of this shell's path
327 /home/daniel/.virtualenvs/jjb/bin:<my normal path>
328 # Software installed to venv, like pip, is found before system-wide copies
329 (jjb)$ command -v pip
330 /home/daniel/.virtualenvs/jjb/bin/pip
332 With your virtual environment active, you should install JJB. Your install will
333 be isolated to that virtual environment's directory and only visible when the
334 virtual environment is active.
336 You can easily leave and return to your venv. Make sure you activate it before
340 $ command -v jenkins-jobs
341 # No jenkins-jobs executable found
343 (jjb)$ command -v jenkins-jobs
344 $WORKON_HOME/jjb/bin/jenkins-jobs
346 #### <a name="jjb_install_pip">Installing JJB using pip</a>
348 The recommended way to install JJB is via pip.
350 Clone the latest version of the [`releng/builder`][4] repo.
352 $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git
354 Before actually installing JJB and its dependencies, make sure you've [created
355 and activated](#jjb_install_venv) a virtual environment for JJB.
359 When in doubt, the best version of JJB to attempt to use is the version
360 specified in the [`builder/jjb/requirements.txt`][33] file.
362 # From the root of the releng/builder repo
363 (jjb)$ pip install -r jjb/requirements.txt
365 To change the version of JJB specified by [`builder/jjb/requirements.txt`][33]
366 to install from the latest commit to the master branch of JJB's git repository:
368 $ cat jjb/requirements.txt
369 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder#egg=jenkins-job-builder
371 To install from a tag, like 1.3.0:
373 $ cat jjb/requirements.txt
374 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder@1.3.0#egg=jenkins-job-builder
376 #### <a name="jjb_install_manual">Installing JJB Manually</a>
378 This section documents installing JJB from its manually cloned repository.
380 Note that [installing via pip](#jjb_install_pip) is typically simpler.
382 Checkout the version of JJB's source you'd like to build.
384 For example, using master:
386 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
388 Using a tag, like 1.3.0:
390 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
391 $ cd jenkins-job-builder
392 $ git checkout tags/1.3.0
394 Before actually installing JJB and its dependencies, make sure you've [created
395 and activated](#jjb_install_venv) a virtual environment for JJB.
399 You can then use [JJB's `requirements.txt`][20] file to install its
402 # In the cloned JJB repo, with the desired version of the code checked out
403 (jjb)$ pip install -r requirements.txt
405 Finally, install JJB.
407 # In the cloned JJB repo, with the desired version of the code checked out
408 (jjb)$ python setup.py install
410 Note that we're not using `sudo` to install as root, since we want to make
411 use of the venv we've configured for our current user.
413 ### <a name="jjb_install_docker">JJB Docker Image</a>
415 [Docker][14] is an open platform used to create virtualized Linux containers
416 for shipping self-contained applications. Docker leverages LinuX Containers
417 \(LXC\) running on the same operating system as the host machine, whereas a
418 traditional VM runs an operating system over the host.
420 docker pull zxiiro/jjb-docker
421 docker run --rm -v ${PWD}:/jjb jjb-docker
423 [This Dockerfile][15] created the [zxiiro/jjb-docker image][29]. By default it
428 You'll need to use the `-v/--volume=[]` parameter to mount a directory
429 containing your YAML files, as well as a configured `jenkins.ini` file if you
430 wish to upload your jobs to the [sandbox](#jenkins_sandbox).
432 ## <a name="jjb_templates">Jenkins Job Templates</a>
434 The OpenDaylight [RelEng/Builder][21] project provides [JJB job templates][2]
435 that can be used to define basic jobs.
437 ### Verify Job Template
441 The Verify job template creates a Gerrit Trigger job that will trigger when a
442 new patch is submitted to Gerrit.
444 Verify jobs can be retriggered in Gerrit by leaving a comment that says
447 ### Merge Job Template
451 The Merge job template is similar to the Verify Job Template except it will
452 trigger once a Gerrit patch is merged into the repo. It also automatically
453 runs the Maven goals **source:jar** and **javadoc:jar**.
455 This job will upload artifacts to [OpenDaylight's Nexus][22] on completion.
457 Merge jobs can be retriggered in Gerrit by leaving a comment that says
460 ### Daily Job Template
462 The Daily (or Nightly) Job Template creates a job which will run on a build on
463 a Daily basis as a sanity check to ensure the build is still working day to
466 ### Sonar Job Template
468 Trigger: **run-sonar**
470 This job runs Sonar analysis and reports the results to [OpenDaylight's Sonar
473 **Note:** Running the "run-sonar" trigger will cause Jenkins to remove its
474 existing vote if it's already -1'd or +1'd a comment. You will need to re-run
475 your verify job (recheck) after running this to get Jenkins to re-vote.
477 The Sonar Job Template creates a job which will run against the master branch,
478 or if BRANCHES are specified in the CFG file it will create a job for the
479 **First** branch listed.
481 ### Integration Job Template
483 The Integration Job Template creates a job which runs when a project that your
484 project depends on is successfully built. This job type is basically the same
485 as a verify job except that it triggers from other Jenkins jobs instead of via
486 Gerrit review updates. The dependencies that triger integration jobs are listed
487 in your project.cfg file under the **DEPENDENCIES** variable.
489 If no dependencies are listed then this job type is disabled by default.
491 ### <a name="distribution_test_job">Distribution Test Job</a>
493 Trigger: **test-distribution**
495 This job builds a distrbution against your patch, passes distribution sanity test
496 and reports back the results to Gerrit. Leave a comment with trigger keyword above
497 to activate it for a particular patch.
499 This job is maintained by the [Integration/Test][1] project.
501 **Note:** Running the "test-distribution" trigger will cause Jenkins to remove
502 it's existing vote if it's already -1 or +1'd a comment. You will need to
503 re-run your verify job (recheck) after running this to get Jenkins to put back
506 ### <a name="patch_test_job">Patch Test Job</a>
508 Trigger: **test-integration**
510 This job runs a full integration test suite against your patch and reports
511 back the results to Gerrit. Leave a comment with trigger keyword above to activate it
512 for a particular patch.
514 This job is maintained by the [Integration/Test][1] project.
516 **Note:** Running the "test-integration" trigger will cause Jenkins to remove
517 it's existing vote if it's already -1 or +1'd a comment. You will need to
518 re-run your verify job (recheck) after running this to get Jenkins to put back
521 Some considerations when using this job:
523 * The patch test verification takes some time (~2 hours) + consumes a lot of
524 resources so it is not meant to be used for every patch.
525 * The system tests for master patches will fail most of the times because both
526 code and test are unstable during the release cycle (should be good by the
528 * Because of the above, patch test results typically have to be interpreted by
529 system test experts. The [Integration/Test][1] project can help with that.
532 ### Autorelease Validate Job
534 Trigger: **revalidate**
536 This job runs the PROJECT-validate-autorelease-BRANCH job which is used as a
537 quick sanity test to ensure that a patch does not depend on features that do
538 not exist in the current release.
540 The **revalidate** trigger is useful in cases where a project's verify job
541 passed however validate failed due to infra problems or intermittent issues.
542 It will retrigger just the validate-autorelease job.
544 ## <a name="jjb_basic_configuration">Basic Job Configuration</a>
546 To create jobs based on existing [templates](#jjb_templates), use the
547 [`jjb-init-project.py`][24] helper script. When run from the root of
548 [RelEng/Builder's repo][13], it will produce a file in
549 `jjb/<project>/<project>.yaml` containing your project's base template.
551 $ python scripts/jjb-init-project.py --help
552 usage: jjb-init-project.py [-h] [-c CONF] [-d DEPENDENCIES] [-t TEMPLATES]
553 [-s STREAMS] [-p POM] [-g MVN_GOALS] [-o MVN_OPTS]
554 [-a ARCHIVE_ARTIFACTS]
557 positional arguments:
561 -h, --help show this help message and exit
562 -c CONF, --conf CONF Config file
563 -d DEPENDENCIES, --dependencies DEPENDENCIES
564 Project dependencies A comma-seperated (no spaces)
565 list of projects your project depends on. This is used
566 to create an integration job that will trigger when a
567 dependent project-merge job is built successfully.
568 Example: aaa,controller,yangtools
569 -t TEMPLATES, --templates TEMPLATES
571 -s STREAMS, --streams STREAMS
572 Release streams to fill with default options
573 -p POM, --pom POM Path to pom.xml to use in Maven build (Default:
575 -g MVN_GOALS, --mvn-goals MVN_GOALS
577 -o MVN_OPTS, --mvn-opts MVN_OPTS
579 -a ARCHIVE_ARTIFACTS, --archive-artifacts ARCHIVE_ARTIFACTS
580 Comma-seperated list of patterns of artifacts to
581 archive on build completion. See:
582 http://ant.apache.org/manual/Types/fileset.html
584 If all your project requires is the basic verify, merge, and daily jobs then
585 using the job template should be all you need to configure for your jobs.
587 ### Auto-Update Job Templates
589 The first line of the job YAML file produced by the [init script][24] will
590 contain the words `# REMOVE THIS LINE IF...`. Leaving this line will allow the
591 RelEng/Builder [auto-update script][25] to maintain this file for your project,
592 should the base templates ever change. It is a good idea to leave this line if
593 you do not plan to create any complex jobs outside of the provided template.
595 However, if your project needs more control over your jobs or if you have any
596 additional configuration outside of the standard configuration provided by the
597 template, then this line should be removed.
599 #### Tuning Templates
601 Allowing the auto-updated to manage your templates doesn't prevent you from
602 doing some configuration changes. Parameters can be passed to templates via
603 a `<project>.cfg` in your `builder/jjb/<project>` directory. An example is
604 provided below, others can be found in the repos of other projects. Tune as
605 necessary. Unnecessary paramaters can be removed or commented out with a "#"
608 JOB_TEMPLATES: verify,merge,sonar
612 jdks: openjdk7,openjdk8
615 branch: stable/lithium
618 MVN_GOALS: clean install javadoc:aggregate -DrepoBuild -Dmaven.repo.local=$WORKSPACE/.m2repo -Dorg.ops4j.pax.url.mvn.localRepository=$WORKSPACE/.m2repo
619 MVN_OPTS: -Xmx1024m -XX:MaxPermSize=256m
620 DEPENDENCIES: aaa,controller,yangtools
621 ARCHIVE_ARTIFACTS: *.logs, *.patches
623 Note: [STREAMS][26] is a list of branches you want JJB to generate jobs for.
624 The first branch will be the branch that reports Sonar analysis. Each branch
625 must define a "jdks:" section listing the JDKs the verify jobs should run tests
626 against for the branch. The first JDK listed will be used as the default JDK
627 for non-verify type jobs.
629 Note: Projects that are participating in the simultanious release should set
630 "autorelease: true" under the streams they are participating in autorelease
631 for. This enables a new job type validate-autorelease which is used to help
632 identify if Gerrit patches might break autorelease or not.
636 It is also possible to take advantage of both the auto-updater and creating
637 your own jobs. To do this, create a YAML file in your project's sub-directory
638 with any name other than \<project\>.yaml. The auto-update script will only
639 search for files with the name \<project\>.yaml. The normal \<project\>.yaml
640 file can then be left in tact with the "# REMOVE THIS LINE IF..." comment so
641 it will be automatically updated.
643 ## <a name="jjb_maven_properties">Maven Properties</a>
645 We provide a properties which your job can take advantage of if you want to do
646 something different depending on the job type that is run. If you create a
647 profile that activates on a property listed blow. The JJB templated jobs will
648 be able to activate the profile during the build to run any custom code you
649 wish to run in your project.
651 -Dmerge : This flag is passed in our Merge job and is equivalent to the
654 -Dsonar : This flag is passed in our Sonar job and is equivalent to the
658 # <a name="jenkins_sandbox">Jenkins Sandbox</a>
660 The [sandbox instance][27]'s purpose is to allow projects to test their JJB
661 setups before merging their code over to the RelEng master silo. It is
662 configured similarly to the master instance, although it cannot publish
663 artifacts or vote in Gerrit.
665 If your project requires access to the sandbox please open an OpenDaylight
666 Helpdesk ticket (<helpdesk@opendaylight.org>) and provide your ODL ID.
668 ## Notes Regarding the Sandbox
670 * Jobs are automatically deleted every Saturday at 08:00 UTC
671 * Committers can login and configure Jenkins jobs in the sandbox directly
672 (unlike with the master silo)
673 * Sandbox configuration mirrors the master silo when possible
674 * Sandbox jobs can NOT upload artifacts to Nexus
675 * Sandbox jobs can NOT vote on Gerrit
677 ## <a name="sandbox_config">Configuration</a>
679 Make sure you have Jenkins Job Builder [properly installed](#jjb_install).
681 If you do not already have access, open an OpenDaylight Helpdesk ticket
682 (<helpdesk@opendaylight.org>) to request access to ODL's sandbox instance.
683 [Integration/Test][1] committers have access by default.
685 JJB reads user-specific configuration from a [`jenkins.ini` file][7]. An
686 example is provided at [`builder/jenkins.ini.example`][28].
688 # If you don't have RelEng/Builder's repo, clone it
689 $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git
690 # Make a copy of the example JJB config file (in the builder/ directory)
691 $ cp jenkins.ini.example jenkins.ini
692 # Edit jenkins.ini with your username, API token and ODL's sandbox URL
696 user=<your ODL username>
697 password=<your ODL Jenkins sandbox API token>
698 url=https://jenkins.opendaylight.org/sandbox
701 To get your API token, [login to the Jenkins **sandbox** instance][32] (_not
702 the main master Jenkins instance, different tokens_), go to your user page (by
703 clicking on your username, for example), click "Configure" and then "Show API
706 ## <a name="jjb_use_manual">Manual Method</a>
708 If you [installed JJB locally into a virtual environment](#jjb_install),
709 you should now activate that virtual environment to access the `jenkins-jobs`
715 You'll want to work from the root of the RelEng/Builder repo, and you should
716 have your `jenkins.ini` file [properly configured](#sandbox_config).
718 ### <a name="jjb_manual_test">Testing Jobs</a>
720 It's good practice to use the `test` command to validate your JJB files before
723 jenkins-jobs --conf jenkins.ini test jjb/ <job-name>
725 If the job you'd like to test is a template with variables in its name, it
726 must be manually expanded before use. For example, the commonly used template
727 `{project}-csit-verify-1node-{functionality}` might expand to
728 `ovsdb-csit-verify-1node-netvirt`.
730 jenkins-jobs --conf jenkins.ini test jjb/ ovsdb-csit-verify-1node-netvirt
732 Successful tests output the XML description of the Jenkins job described by
733 the specified JJB job name.
735 ### <a name="jjb_manual_push">Pushing Jobs</a>
737 Once you've [configured your `jenkins.ini`](#sandbox_config) and [verified your
738 JJB jobs](#jjb_manual_test) produce valid XML descriptions of Jenkins jobs you
739 can push them to the Jenkins sandbox.
741 > _**Important Note:** When pushing with `jenkins-jobs`, a log message with
742 > the number of jobs you're pushing will be issued, typically to stdout.
743 > **If the number is greater than 1** (or the number of jobs you passed to
744 > the command to push) then you are pushing too many jobs and should **`ctrl+c`
745 > to cancel the upload**. Else you will flood the system with jobs._
747 > INFO:jenkins_jobs.builder:Number of jobs generated: 1
749 > _**Failing to provide the final `<job-name>` param will push all jobs!**_
751 # Don't push all jobs by omitting the final param! (ctrl+c to abort)
752 jenkins-jobs --conf jenkins.ini update jjb/ <job-name>
754 ## <a name="jjb_use_docker">Docker Method</a>
756 If [using Docker](#jjb_install_docker):
759 docker run --rm -v ${PWD}:/jjb zxiiro/jjb-docker
761 > _**Important Note:** When pushing with `jenkins-jobs`, a log message with
762 > the number of jobs you're pushing will be issued, typically to stdout.
763 > **If the number is greater than 1** (or the number of jobs you passed to
764 > the command to push) then you are pushing too many jobs and should **`ctrl+c`
765 > to cancel the upload**. Else you will flood the system with jobs._
767 > INFO:jenkins_jobs.builder:Number of jobs generated: 1
769 > _**Failing to provide the final `<job-name>` param will push all jobs!**_
771 # To upload jobs to the sandbox
772 # Please ensure that you include a configured jenkins.ini in your volume mount
773 # Making sure not to push more jobs than expected, ctrl+c to abort
774 docker run --rm -v ${PWD}:/jjb zxiiro/jjb-docker jenkins-jobs --conf jenkins.ini update . openflowplugin-csit-periodic-1node-cds-longevity-only-master
776 [0]: https://wiki.opendaylight.org/view/RelEng:Main "ODL RelEng parent project wiki"
777 [1]: https://wiki.opendaylight.org/view/Integration/Test "ODL Integration/Test wiki"
778 [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"
779 [3]: https://jenkins.opendaylight.org/releng "RelEng Jenkins"
780 [4]: https://git.opendaylight.org/gerrit/gitweb?p=releng%2Fbuilder.git;a=summary "RelEng/Builder gitweb"
781 [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"
782 [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"
783 [7]: http://docs.openstack.org/infra/jenkins-job-builder/execution.html#configuration-file "JJB config file docs"
784 [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"
785 [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"
786 [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"
787 [11]: http://ci.openstack.org/jenkins-job-builder/ "JJB docs"
788 [12]: https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder "ODL RelEng/Builder Gerrit"
789 [13]: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=summary "ODL RelEng/Builder repo"
790 [14]: https://www.docker.com/whatisdocker/ "Docker docs"
791 [15]: https://github.com/zxiiro/jjb-docker/blob/master/Dockerfile "Custom ODL JJB Dockerfile"
792 [16]: https://github.com/openstack-infra/jenkins-job-builder "JJB repo"
793 [17]: https://lists.opendaylight.org/pipermail/integration-dev/2015-April/003016.html "Recommendation to use venvs"
794 [18]: https://virtualenv.readthedocs.org/en/latest/ "Virtualenv docs"
795 [19]: http://virtualenv.readthedocs.org/en/latest/installation.html "Virtualenv install docs"
796 [20]: https://github.com/openstack-infra/jenkins-job-builder/blob/master/requirements.txt "JJB Python dependencies"
797 [21]: https://wiki.opendaylight.org/view/RelEng/Builder "ODL RelEng/Builder wiki"
798 [22]: https://nexus.opendaylight.org "OpenDaylight's Nexus portal"
799 [23]: https://sonar.opendaylight.org "OpenDaylight's Sonar portal"
800 [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"
801 [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"
802 [26]: https://lists.opendaylight.org/pipermail/release/2015-July/003139.html "STREAMS vs BRANCHES design background"
803 [27]: https://jenkins.opendaylight.org/sandbox/ "OpenDaylight JJB Sandbox"
804 [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"
805 [29]: https://hub.docker.com/r/zxiiro/jjb-docker/ "Custom JJB Docker image"
806 [30]: https://virtualenvwrapper.readthedocs.org/en/latest/ "Virtualenvwrapper docs"
807 [31]: https://virtualenvwrapper.readthedocs.org/en/latest/install.html "Virtualenvwrapper install docs"
808 [32]: https://jenkins.opendaylight.org/sandbox/login "ODL Jenkins sandbox login"
809 [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"