4 The `Release Engineering Project <releng-wiki_>`_ consolidates the Jenkins jobs from
5 project-specific VMs to a single Jenkins server. Each OpenDaylight project
6 has a tab for their jobs on the `jenkins-master`_. The system utilizes
7 `Jenkins Job Builder <jjb-docs_>`_ for the creation and management of the
16 New Project Quick Start
17 -----------------------
19 This section attempts to provide details on how to get going as a new project
20 quickly with minimal steps. The rest of the guide should be read and understood
21 by those who need to create and contribute new job types that is not already
22 covered by the existing job templates provided by OpenDaylight's JJB repo.
24 As a new project you will be mainly interested in getting your jobs to appear
25 in the jenkins-master_ silo and this can be achieved by simply creating a
26 <project>.yaml in the releng/builder project's jjb directory.
30 git clone https://git.opendaylight.org/gerrit/releng/builder
32 mkdir jjb/<new-project>
34 Where <new-project> should be the same name as your project's git repo in
35 Gerrit. So if your project is called "aaa" then create a new jjb/aaa directory.
37 Next we will create <new-project>.yaml as follows:
43 name: <NEW_PROJECT>-carbon
45 - '{project-name}-clm-{stream}'
46 - '{project-name}-integration-{stream}'
47 - '{project-name}-merge-{stream}'
48 - '{project-name}-verify-{stream}-{maven}-{jdks}'
50 project: '<NEW_PROJECT>'
51 project-name: '<NEW_PROJECT>'
60 mvn-settings: '<NEW_PROJECT>-settings'
61 mvn-goals: 'clean install -Dmaven.repo.local=/tmp/r -Dorg.ops4j.pax.url.mvn.localRepository=/tmp/r'
62 mvn-opts: '-Xmx1024m -XX:MaxPermSize=256m'
63 dependencies: 'odlparent-merge-{stream},yangtools-merge-{stream},controller-merge-{stream}'
64 email-upstream: '[<NEW_PROJECT>] [odlparent] [yangtools] [controller]'
68 name: <NEW_PROJECT>-sonar
70 - '{project-name}-sonar'
72 project: '<NEW_PROJECT>'
73 project-name: '<NEW_PROJECT>'
75 mvn-settings: '<NEW_PROJECT>-settings'
76 mvn-goals: 'clean install -Dmaven.repo.local=/tmp/r -Dorg.ops4j.pax.url.mvn.localRepository=/tmp/r'
77 mvn-opts: '-Xmx1024m -XX:MaxPermSize=256m'
79 Replace all instances of <new-project> with the name of your project. This will
80 create the jobs with the default job types we recommend for Java projects. If
81 your project is participating in the simultanious-release and ultimately will
82 be included in the final distribution, it is required to add the following job
83 types into the job list for the release you are participating.
88 - '{project-name}-distribution-check-{stream}'
89 - '{project-name}-validate-autorelease-{stream}'
91 If you'd like to explore the additional tweaking options available
92 please refer to the `Jenkins Job Templates`_ section.
94 Finally we need to push these files to Gerrit for review by the releng/builder
95 team to push your jobs to Jenkins.
99 git add jjb/<new-project>
100 git commit -sm "Add <new-project> jobs to Jenkins"
103 This will push the jobs to Gerrit and your jobs will appear in Jenkins once the
104 releng/builder team has reviewed and merged your patch.
109 The `jenkins-master`_ is the home for all project's Jenkins jobs. All
110 maintenance and configuration of these jobs must be done via JJB through the
111 `releng-builder-repo`_. Project contributors can no longer edit the Jenkins jobs
112 directly on the server.
117 The Jenkins jobs are run on build minions (executors) which are created on an
118 as-needed basis. If no idle build minions are available a new VM is brought
119 up. This process can take up to 2 minutes. Once the build minion has finished a
120 job, it will be destroyed.
122 Our Jenkins master supports many types of dynamic build minions. If you are
123 creating custom jobs then you will need to have an idea of what type of minions
124 are available. The following are the current minion types and descriptions.
125 Minion Template Names are needed for jobs that take advantage of multiple
126 minions as they must be specifically called out by template name instead of
129 Adding New Components to the Minions
130 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
132 If your project needs something added to one of the minions, you can help us
133 get things added faster by doing one of the following:
135 * Submit a patch to RelEng/Builder for the appropriate `jenkins-scripts`
136 definition which configure software during minion boot up.
137 * Submit a patch to RelEng/Builder for the `packer/provision` scripts that
138 configures software during minion instance imaging.
139 * Submit a patch to RelEng/Builder for the Packer's templates in
140 the `packer/templates` directory that configures a new instance definition
141 along with changes in `packer/provision`.
143 Going the first route will be faster in the short term as we can inspect the
144 changes and make test modifications in the sandbox to verify that it works.
148 The first route may add additional setup time considering this is run every
149 time the minion is booted.
151 The second and third routes, however, is better for the community as a whole as
152 it will allow others to utilize our Packer setups to replicate our systems more
153 closely. It is, however, more time consuming as an image snapshot needs to be
154 created based on the updated Packer definitions before it can be attached to the
155 Jenkins configuration on sandbox for validation testing.
157 In either case, the changes must be validated in the sandbox with tests to
158 make sure that we don't break current jobs and that the new software features
159 are operating as intended. Once this is done the changes will be merged and
160 the updates applied to the RelEng Jenkins production silo. Any changes to
161 files under `releng/builder/packer` will be validated and images would be built
162 triggered by verify-packer and merge-packer jobs.
164 Please note that the combination of a Packer definitions from `vars`, `templates`
165 and the `provision` scripts is what defines a given minion. For instance, a minion
166 may be defined as `centos7-java-builder` which is a combination of Packer OS image
167 definitions from `vars/centos.json`, Packer template definitions from
168 `templates/java-buidler.json` and spinup scripts from `provision/java-builder.sh`.
169 This combination provides the full definition of the realized minion.
171 Jenkins starts a minion using the latest image which is built and linked into the
172 Jenkins configuration. Once the base instance is online Jenkins checks out the
173 RelEng/Builder repo on it and executes two scripts. The first is
174 `provision/baseline.sh`, which is a baseline for all of the minions.
176 The second is the specialized script, which handles any system updates,
177 new software installs or extra environment tweaks that don't make sense in a
178 snapshot. Examples could include installing new package or setting up a virtual
179 environment. Its imperative to ensure modifications to these spinup scripts have
180 considered time taken to install the packages, as this could increase the build
181 time for every job which runs on the image. After all of these scripts have
182 executed Jenkins will finally attach the minion as an actual minion and start
190 <table class="table table-bordered">
192 <td><b>Jenkins Labels</b><br/> centos7-java-builder-2c-4g,
193 centos7-java-builder-2c-8g, centos7-java-builder-4c-8g,
194 centos7-java-builder-8c-8g, centos7-java-builder-4c-16g</td>
195 <td><b>Minion Template names</b><br/> centos7-java-builder-2c-4g,
196 centos7-java-builder-2c-4g, centos7-java-builder-2c-8g,
197 centos7-java-builder-4c-8g, centos7-java-builder-8c-8g,
198 centos7-java-builder-4c-16g</td>
199 <td><b>Packer Template</b><br/>
200 releng/builder/packer/templates/java-builder.json</td>
201 <td><b>Spinup Script</b><br/>
202 releng/builder/jenkins-scripts/builder.sh</td>
206 CentOS 7 build minion configured with OpenJDK 1.7 (Java7) and OpenJDK
207 1.8 (Java8) along with all the other components and libraries needed
208 for building any current OpenDaylight project. This is the label that
209 is used for all basic verify, merge and daily builds for
215 <td><b>Jenkins Labels</b><br/> centos7-robot-2c-2g</td>
216 <td><b>Minion Template names</b><br/> centos7-robot-2c-2g</td>
217 <td><b>Packer Template</b><br/>
218 releng/builder/packer/templates/robot.json</td>
219 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/robot.sh</td>
223 CentOS 7 minion configured with OpenJDK 1.7 (Java7), OpenJDK
224 1.8 (Java8) and all the current packages used by the integration
225 project for doing robot driven jobs. If you are executing robot
226 framework jobs then your job should be using this as the minion that
227 you are tied to. This image does not contain the needed libraries for
228 building components of OpenDaylight, only for executing robot tests.
233 <td><b>Jenkins Labels</b><br/> ubuntu1404-mininet-2c-2g</td>
234 <td><b>Minion Template names</b><br/> ubuntu1404-mininet-2c-2g</td>
235 <td><b>Packer Template</b><br/>
236 releng/builder/packer/teamplates/mininet.json</td>
237 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
241 Basic Ubuntu 14.04 (Trusty) system with ovs 2.0.2 and mininet 2.1.0
246 <td><b>Jenkins Labels</b><br/> ubuntu1404-mininet-ovs-23-2c-2g</td>
247 <td><b>Minion Template names</b><br/> ubuntu1404-mininet-ovs-23-2c-2g</td>
248 <td><b>Packer Template</b><br/> releng/builder/packer/templates/mininet-ovs-2.3.json</td>
249 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
253 Ubuntu 16.04 (Xenial) system with ovs 2.5 and mininet 2.2.1
258 <td><b>Jenkins Labels</b><br/> centos7-devstack-2c-4g</td>
259 <td><b>Minion Template names</b><br/> centos7-devstack-2c-4g</td>
260 <td><b>Packer Template</b><br/> releng/builder/packer/templates/devstack.json</td>
261 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/devstack.sh</td>
265 CentOS 7 system purpose built for doing OpenStack testing using
266 DevStack. This minion is primarily targeted at the needs of the OVSDB
267 project. It has OpenJDK 1.7 (aka Java7) and OpenJDK 1.8 (Java8) and
268 other basic DevStack related bits installed.
273 <td><b>Jenkins Labels</b><br/> centos7-docker-2c-4g</td>
274 <td><b>Minion Template names</b><br/> centos7-docker-2c-4g</td>
275 <td><b>Packer Template</b><br/> releng/builder/packer/templates/docker.json</td>
276 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/docker.sh</td>
280 CentOS 7 system configured with OpenJDK 1.7 (aka Java7),
281 OpenJDK 1.8 (Java8) and Docker. This system was originally custom
282 built for the test needs of the OVSDB project but other projects have
283 expressed interest in using it.
288 <td><b>Jenkins Labels</b><br/> ubuntu1404-gbp-2c-2g</td>
289 <td><b>Minion Template names</b><br/> ubuntu1404-gbp-2c-2g</td>
290 <td><b>Packer Template</b><br/> releng/builder/packer/templates/gbp.json</td>
291 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/ubuntu-docker-ovs.sh</td>
295 Ubuntu 14.04 (Trusty) node with latest OVS and docker installed. Used by Group Based Policy.
300 <td><b>Jenkins Labels</b><br/> ubuntu1604-gbp-2c-4g</td>
301 <td><b>Minion Template names</b><br/> ubuntu1604-gbp-2c-4g</td>
302 <td><b>Packer Template</b><br/> releng/builder/packer/templates/gbp.json</td>
303 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/ubuntu-docker-ovs.sh</td>
307 Ubuntu 16.04 (Xenial) node with latest OVS and docker installed. Used by Group Based Policy.
313 Pool: ODLPUB - HOT (Heat Orchestration Templates)
314 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
316 HOT integration enables to spin up integration labs servers for CSIT jobs
317 using heat, rathar than using jclouds (deprecated). Image names are updated
318 on the project specific job templates using the variable
319 `{odl,docker,openstack,tools}_system_image` followed by image name in the
320 format `<platform> - <template> - <date-stamp>`.
324 CentOS 7 - docker - 20161031-0802
326 .. include:: cloud-images.rst
328 Creating Jenkins Jobs
329 ---------------------
331 Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format
332 and uses them to configure Jenkins.
334 * `Jenkins Job Builder (JJB) documentation <jjb-docs_>`_
335 * `RelEng/Builder Gerrit <releng-builder-gerrit_>`_
336 * `RelEng/Builder Git repository <releng-builder-repo_>`_
338 Getting Jenkins Job Builder
339 ---------------------------
341 OpenDaylight uses Jenkins Job Builder to translate our in-repo YAML job
342 configuration into job descriptions suitable for consumption by Jenkins.
343 When testing new Jenkins Jobs in the `Jenkins Sandbox`_, you'll
344 need to use the `jenkins-jobs` executable to translate a set of jobs into
345 their XML descriptions and upload them to the sandbox Jenkins server.
347 We document `installing <Installing Jenkins Job Builder_>`_ `jenkins-jobs`
348 below. We also provide
349 a `pre-built Docker image <jjb-docker_>`_ with `jenkins-jobs` already installed.
351 Installing Jenkins Job Builder
352 ------------------------------
354 For users who aren't already experienced with Docker or otherwise don't want
355 to use our `pre-built JJB Docker image <jjb-docker_>`_, installing JJB into a
356 virtual environment is an equally good option.
358 We recommend using `pip <Installing JJB using pip_>`_ to assist with JJB
360 also document `installing from a git repository manually
361 <Installing JJB Manually_>`_.
362 For both, we recommend using Python `Virtual Environments`_
363 to isolate JJB and its dependencies.
365 The `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file contains the currently
366 recommended JJB version. Because JJB is fairly unstable, it may be necessary
367 to debug things by installing different versions. This is documented for both
368 `pip-assisted <Installing JJB using pip_>`_ and `manual
369 <Installing JJB Manually_>`_ installs.
374 For both `pip-assisted <Installing JJB using pip_>`_ and `manual
375 <Installing JJB Manually_>`_ JJB
376 installs, we recommend using `Python Virtual Environments <python-virtualenv_>`_
377 to manage JJB and its
378 Python dependencies. The `python-virtualenvwrapper`_ tool can help you do so.
380 There are good docs for installing `python-virtualenvwrapper`_. On Linux systems
381 with pip (typical), they amount to:
385 sudo pip install virtualenvwrapper
387 A virtual environment is simply a directory that you install Python programs
388 into and then append to the front of your path, causing those copies to be
389 found before any system-wide versions.
391 Create a new virtual environment for JJB.
395 # Virtaulenvwrapper uses this dir for virtual environments
397 /home/daniel/.virtualenvs
398 # Make a new virtual environment
400 # A new venv dir was created
401 (jjb)$ ls -rc $WORKON_HOME | tail -n 1
403 # The new venv was added to the front of this shell's path
405 /home/daniel/.virtualenvs/jjb/bin:<my normal path>
406 # Software installed to venv, like pip, is found before system-wide copies
407 (jjb)$ command -v pip
408 /home/daniel/.virtualenvs/jjb/bin/pip
410 With your virtual environment active, you should install JJB. Your install will
411 be isolated to that virtual environment's directory and only visible when the
412 virtual environment is active.
414 You can easily leave and return to your venv. Make sure you activate it before
420 $ command -v jenkins-jobs
421 # No jenkins-jobs executable found
423 (jjb)$ command -v jenkins-jobs
424 $WORKON_HOME/jjb/bin/jenkins-jobs
426 Installing JJB using pip
427 ------------------------
429 The recommended way to install JJB is via pip.
431 First, clone the latest version of the `releng-builder-repo`_.
435 $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git
437 Before actually installing JJB and its dependencies, make sure you've `created
438 and activated <Virtual Environments_>`_ a virtual environment for JJB.
444 The recommended version of JJB to install is the version specified in the
445 `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file.
449 # From the root of the releng/builder repo
450 (jjb)$ pip install -r jjb/requirements.txt
452 To validate that JJB was successfully installed you can run this command:
456 (jjb)$ jenkins-jobs --version
458 TODO: Explain that only the currently merged jjb/requirements.txt is supported,
459 other options described below are for troubleshooting only.
461 To change the version of JJB specified by `builder/jjb/requirements.txt
462 <odl-jjb-requirements.txt_>`_
463 to install from the latest commit to the master branch of JJB's git repository:
467 $ cat jjb/requirements.txt
468 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder#egg=jenkins-job-builder
470 To install from a tag, like 1.4.0:
474 $ cat jjb/requirements.txt
475 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder@1.4.0#egg=jenkins-job-builder
477 Installing JJB Manually
478 -----------------------
480 This section documents installing JJB from its manually cloned repository.
482 Note that `installing via pip <Installing JJB using pip_>`_ is typically simpler.
484 Checkout the version of JJB's source you'd like to build.
486 For example, using master:
490 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
492 Using a tag, like 1.4.0:
496 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
497 $ cd jenkins-job-builder
498 $ git checkout tags/1.4.0
500 Before actually installing JJB and its dependencies, make sure you've `created
501 and activated <Virtual Environments_>`_ a virtual environment for JJB.
507 You can then use JJB's `requirements.txt <jjb-requirements.txt_>`_ file to
509 dependencies. Note that we're not using `sudo` to install as root, since we want
510 to make use of the venv we've configured for our current user.
514 # In the cloned JJB repo, with the desired version of the code checked out
515 (jjb)$ pip install -r requirements.txt
517 Then install JJB from the repo with:
523 To validate that JJB was successfully installed you can run this command:
527 (jjb)$ jenkins-jobs --version
532 `Docker <docker-docs_>`_ is an open platform used to create virtualized Linux containers
533 for shipping self-contained applications. Docker leverages LinuX Containers
534 \(LXC\) running on the same operating system as the host machine, whereas a
535 traditional VM runs an operating system over the host.
539 docker pull zxiiro/jjb-docker
540 docker run --rm -v ${PWD}:/jjb jjb-docker
542 This `Dockerfile <jjb-dockerfile_>`_ created the
543 `zxiiro/jjb-docker image <jjb-docker_>`_.
544 By default it will run:
550 You'll need to use the `-v/--volume=[]` parameter to mount a directory
551 containing your YAML files, as well as a configured `jenkins.ini` file if you
552 wish to upload your jobs to the `Jenkins Sandbox`_.
554 Jenkins Job Templates
555 ---------------------
557 The OpenDaylight `RelEng/Builder <releng-builder-wiki_>`_ project provides
558 `jjb-templates`_ that can be used to define basic jobs.
560 The *Gerrit Trigger* listed in the jobs are keywords that can be used to
561 trigger the job to run manually by simply leaving a comment in Gerrit for the
562 patch you wish to trigger against.
564 All jobs have a default build-timeout value of 360 minutes (6 hrs) but can be
565 overrided via the opendaylight-infra-wrappers' build-timeout property.
567 TODO: Group jobs into categories: every-patch, after-merge, on-demand, etc.
568 TODO: Reiterate that "remerge" triggers all every-patch jobs at once,
569 because when only a subset of jobs is triggered, Gerrit forgets valid -1 from jobs outside the subset.
570 TODO: Document that only drafts and commit-message-only edits do not trigger every-patch jobs.
571 TODO: Document test-{project}-{feature} and test-{project}-all.
575 <table class="table table-bordered">
577 <td><b>Job Template</b><br/>{project}-distribution-check-{stream}</td>
578 <td><b>Gerrit Trigger</b><br/>recheck</td>
582 This job runs the PROJECT-distribution-check-BRANCH job which is
583 building also integration/distribution project in order to run SingleFeatureTest.
584 It also performs various other checks in order to prevent the change to break autorelease.
589 <td><b>Job Template</b><br/>{project}-integration-{stream}</td>
594 The Integration Job Template creates a job which runs when a project that your
595 project depends on is successfully built. This job type is basically the same
596 as a verify job except that it triggers from other Jenkins jobs instead of via
597 Gerrit review updates. The dependencies that triger integration jobs are listed
598 in your project.cfg file under the <b>DEPENDENCIES</b> variable.
600 If no dependencies are listed then this job type is disabled by default.
605 <td><b>Job Template</b><br/>{project}-merge-{stream}</td>
606 <td><b>Gerrit Trigger</b><br/>remerge</td>
610 This job will trigger once a Gerrit patch is merged into the repo.
611 It will build HEAD of the current project branch and also run the Maven goals
612 <b>source:jar</b> and <b>javadoc:jar</b>.
613 Artifacts are uploaded to OpenDaylight's
614 <a href="https://nexus.opendaylight.org">Nexus</a> on completion.
616 A distribution-merge-{stream} job is triggered to add the new artifacts to the
617 integration distribution.
619 Running the "remerge" trigger is possible before a Change is merged,
620 it would still build the actual HEAD. This job does not alter Gerrit votes.
625 <td><b>Job Template</b><br/>{project}-sonar</td>
626 <td><b>Gerrit Trigger</b><br/>run-sonar</td>
630 This job runs Sonar analysis and reports the results to
631 OpenDaylight's <a href="https://sonar.opendaylight.org">Sonar</a>
634 The Sonar Job Template creates a job which will run against the
635 master branch, or if BRANCHES are specified in the CFG file it will
636 create a job for the <b>First</b> branch listed.
638 <div class="admonition note">
639 <p class="first admonition-title">Note</p>
641 Running the "run-sonar" trigger will cause Jenkins to remove
642 its existing vote if it's already -1'd or +1'd a comment. You
643 will need to re-run your verify job (recheck) after running
644 this to get Jenkins to re-vote.
651 <td><b>Job Template</b><br/>{project}-validate-autorelease-{stream}</td>
652 <td><b>Gerrit Trigger</b><br/>recheck</td>
656 This job runs the PROJECT-validate-autorelease-BRANCH job which is
657 used as a quick sanity test to ensure that a patch does not depend on
658 features that do not exist in the current release.
663 <td><b>Job Template</b><br/>{project}-verify-{stream}-{maven}-{jdks}</td>
664 <td><b>Gerrit Trigger</b><br/>recheck</td>
668 The Verify job template creates a Gerrit Trigger job that will
669 trigger when a new patch is submitted to Gerrit.
670 The job only builds the project code (including unit and integration tests).
675 <td><b>Job Template</b><br/>{project}-verify-node-{stream}</td>
676 <td><b>Gerrit Trigger</b><br/>recheck</td>
680 This job template can be used by a project that is NodeJS based. It
681 simply installs a python virtualenv and uses that to install nodeenv
682 which is then used to install another virtualenv for nodejs. It then
683 calls <b>npm install</b> and <b>npm test</b> to run the unit tests.
684 When using this template you need to provide a {nodedir} and
685 {nodever} containing the directory relative to the project root
686 containing the nodejs package.json and version of node you wish to
692 <td><b>Job Template</b><br/>{project}-verify-python-{stream} | {project}-verify-tox-{stream}</td>
693 <td><b>Gerrit Trigger</b><br/>recheck</td>
697 This job template can be used by a project that uses Tox to build. It
698 simply installs a Python virtualenv and uses tox to run the tests
699 defined in the project's tox.ini file. If the tox.ini is anywhere
700 other than the project's repo root, the path to its directory
701 relative to the project's repo root should be passed as {toxdir}.
703 The 2 template names verify-python & verify-tox are identical and are
704 aliases to each other. This allows the project to use the naming that
705 is most reasonable for them.
710 <td><b>Job Template</b><br/>integration-patch-test-{stream}</td>
711 <td><b>Gerrit Trigger</b><br/>test-integration</td>
719 <td><b>Job Template</b><br/>integration-patch-test-{stream}</td>
720 <td><b>Gerrit Trigger</b><br/>test-integration</td>
724 This job builds a distribution against your Java patch and triggers distribution sanity CSIT jobs.
725 Leave a comment with trigger keyword above to activate it for a particular patch.
726 This job should not alter Gerrit votes for a given patch.
728 The list of CSIT jobs to trigger is defined in csit-list
729 <a href="https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/integration/integration-test-jobs.yaml">here</a>.
731 Some considerations when using this job:
734 The patch test verification takes some time (~2 hours) + consumes a lot of
735 resources so it is not meant to be used for every patch.
738 The system tests for master patches will fail most of the times because both
739 code and test are unstable during the release cycle (should be good by the
743 Because of the above, patch test results typically have to be interpreted by
744 system test experts. The <a href="https://wiki.opendaylight.org/view/Integration/Test">Integration/Test</a>
745 project can help with that.
754 We provide a properties which your job can take advantage of if you want to do
755 something different depending on the job type that is run. If you create a
756 profile that activates on a property listed blow. The JJB templated jobs will
757 be able to activate the profile during the build to run any custom code you
758 wish to run in your project.
762 -Dmerge : This flag is passed in our Merge job and is equivalent to the
765 -Dsonar : This flag is passed in our Sonar job and is equivalent to the
772 The `jenkins-sandbox`_ instance's purpose is to allow projects to test their JJB
773 setups before merging their code over to the RelEng master silo. It is
774 configured similarly to the master instance, although it cannot publish
775 artifacts or vote in Gerrit.
777 If your project requires access to the sandbox please open an OpenDaylight
778 Helpdesk ticket (<helpdesk@opendaylight.org>) and provide your ODL ID.
780 Notes Regarding the Sandbox
781 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
783 * Jobs are automatically deleted every Saturday at 08:00 UTC
784 * Committers can login and configure Jenkins jobs in the sandbox directly
785 (unlike with the master silo)
786 * Sandbox configuration mirrors the master silo when possible
787 * Sandbox jobs can NOT upload artifacts to Nexus
788 * Sandbox jobs can NOT vote on Gerrit
793 Make sure you have Jenkins Job Builder [properly installed](#jjb_install).
795 If you do not already have access, open an OpenDaylight Helpdesk ticket
796 (<helpdesk@opendaylight.org>) to request access to ODL's sandbox instance.
797 Integration/Test (`integration-test-wiki`_) committers have access by default.
799 JJB reads user-specific configuration from a `jenkins.ini`_. An
800 example is provided by releng/builder at `example-jenkins.ini`_.
804 # If you don't have RelEng/Builder's repo, clone it
805 $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git
806 # Make a copy of the example JJB config file (in the builder/ directory)
807 $ cp jenkins.ini.example jenkins.ini
808 # Edit jenkins.ini with your username, API token and ODL's sandbox URL
812 user=<your ODL username>
813 password=<your ODL Jenkins sandbox API token>
814 url=https://jenkins.opendaylight.org/sandbox
817 To get your API token, `login to the Jenkins **sandbox** instance
818 <jenkins-sandbox-login_>`_ (*not
819 the main master Jenkins instance, different tokens*), go to your user page (by
820 clicking on your username, for example), click "Configure" and then "Show API
826 If you `installed JJB locally into a virtual environment
827 <Installing Jenkins Job Builder_>`_,
828 you should now activate that virtual environment to access the `jenkins-jobs`
836 You'll want to work from the root of the RelEng/Builder repo, and you should
837 have your `jenkins.ini` file [properly configured](#sandbox_config).
842 It's good practice to use the `test` command to validate your JJB files before
847 jenkins-jobs --conf jenkins.ini test jjb/ <job-name>
849 If the job you'd like to test is a template with variables in its name, it
850 must be manually expanded before use. For example, the commonly used template
851 `{project}-csit-verify-1node-{functionality}` might expand to
852 `ovsdb-csit-verify-1node-netvirt`.
856 jenkins-jobs --conf jenkins.ini test jjb/ ovsdb-csit-verify-1node-netvirt
858 Successful tests output the XML description of the Jenkins job described by
859 the specified JJB job name.
864 Once you've `configured your \`jenkins.ini\` <Configuration_>`_ and `verified your
865 JJB jobs <Testing Jobs_>`_ produce valid XML descriptions of Jenkins jobs you
866 can push them to the Jenkins sandbox.
870 When pushing with `jenkins-jobs`, a log message with the number
871 of jobs you're pushing will be issued, typically to stdout.
872 **If the number is greater than 1** (or the number of jobs you
873 passed to the command to push) then you are pushing too many
874 jobs and should **`ctrl+c` to cancel the upload**. Else you will
875 flood the system with jobs.
879 INFO:jenkins_jobs.builder:Number of jobs generated: 1
881 **Failing to provide the final `<job-name>` param will push all
886 # Don't push all jobs by omitting the final param! (ctrl+c to abort)
887 jenkins-jobs --conf jenkins.ini update jjb/ <job-name>
892 Once you have your Jenkins job configuration `pushed to the
893 Sandbox <Pushing Jobs_>`_ you can trigger it to run.
895 Find your newly-pushed job on the `Sandbox's web UI <jenkins-sandbox_>`_. Click
896 on its name to see the job's details.
898 Make sure you're `logged in <jenkins-sandbox-login_>`_ to the Sandbox.
900 Click "Build with Parameters" and then "Build".
902 Wait for your job to be scheduled and run. Click on the job number to see
903 details, including console output.
905 Make changes to your JJB configuration, re-test, re-push and re-run until
911 If `using Docker <JJB Docker image_>`_:
916 docker run --rm -v ${PWD}:/jjb zxiiro/jjb-docker
920 When pushing with `jenkins-jobs`, a log message with
921 the number of jobs you're pushing will be issued, typically to stdout.
922 **If the number is greater than 1** (or the number of jobs you passed to
923 the command to push) then you are pushing too many jobs and should **`ctrl+c`
924 to cancel the upload**. Else you will flood the system with jobs.
928 INFO:jenkins_jobs.builder:Number of jobs generated: 1
930 **Failing to provide the final `<job-name>` param will push all jobs!**
934 # To upload jobs to the sandbox
935 # Please ensure that you include a configured jenkins.ini in your volume mount
936 # Making sure not to push more jobs than expected, ctrl+c to abort
937 docker run --rm -v ${PWD}:/jjb zxiiro/jjb-docker jenkins-jobs --conf jenkins.ini update . openflowplugin-csit-periodic-1node-cds-longevity-only-master
939 .. _docker-docs: https://www.docker.com/whatisdocker/
940 .. _example-jenkins.ini: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins.ini.example
941 .. _integration-test-wiki: https://wiki.opendaylight.org/view/Integration/Test
942 .. _jenkins-master: https://jenkins.opendaylight.org/releng
943 .. _jenkins-sandbox: https://jenkins.opendaylight.org/sandbox
944 .. _jenkins-sandbox-login: https://jenkins.opendaylight.org/sandbox/login
945 .. _jenkins.ini: http://docs.openstack.org/infra/jenkins-job-builder/execution.html#configuration-file
946 .. _jjb-autoupdate-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-autoupdate-project.py
947 .. _jjb-docker: https://hub.docker.com/r/zxiiro/jjb-docker/
948 .. _jjb-dockerfile: https://github.com/zxiiro/jjb-docker/blob/master/Dockerfile
949 .. _jjb-docs: http://ci.openstack.org/jenkins-job-builder/
950 .. _jjb-init-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-init-project.py
951 .. _jjb-repo: https://github.com/openstack-infra/jenkins-job-builder
952 .. _jjb-requirements.txt: https://github.com/openstack-infra/jenkins-job-builder/blob/master/requirements.txt
953 .. _jjb-templates: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jjb
954 .. _odl-jjb-requirements.txt: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/requirements.txt
955 .. _odl-nexus: https://nexus.opendaylight.org
956 .. _odl-sonar: https://sonar.opendaylight.org
957 .. _python-virtualenv: https://virtualenv.readthedocs.org/en/latest/
958 .. _python-virtualenvwrapper: https://virtualenvwrapper.readthedocs.org/en/latest/
959 .. _releng-wiki: https://wiki.opendaylight.org/view/RelEng:Main
960 .. _releng-builder-gerrit: https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder
961 .. _releng-builder-repo: https://git.opendaylight.org/gerrit/gitweb?p=releng%2Fbuilder.git;a=summary
962 .. _releng-builder-wiki: https://wiki.opendaylight.org/view/RelEng/Builder
963 .. _streams-design-background: https://lists.opendaylight.org/pipermail/release/2015-July/003139.html
964 .. _spinup-scripts: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jenkins-scripts
965 .. _spinup-scripts-basic_settings.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/basic_settings.sh
966 .. _spinup-scripts-controller.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/controller.sh