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 --recursive https://git.opendaylight.org/gerrit/releng/builder
32 mkdir jjb/<new-project>
36 releng/global-jjb is a submodule of releng/builder repository which
37 requires a git submodule update --init or using --recursive with git clone.
40 Where <new-project> should be the same name as your project's git repo in
41 Gerrit. If your project is called "aaa" then create a new jjb/aaa directory.
43 Next we will create <new-project>.yaml as follows:
49 name: <NEW_PROJECT>-carbon
51 - '{project-name}-clm-{stream}'
52 - '{project-name}-integration-{stream}'
53 - '{project-name}-merge-{stream}'
54 - '{project-name}-verify-{stream}-{maven}-{jdks}'
56 project: '<NEW_PROJECT>'
57 project-name: '<NEW_PROJECT>'
66 mvn-settings: '<NEW_PROJECT>-settings'
67 mvn-goals: 'clean install -Dmaven.repo.local=/tmp/r -Dorg.ops4j.pax.url.mvn.localRepository=/tmp/r'
68 mvn-opts: '-Xmx1024m -XX:MaxPermSize=256m'
69 dependencies: 'odlparent-merge-{stream},yangtools-merge-{stream},controller-merge-{stream}'
70 email-upstream: '[<NEW_PROJECT>] [odlparent] [yangtools] [controller]'
74 name: <NEW_PROJECT>-sonar
76 - '{project-name}-sonar'
78 project: '<NEW_PROJECT>'
79 project-name: '<NEW_PROJECT>'
81 mvn-settings: '<NEW_PROJECT>-settings'
82 mvn-goals: 'clean install -Dmaven.repo.local=/tmp/r -Dorg.ops4j.pax.url.mvn.localRepository=/tmp/r'
83 mvn-opts: '-Xmx1024m -XX:MaxPermSize=256m'
85 Replace all instances of <new-project> with the name of your project. This will
86 create the jobs with the default job types we recommend for Java projects. If
87 your project is participating in the simultanious-release and ultimately will
88 be included in the final distribution, it is required to add the following job
89 types into the job list for the release you are participating.
94 - '{project-name}-distribution-check-{stream}'
95 - '{project-name}-validate-autorelease-{stream}'
97 If you'd like to explore the additional tweaking options available
98 please refer to the `Jenkins Job Templates`_ section.
100 Finally we need to push these files to Gerrit for review by the releng/builder
101 team to push your jobs to Jenkins.
105 git add jjb/<new-project>
106 git commit -sm "Add <new-project> jobs to Jenkins"
109 This will push the jobs to Gerrit and your jobs will appear in Jenkins once the
110 releng/builder team has reviewed and merged your patch.
115 The `jenkins-master`_ is the home for all project's Jenkins jobs. All
116 maintenance and configuration of these jobs must be done via JJB through the
117 `releng-builder-repo`_. Project contributors can no longer edit the Jenkins jobs
118 directly on the server.
123 The Jenkins jobs are run on build minions (executors) which are created on an
124 as-needed basis. If no idle build minions are available a new VM is brought
125 up. This process can take up to 2 minutes. Once the build minion has finished a
126 job, it will be destroyed.
128 Our Jenkins master supports many types of dynamic build minions. If you are
129 creating custom jobs then you will need to have an idea of what type of minions
130 are available. The following are the current minion types and descriptions.
131 Minion Template Names are needed for jobs that take advantage of multiple
132 minions as they must be specifically called out by template name instead of
135 Adding New Components to the Minions
136 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
138 If your project needs something added to one of the minions, you can help us
139 get things added faster by doing one of the following:
141 * Submit a patch to RelEng/Builder for the appropriate `jenkins-scripts`
142 definition which configure software during minion boot up.
143 * Submit a patch to RelEng/Builder for the `packer/provision` scripts that
144 configures software during minion instance imaging.
145 * Submit a patch to RelEng/Builder for the Packer's templates in
146 the `packer/templates` directory that configures a new instance definition
147 along with changes in `packer/provision`.
149 Going the first route will be faster in the short term as we can inspect the
150 changes and make test modifications in the sandbox to verify that it works.
154 The first route may add additional setup time considering this is run every
155 time the minion is booted.
157 The second and third routes, however, is better for the community as a whole as
158 it will allow others to utilize our Packer setups to replicate our systems more
159 closely. It is, however, more time consuming as an image snapshot needs to be
160 created based on the updated Packer definitions before it can be attached to the
161 Jenkins configuration on sandbox for validation testing.
163 In either case, the changes must be validated in the sandbox with tests to
164 make sure that we don't break current jobs and that the new software features
165 are operating as intended. Once this is done the changes will be merged and
166 the updates applied to the RelEng Jenkins production silo. Any changes to
167 files under `releng/builder/packer` will be validated and images would be built
168 triggered by verify-packer and merge-packer jobs.
170 Please note that the combination of a Packer definitions from `vars`, `templates`
171 and the `provision` scripts is what defines a given minion. For instance, a minion
172 may be defined as `centos7-java-builder` which is a combination of Packer OS image
173 definitions from `vars/centos.json`, Packer template definitions from
174 `templates/java-buidler.json` and spinup scripts from `provision/java-builder.sh`.
175 This combination provides the full definition of the realized minion.
177 Jenkins starts a minion using the latest image which is built and linked into the
178 Jenkins configuration. Once the base instance is online Jenkins checks out the
179 RelEng/Builder repo on it and executes two scripts. The first is
180 `provision/baseline.sh`, which is a baseline for all of the minions.
182 The second is the specialized script, which handles any system updates,
183 new software installs or extra environment tweaks that don't make sense in a
184 snapshot. Examples could include installing new package or setting up a virtual
185 environment. Its imperative to ensure modifications to these spinup scripts have
186 considered time taken to install the packages, as this could increase the build
187 time for every job which runs on the image. After all of these scripts have
188 executed Jenkins will finally attach the minion as an actual minion and start
196 <table class="table table-bordered">
198 <td><b>Jenkins Labels</b><br/> centos7-java-builder-2c-4g,
199 centos7-java-builder-2c-8g, centos7-java-builder-4c-8g,
200 centos7-java-builder-8c-8g, centos7-java-builder-4c-16g</td>
201 <td><b>Minion Template names</b><br/> centos7-java-builder-2c-4g,
202 centos7-java-builder-2c-4g, centos7-java-builder-2c-8g,
203 centos7-java-builder-4c-8g, centos7-java-builder-8c-8g,
204 centos7-java-builder-4c-16g</td>
205 <td><b>Packer Template</b><br/>
206 releng/builder/packer/templates/java-builder.json</td>
207 <td><b>Spinup Script</b><br/>
208 releng/builder/jenkins-scripts/builder.sh</td>
212 CentOS 7 build minion configured with OpenJDK 1.7 (Java7) and OpenJDK
213 1.8 (Java8) along with all the other components and libraries needed
214 for building any current OpenDaylight project. This is the label that
215 is used for all basic verify, merge and daily builds for
221 <td><b>Jenkins Labels</b><br/> centos7-robot-2c-2g</td>
222 <td><b>Minion Template names</b><br/> centos7-robot-2c-2g</td>
223 <td><b>Packer Template</b><br/>
224 releng/builder/packer/templates/robot.json</td>
225 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/robot.sh</td>
229 CentOS 7 minion configured with OpenJDK 1.7 (Java7), OpenJDK
230 1.8 (Java8) and all the current packages used by the integration
231 project for doing robot driven jobs. If you are executing robot
232 framework jobs then your job should be using this as the minion that
233 you are tied to. This image does not contain the needed libraries for
234 building components of OpenDaylight, only for executing robot tests.
239 <td><b>Jenkins Labels</b><br/> ubuntu1404-mininet-2c-2g</td>
240 <td><b>Minion Template names</b><br/> ubuntu1404-mininet-2c-2g</td>
241 <td><b>Packer Template</b><br/>
242 releng/builder/packer/teamplates/mininet.json</td>
243 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
247 Basic Ubuntu 14.04 (Trusty) system with ovs 2.0.2 and mininet 2.1.0
252 <td><b>Jenkins Labels</b><br/> ubuntu1404-mininet-ovs-23-2c-2g</td>
253 <td><b>Minion Template names</b><br/> ubuntu1404-mininet-ovs-23-2c-2g</td>
254 <td><b>Packer Template</b><br/> releng/builder/packer/templates/mininet-ovs-2.3.json</td>
255 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
259 Ubuntu 16.04 (Xenial) system with ovs 2.5 and mininet 2.2.1
264 <td><b>Jenkins Labels</b><br/> centos7-devstack-2c-4g</td>
265 <td><b>Minion Template names</b><br/> centos7-devstack-2c-4g</td>
266 <td><b>Packer Template</b><br/> releng/builder/packer/templates/devstack.json</td>
267 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/devstack.sh</td>
271 CentOS 7 system purpose built for doing OpenStack testing using
272 DevStack. This minion is primarily targeted at the needs of the OVSDB
273 project. It has OpenJDK 1.7 (aka Java7) and OpenJDK 1.8 (Java8) and
274 other basic DevStack related bits installed.
279 <td><b>Jenkins Labels</b><br/> centos7-docker-2c-4g</td>
280 <td><b>Minion Template names</b><br/> centos7-docker-2c-4g</td>
281 <td><b>Packer Template</b><br/> releng/builder/packer/templates/docker.json</td>
282 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/docker.sh</td>
286 CentOS 7 system configured with OpenJDK 1.7 (aka Java7),
287 OpenJDK 1.8 (Java8) and Docker. This system was originally custom
288 built for the test needs of the OVSDB project but other projects have
289 expressed interest in using it.
294 <td><b>Jenkins Labels</b><br/> ubuntu1404-gbp-2c-2g</td>
295 <td><b>Minion Template names</b><br/> ubuntu1404-gbp-2c-2g</td>
296 <td><b>Packer Template</b><br/> releng/builder/packer/templates/gbp.json</td>
297 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/ubuntu-docker-ovs.sh</td>
301 Ubuntu 14.04 (Trusty) node with latest OVS and docker installed. Used by Group Based Policy.
306 <td><b>Jenkins Labels</b><br/> ubuntu1604-gbp-2c-4g</td>
307 <td><b>Minion Template names</b><br/> ubuntu1604-gbp-2c-4g</td>
308 <td><b>Packer Template</b><br/> releng/builder/packer/templates/gbp.json</td>
309 <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/ubuntu-docker-ovs.sh</td>
313 Ubuntu 16.04 (Xenial) node with latest OVS and docker installed. Used by Group Based Policy.
319 Pool: ODLPUB - HOT (Heat Orchestration Templates)
320 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
322 HOT integration enables to spin up integration labs servers for CSIT jobs
323 using heat, rathar than using jclouds (deprecated). Image names are updated
324 on the project specific job templates using the variable
325 `{odl,docker,openstack,tools}_system_image` followed by image name in the
326 format `<platform> - <template> - <date-stamp>`.
330 CentOS 7 - docker - 20161031-0802
332 .. include:: cloud-images.rst
334 Creating Jenkins Jobs
335 ---------------------
337 Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format
338 and uses them to configure Jenkins.
340 * `Jenkins Job Builder (JJB) documentation <jjb-docs_>`_
341 * `RelEng/Builder Gerrit <releng-builder-gerrit_>`_
342 * `RelEng/Builder Git repository <releng-builder-repo_>`_
344 Getting Jenkins Job Builder
345 ---------------------------
347 OpenDaylight uses Jenkins Job Builder to translate our in-repo YAML job
348 configuration into job descriptions suitable for consumption by Jenkins.
349 When testing new Jenkins Jobs in the `Jenkins Sandbox`_, you'll
350 need to use the `jenkins-jobs` executable to translate a set of jobs into
351 their XML descriptions and upload them to the sandbox Jenkins server.
353 We document `installing <Installing Jenkins Job Builder_>`_ `jenkins-jobs`
356 Installing Jenkins Job Builder
357 ------------------------------
359 We recommend using `pip <Installing JJB using pip_>`_ to assist with JJB
361 also document `installing from a git repository manually
362 <Installing JJB Manually_>`_.
363 For both, we recommend using Python `Virtual Environments`_
364 to isolate JJB and its dependencies.
366 The `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file contains the currently
367 recommended JJB version. Because JJB is fairly unstable, it may be necessary
368 to debug things by installing different versions. This is documented for both
369 `pip-assisted <Installing JJB using pip_>`_ and `manual
370 <Installing JJB Manually_>`_ installs.
375 For both `pip-assisted <Installing JJB using pip_>`_ and `manual
376 <Installing JJB Manually_>`_ JJB
377 installs, we recommend using `Python Virtual Environments <python-virtualenv_>`_
378 to manage JJB and its
379 Python dependencies. The `python-virtualenvwrapper`_ tool can help you do so.
381 Documentation is available for installing `python-virtualenvwrapper`_. On Linux
382 systems with pip (typical), they amount to:
386 sudo pip install virtualenvwrapper
388 A virtual environment is simply a directory that you install Python programs
389 into and then append to the front of your path, causing those copies to be
390 found before any system-wide versions.
392 Create a new virtual environment for JJB.
396 # Virtaulenvwrapper uses this dir for virtual environments
398 /home/daniel/.virtualenvs
399 # Make a new virtual environment
401 # A new venv dir was created
402 (jjb)$ ls -rc $WORKON_HOME | tail -n 1
404 # The new venv was added to the front of this shell's path
406 /home/daniel/.virtualenvs/jjb/bin:<my normal path>
407 # Software installed to venv, like pip, is found before system-wide copies
408 (jjb)$ command -v pip
409 /home/daniel/.virtualenvs/jjb/bin/pip
411 With your virtual environment active, you should install JJB. Your install will
412 be isolated to that virtual environment's directory and only visible when the
413 virtual environment is active.
415 You can easily leave and return to your venv. Make sure you activate it before
421 $ command -v jenkins-jobs
422 # No jenkins-jobs executable found
424 (jjb)$ command -v jenkins-jobs
425 $WORKON_HOME/jjb/bin/jenkins-jobs
427 Installing JJB using pip
428 ------------------------
430 The recommended way to install JJB is via pip.
432 First, clone the latest version of the `releng-builder-repo`_.
436 $ git clone --recursive https://git.opendaylight.org/gerrit/p/releng/builder.git
438 Before actually installing JJB and its dependencies, make sure you've `created
439 and activated <Virtual Environments_>`_ a virtual environment for JJB.
445 The recommended version of JJB to install is the version specified in the
446 `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file.
450 # From the root of the releng/builder repo
451 (jjb)$ pip install -r jjb/requirements.txt
453 To validate that JJB was successfully installed you can run this command:
457 (jjb)$ jenkins-jobs --version
459 TODO: Explain that only the currently merged jjb/requirements.txt is supported,
460 other options described below are for troubleshooting only.
462 To change the version of JJB specified by `builder/jjb/requirements.txt
463 <odl-jjb-requirements.txt_>`_
464 to install from the latest commit to the master branch of JJB's git repository:
468 $ cat jjb/requirements.txt
469 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder#egg=jenkins-job-builder
471 To install from a tag, like 1.4.0:
475 $ cat jjb/requirements.txt
476 -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder@1.4.0#egg=jenkins-job-builder
478 Installing JJB Manually
479 -----------------------
481 This section documents installing JJB from its manually cloned repository.
483 Note that `installing via pip <Installing JJB using pip_>`_ is typically simpler.
485 Checkout the version of JJB's source you'd like to build.
487 For example, using master:
491 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
493 Using a tag, like 1.4.0:
497 $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
498 $ cd jenkins-job-builder
499 $ git checkout tags/1.4.0
501 Before actually installing JJB and its dependencies, make sure you've `created
502 and activated <Virtual Environments_>`_ a virtual environment for JJB.
508 You can then use JJB's `requirements.txt <jjb-requirements.txt_>`_ file to
510 dependencies. Note that we're not using `sudo` to install as root, since we want
511 to make use of the venv we've configured for our current user.
515 # In the cloned JJB repo, with the desired version of the code checked out
516 (jjb)$ pip install -r requirements.txt
518 Then install JJB from the repo with:
524 To validate that JJB was successfully installed you can run this command:
528 (jjb)$ jenkins-jobs --version
531 Jenkins Job Templates
532 ---------------------
534 The OpenDaylight `RelEng/Builder <releng-builder-wiki_>`_ project provides
535 `jjb-templates`_ that can be used to define basic jobs.
537 The *Gerrit Trigger* listed in the jobs are keywords that can be used to
538 trigger the job to run manually by simply leaving a comment in Gerrit for the
539 patch you wish to trigger against.
541 All jobs have a default build-timeout value of 360 minutes (6 hrs) but can be
542 overrided via the opendaylight-infra-wrappers' build-timeout property.
544 TODO: Group jobs into categories: every-patch, after-merge, on-demand, etc.
545 TODO: Reiterate that "remerge" triggers all every-patch jobs at once,
546 because when only a subset of jobs is triggered, Gerrit forgets valid -1 from jobs outside the subset.
547 TODO: Document that only drafts and commit-message-only edits do not trigger every-patch jobs.
548 TODO: Document test-{project}-{feature} and test-{project}-all.
552 <table class="table table-bordered">
554 <td><b>Job Template</b><br/>{project}-distribution-check-{stream}</td>
555 <td><b>Gerrit Trigger</b><br/>recheck</td>
559 This job runs the PROJECT-distribution-check-BRANCH job which is
560 building also integration/distribution project in order to run SingleFeatureTest.
561 It also performs various other checks in order to prevent the change to break autorelease.
566 <td><b>Job Template</b><br/>{project}-integration-{stream}</td>
571 The Integration Job Template creates a job which runs when a project that your
572 project depends on is successfully built. This job type is basically the same
573 as a verify job except that it triggers from other Jenkins jobs instead of via
574 Gerrit review updates. The dependencies that triger integration jobs are listed
575 in your project.cfg file under the <b>DEPENDENCIES</b> variable.
577 If no dependencies are listed then this job type is disabled by default.
582 <td><b>Job Template</b><br/>{project}-merge-{stream}</td>
583 <td><b>Gerrit Trigger</b><br/>remerge</td>
587 This job will trigger once a Gerrit patch is merged into the repo.
588 It will build HEAD of the current project branch and also run the Maven goals
589 <b>source:jar</b> and <b>javadoc:jar</b>.
590 Artifacts are uploaded to OpenDaylight's
591 <a href="https://nexus.opendaylight.org">Nexus</a> on completion.
593 A distribution-merge-{stream} job is triggered to add the new artifacts to the
594 integration distribution.
596 Running the "remerge" trigger is possible before a Change is merged,
597 it would still build the actual HEAD. This job does not alter Gerrit votes.
602 <td><b>Job Template</b><br/>{project}-sonar</td>
603 <td><b>Gerrit Trigger</b><br/>run-sonar</td>
607 This job runs Sonar analysis and reports the results to
608 OpenDaylight's <a href="https://sonar.opendaylight.org">Sonar</a>
611 The Sonar Job Template creates a job which will run against the
612 master branch, or if BRANCHES are specified in the CFG file it will
613 create a job for the <b>First</b> branch listed.
615 <div class="admonition note">
616 <p class="first admonition-title">Note</p>
618 Running the "run-sonar" trigger will cause Jenkins to remove
619 its existing vote if it's already -1'd or +1'd a comment. You
620 will need to re-run your verify job (recheck) after running
621 this to get Jenkins to re-vote.
628 <td><b>Job Template</b><br/>{project}-validate-autorelease-{stream}</td>
629 <td><b>Gerrit Trigger</b><br/>recheck</td>
633 This job runs the PROJECT-validate-autorelease-BRANCH job which is
634 used as a quick sanity test to ensure that a patch does not depend on
635 features that do not exist in the current release.
640 <td><b>Job Template</b><br/>{project}-verify-{stream}-{maven}-{jdks}</td>
641 <td><b>Gerrit Trigger</b><br/>recheck</td>
645 The Verify job template creates a Gerrit Trigger job that will
646 trigger when a new patch is submitted to Gerrit.
647 The job only builds the project code (including unit and integration tests).
652 <td><b>Job Template</b><br/>{project}-verify-node-{stream}</td>
653 <td><b>Gerrit Trigger</b><br/>recheck</td>
657 This job template can be used by a project that is NodeJS based. It
658 simply installs a python virtualenv and uses that to install nodeenv
659 which is then used to install another virtualenv for nodejs. It then
660 calls <b>npm install</b> and <b>npm test</b> to run the unit tests.
661 When using this template you need to provide a {nodedir} and
662 {nodever} containing the directory relative to the project root
663 containing the nodejs package.json and version of node you wish to
669 <td><b>Job Template</b><br/>{project}-verify-python-{stream} | {project}-verify-tox-{stream}</td>
670 <td><b>Gerrit Trigger</b><br/>recheck</td>
674 This job template can be used by a project that uses Tox to build. It
675 simply installs a Python virtualenv and uses tox to run the tests
676 defined in the project's tox.ini file. If the tox.ini is anywhere
677 other than the project's repo root, the path to its directory
678 relative to the project's repo root should be passed as {toxdir}.
680 The 2 template names verify-python & verify-tox are identical and are
681 aliases to each other. This allows the project to use the naming that
682 is most reasonable for them.
687 <td><b>Job Template</b><br/>integration-patch-test-{stream}</td>
688 <td><b>Gerrit Trigger</b><br/>test-integration</td>
696 <td><b>Job Template</b><br/>integration-patch-test-{stream}</td>
697 <td><b>Gerrit Trigger</b><br/>test-integration</td>
701 This job builds a distribution against your Java patch and triggers distribution sanity CSIT jobs.
702 Leave a comment with trigger keyword above to activate it for a particular patch.
703 This job should not alter Gerrit votes for a given patch.
705 The list of CSIT jobs to trigger is defined in csit-list
706 <a href="https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/integration/integration-test-jobs.yaml">here</a>.
708 Some considerations when using this job:
711 The patch test verification takes some time (~2 hours) + consumes a lot of
712 resources so it is not meant to be used for every patch.
715 The system tests for master patches will fail most of the times because both
716 code and test are unstable during the release cycle (should be good by the
720 Because of the above, patch test results typically have to be interpreted by
721 system test experts. The <a href="https://wiki.opendaylight.org/view/Integration/Test">Integration/Test</a>
722 project can help with that.
731 We provide a properties which your job can take advantage of if you want to do
732 something different depending on the job type that is run. If you create a
733 profile that activates on a property listed blow. The JJB templated jobs will
734 be able to activate the profile during the build to run any custom code you
735 wish to run in your project.
739 -Dmerge : This flag is passed in our Merge job and is equivalent to the
742 -Dsonar : This flag is passed in our Sonar job and is equivalent to the
749 The `jenkins-sandbox`_ instance's purpose is to allow projects to test their JJB
750 setups before merging their code over to the RelEng master silo. It is
751 configured similarly to the master instance, although it cannot publish
752 artifacts or vote in Gerrit.
754 If your project requires access to the sandbox please open an OpenDaylight
755 Helpdesk ticket (<helpdesk@opendaylight.org>) and provide your ODL ID.
757 Notes Regarding the Sandbox
758 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
760 * Jobs are automatically deleted every Saturday at 08:00 UTC
761 * Committers can login and configure Jenkins jobs in the sandbox directly
762 (unlike with the master silo)
763 * Sandbox configuration mirrors the master silo when possible
764 * Sandbox jobs can NOT upload artifacts to Nexus
765 * Sandbox jobs can NOT vote on Gerrit
770 Make sure you have Jenkins Job Builder [properly installed](#jjb_install).
772 If you do not already have access, open an OpenDaylight Helpdesk ticket
773 (<helpdesk@opendaylight.org>) to request access to ODL's sandbox instance.
774 Integration/Test (`integration-test-wiki`_) committers have access by default.
776 JJB reads user-specific configuration from a `jenkins.ini`_. An
777 example is provided by releng/builder at `example-jenkins.ini`_.
781 # If you don't have RelEng/Builder's repo, clone it
782 $ git clone --recursive https://git.opendaylight.org/gerrit/p/releng/builder.git
783 # Make a copy of the example JJB config file (in the builder/ directory)
784 $ cp jenkins.ini.example jenkins.ini
785 # Edit jenkins.ini with your username, API token and ODL's sandbox URL
789 user=<your ODL username>
790 password=<your ODL Jenkins sandbox API token>
791 url=https://jenkins.opendaylight.org/sandbox
794 To get your API token, `login to the Jenkins **sandbox** instance
795 <jenkins-sandbox-login_>`_ (*not
796 the main master Jenkins instance, different tokens*), go to your user page (by
797 clicking on your username, for example), click "Configure" and then "Show API
803 If you `installed JJB locally into a virtual environment
804 <Installing Jenkins Job Builder_>`_,
805 you should now activate that virtual environment to access the `jenkins-jobs`
813 You'll want to work from the root of the RelEng/Builder repo, and you should
814 have your `jenkins.ini` file [properly configured](#sandbox_config).
819 It's good practice to use the `test` command to validate your JJB files before
824 jenkins-jobs --conf jenkins.ini test jjb/ <job-name>
826 If the job you'd like to test is a template with variables in its name, it
827 must be manually expanded before use. For example, the commonly used template
828 `{project}-csit-verify-1node-{functionality}` might expand to
829 `ovsdb-csit-verify-1node-netvirt`.
833 jenkins-jobs --conf jenkins.ini test jjb/ ovsdb-csit-verify-1node-netvirt
835 Successful tests output the XML description of the Jenkins job described by
836 the specified JJB job name.
841 Once you've `configured your \`jenkins.ini\` <Configuration_>`_ and `verified your
842 JJB jobs <Testing Jobs_>`_ produce valid XML descriptions of Jenkins jobs you
843 can push them to the Jenkins sandbox.
847 When pushing with `jenkins-jobs`, a log message with the number
848 of jobs you're pushing will be issued, typically to stdout.
849 **If the number is greater than 1** (or the number of jobs you
850 passed to the command to push) then you are pushing too many
851 jobs and should **`ctrl+c` to cancel the upload**. Else you will
852 flood the system with jobs.
856 INFO:jenkins_jobs.builder:Number of jobs generated: 1
858 **Failing to provide the final `<job-name>` param will push all
863 # Don't push all jobs by omitting the final param! (ctrl+c to abort)
864 jenkins-jobs --conf jenkins.ini update jjb/ <job-name>
866 Alternatively, you can push a job to the Jenkins sandbox with a special comment in a
867 releng/builder gerrit patch. The job will be based off of the code your patch is
868 based upon. Meaning, if your patch is changing something related to the job you are
869 pushing, those changes will exist in the sandbox job. The format of the comment is::
871 jjb-deploy <job name>
876 Once you have your Jenkins job configuration `pushed to the
877 Sandbox <Pushing Jobs_>`_ you can trigger it to run.
879 Find your newly-pushed job on the `Sandbox's web UI <jenkins-sandbox_>`_. Click
880 on its name to see the job's details.
882 Make sure you're `logged in <jenkins-sandbox-login_>`_ to the Sandbox.
884 Click "Build with Parameters" and then "Build".
886 Wait for your job to be scheduled and run. Click on the job number to see
887 details, including console output.
889 Make changes to your JJB configuration, re-test, re-push and re-run until
893 .. _example-jenkins.ini: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins.ini.example
894 .. _integration-test-wiki: https://wiki.opendaylight.org/view/Integration/Test
895 .. _jenkins-master: https://jenkins.opendaylight.org/releng
896 .. _jenkins-sandbox: https://jenkins.opendaylight.org/sandbox
897 .. _jenkins-sandbox-login: https://jenkins.opendaylight.org/sandbox/login
898 .. _jenkins.ini: http://docs.openstack.org/infra/jenkins-job-builder/execution.html#configuration-file
899 .. _jjb-autoupdate-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-autoupdate-project.py
900 .. _jjb-docs: http://ci.openstack.org/jenkins-job-builder/
901 .. _jjb-init-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-init-project.py
902 .. _jjb-repo: https://github.com/openstack-infra/jenkins-job-builder
903 .. _jjb-requirements.txt: https://github.com/openstack-infra/jenkins-job-builder/blob/master/requirements.txt
904 .. _jjb-templates: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jjb
905 .. _odl-jjb-requirements.txt: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/requirements.txt
906 .. _odl-nexus: https://nexus.opendaylight.org
907 .. _odl-sonar: https://sonar.opendaylight.org
908 .. _python-virtualenv: https://virtualenv.readthedocs.org/en/latest/
909 .. _python-virtualenvwrapper: https://virtualenvwrapper.readthedocs.org/en/latest/
910 .. _releng-wiki: https://wiki.opendaylight.org/view/RelEng:Main
911 .. _releng-builder-gerrit: https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder
912 .. _releng-builder-repo: https://git.opendaylight.org/gerrit/gitweb?p=releng%2Fbuilder.git;a=summary
913 .. _releng-global-jjb: https://gerrit.linuxfoundation.org/infra/#/q/project:releng/global-jjb
914 .. _releng-builder-wiki: https://wiki.opendaylight.org/view/RelEng/Builder
915 .. _streams-design-background: https://lists.opendaylight.org/pipermail/release/2015-July/003139.html
916 .. _spinup-scripts: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jenkins-scripts
917 .. _spinup-scripts-basic_settings.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/basic_settings.sh
918 .. _spinup-scripts-controller.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/controller.sh