.. code-block:: yaml
+ ---
- project:
name: <NEW_PROJECT>-carbon
jobs:
- - '{project-name}-clm-{stream}'
- - '{project-name}-distribution-{stream}'
- - '{project-name}-integration-{stream}'
- - '{project-name}-merge-{stream}'
- - '{project-name}-periodic-{stream}'
- - '{project-name}-verify-{stream}-{maven}-{jdks}'
+ - '{project-name}-clm-{stream}'
+ - '{project-name}-integration-{stream}'
+ - '{project-name}-merge-{stream}'
+ - '{project-name}-verify-{stream}-{maven}-{jdks}'
project: '<NEW_PROJECT>'
project-name: '<NEW_PROJECT>'
branch: 'master'
jdk: openjdk8
jdks:
- - openjdk8
+ - openjdk8
maven:
- - mvn33:
- mvn-version: '{mvn33}'
+ - mvn33:
+ mvn-version: 'mvn33'
mvn-settings: '<NEW_PROJECT>-settings'
mvn-goals: 'clean install -Dmaven.repo.local=/tmp/r -Dorg.ops4j.pax.url.mvn.localRepository=/tmp/r'
mvn-opts: '-Xmx1024m -XX:MaxPermSize=256m'
- project:
name: <NEW_PROJECT>-sonar
jobs:
- - '{project-name}-sonar'
+ - '{project-name}-sonar'
project: '<NEW_PROJECT>'
project-name: '<NEW_PROJECT>'
Replace all instances of <new-project> with the name of your project. This will
create the jobs with the default job types we recommend for Java projects. If
your project is participating in the simultanious-release and ultimately will
-be included in the final distribution. We recommend adding the following job
+be included in the final distribution, it is required to add the following job
types into the job list for the release you are participating.
The Jenkins jobs are run on build minions (executors) which are created on an
as-needed basis. If no idle build minions are available a new VM is brought
up. This process can take up to 2 minutes. Once the build minion has finished a
-job, it will remain online for 45 minutes before shutting down. Subsequent
-jobs will use an idle build minion if available.
+job, it will be destroyed.
Our Jenkins master supports many types of dynamic build minions. If you are
creating custom jobs then you will need to have an idea of what type of minions
If your project needs something added to one of the minions, you can help us
get things added faster by doing one of the following:
-* Submit a patch to RelEng/Builder for the `packer/provision`_ scripts that
- configures your new piece of software during minion boot up.
+* Submit a patch to RelEng/Builder for the appropriate `jenkins-scripts`
+ definition which configure software during minion boot up.
+* Submit a patch to RelEng/Builder for the `packer/provision` scripts that
+ configures software during minion instance imaging.
* Submit a patch to RelEng/Builder for the Packer's templates in
- the `packer/templates`_ directory that configures your new piece of
- software which get baked into the image.
+ the `packer/templates` directory that configures a new instance definition
+ along with changes in `packer/provision`.
Going the first route will be faster in the short term as we can inspect the
changes and make test modifications in the sandbox to verify that it works.
The first route may add additional setup time considering this is run every
time the minion is booted.
-The second route, however, is better for the community as a whole as it will
-allow others to utilize our Packer setups to replicate our systems more
+The second and third routes, however, is better for the community as a whole as
+it will allow others to utilize our Packer setups to replicate our systems more
closely. It is, however, more time consuming as an image snapshot needs to be
-created based on the updated Packer definitions before it can be attached to
-the Jenkins configuration on sandbox for validation testing.
+created based on the updated Packer definitions before it can be attached to the
+Jenkins configuration on sandbox for validation testing.
In either case, the changes must be validated in the sandbox with tests to
make sure that we don't break current jobs and that the new software features
are operating as intended. Once this is done the changes will be merged and
the updates applied to the RelEng Jenkins production silo. Any changes to
-files under `releng/builder/packer`_ will be validated and images would be built
+files under `releng/builder/packer` will be validated and images would be built
triggered by verify-packer and merge-packer jobs.
Please note that the combination of a Packer definitions from `vars`, `templates`
and the `provision` scripts is what defines a given minion. For instance, a minion
-may be defined as `centos7-java-builder`_ which is a combination of Packer OS image
-definitions from `vars/centos.json`_, Packer template definitions from
-`templates/java-buidler.json` and spinup scripts from `provision/java-builder.sh`_.
+may be defined as `centos7-java-builder` which is a combination of Packer OS image
+definitions from `vars/centos.json`, Packer template definitions from
+`templates/java-buidler.json` and spinup scripts from `provision/java-builder.sh`.
This combination provides the full definition of the realized minion.
Jenkins starts a minion using the latest image which is built and linked into the
Jenkins configuration. Once the base instance is online Jenkins checks out the
RelEng/Builder repo on it and executes two scripts. The first is
-`provision/baseline.sh`_, which is a baseline for all of the minions.
+`provision/baseline.sh`, which is a baseline for all of the minions.
The second is the specialized script, which handles any system updates,
new software installs or extra environment tweaks that don't make sense in a
handling jobs on it.
Pool: ODLRPC
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^
.. raw:: html
<table class="table table-bordered">
<tr class="warning">
- <td><b>Jenkins Label</b><br/> dynamic_verify</td>
- <td><b>Minion Template name</b><br/> centos7-builder</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-builder</td>
- <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/builder.sh</td>
+ <td><b>Jenkins Labels</b><br/> centos7-java-builder-2c-4g,
+ centos7-java-builder-2c-8g, centos7-java-builder-4c-8g,
+ centos7-java-builder-8c-8g, centos7-java-builder-4c-16g</td>
+ <td><b>Minion Template names</b><br/> centos7-java-builder-2c-4g,
+ centos7-java-builder-2c-4g, centos7-java-builder-2c-8g,
+ centos7-java-builder-4c-8g, centos7-java-builder-8c-8g,
+ centos7-java-builder-4c-16g</td>
+ <td><b>Packer Template</b><br/>
+ releng/builder/packer/templates/java-builder.json</td>
+ <td><b>Spinup Script</b><br/>
+ releng/builder/jenkins-scripts/builder.sh</td>
</tr>
<tr>
<td colspan="4">
- A CentOS 7 huild minion. This system has OpenJDK 1.7 (Java7) and OpenJDK
+ A CentOS 7 build minion. This system has OpenJDK 1.7 (Java7) and OpenJDK
1.8 (Java8) installed on it along with all the other components and
libraries needed for building any current OpenDaylight project. This is
- the label that is used for all basic -verify and -daily- builds for
+ the label that is used for all basic verify, merge and daily builds for
projects.
</td>
</tr>
<tr class="warning">
- <td><b>Jenkins Label</b><br/> dynamic_merge</td>
- <td><b>Minion Template name</b><br/> centos7-builder</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-builder</td>
- <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/builder.sh</td>
- </tr>
- <tr>
- <td colspan="4">
- See dynamic_verify (same image on the back side). This is the label that
- is used for all basic -merge and -integration- builds for projects.
- </td>
- </tr>
-
- <tr class="warning">
- <td><b>Jenkins Label</b><br/> matrix_master</td>
- <td><b>Minion Template name</b><br/> centos7-matrix</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-java-node</td>
- <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/matrix.sh</td>
- </tr>
- <tr>
- <td colspan="4">
- This is a very minimal system that is designed to spin up with 2 build
- instances on it. The purpose is to have a location that is not the
- Jenkins master itself for jobs that are executing matrix operations
- since they need a director location. This image should not be used for
- anything but tying matrix jobs before the matrx defined label ties.
- </td>
- </tr>
-
- <tr class="warning">
- <td><b>Jenkins Label</b><br/> dynamic_robot</td>
- <td><b>Minion Template name</b><br/> centos7-robot</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/integration-robotframework</td>
+ <td><b>Jenkins Labels</b><br/> centos7-robot-2c-2g</td>
+ <td><b>Minion Template names</b><br/> centos7-robot-2c-2g</td>
+ <td><b>Packer Template</b><br/>
+ releng/builder/packer/templates/robot.json</td>
<td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/robot.sh</td>
</tr>
<tr>
</tr>
<tr class="warning">
- <td><b>Jenkins Label</b><br/> ubuntu_mininet</td>
- <td><b>Minion Template name</b><br/> ubuntu-trusty-mininet</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ubuntu-mininet</td>
+ <td><b>Jenkins Labels</b><br/> ubuntu-trusty-mininet-2c-2g</td>
+ <td><b>Minion Template names</b><br/> ubuntu-trusty-mininet-2c-2g</td>
+ <td><b>Packer Template</b><br/>
+ releng/builder/packer/teamplates/mininet.json</td>
<td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
</tr>
<tr>
</tr>
<tr class="warning">
- <td><b>Jenkins Label</b><br/> ubuntu_mininet_ovs_23</td>
- <td><b>Minion Template name</b><br/> ubuntu-trusty-mininet-ovs-23</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ubuntu-mininet-ovs-23</td>
+ <td><b>Jenkins Labels</b><br/> ubuntu-trusty-mininet-ovs-23-2c-2g</td>
+ <td><b>Minion Template names</b><br/> ubuntu-trusty-mininet-ovs-23-2c-2g</td>
+ <td><b>Packer Template</b><br/> releng/builder/packer/templates/mininet-ovs-2.3.json</td>
<td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
</tr>
<tr>
</tr>
<tr class="warning">
- <td><b>Jenkins Label</b><br/> ubuntu_mininet_ovs_25</td>
- <td><b>Minion Template name</b><br/> ubuntu-trusty-mininet-ovs-25</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ubuntu-mininet-ovs-25</td>
+ <td><b>Jenkins Labels</b><br/> ubuntu-trusty-mininet-ovs-25-2c-2g</td>
+ <td><b>Minion Template names</b><br/> ubuntu-trusty-mininet-ovs-25-2c-2g</td>
+ <td><b>Packer Template</b><br/> releng/builder/packer/templates/mininet-ovs-2.5.json</td>
<td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
</tr>
<tr>
</tr>
<tr class="warning">
- <td><b>Jenkins Label</b><br/> dynamic_controller</td>
- <td><b>Minion Template name</b><br/> centos7-java</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-java-node</td>
- <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/controller.sh</td>
- </tr>
- <tr>
- <td colspan="4">
- A CentOS 7 minion that has the basic OpenJDK 1.7 (Java7) and OpenJDK
- 1.8 (Java8) installed and is capable of running the controller, not
- building.
- </td>
- </tr>
-
- <tr class="warning">
- <td><b>Jenkins Label</b><br/> dynamic_java</td>
- <td><b>Minion Template name</b><br/> centos7-java</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-java-node</td>
- <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/controller.sh</td>
- </tr>
- <tr>
- <td colspan="4">
- See dynamic_controller as it is currently the same image.
- </td>
- </tr>
-
- <tr class="warning">
- <td><b>Jenkins Label</b><br/> dynamic_java_8g</td>
- <td><b>Minion Template name</b><br/> centos7-java-8g</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-java-node</td>
- <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/controller.sh</td>
- </tr>
- <tr>
- <td colspan="4">
- See dynamic_controller as it is currently the same image but with 8G of RAM.
- </td>
- </tr>
-
- <tr class="warning">
- <td><b>Jenkins Label</b><br/> dynamic_devstack</td>
- <td><b>Minion Template name</b><br/> centos7-devstack</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ovsdb-devstack</td>
+ <td><b>Jenkins Labels</b><br/> centos7-devstack-2c-4g</td>
+ <td><b>Minion Template names</b><br/> centos7-devstack-2c-4g</td>
+ <td><b>Packer Template</b><br/> releng/builder/packer/templates/devstack.json</td>
<td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/devstack.sh</td>
</tr>
<tr>
</tr>
<tr class="warning">
- <td><b>Jenkins Label</b><br/> dynamic_docker</td>
- <td><b>Minion Template name</b><br/> centos7-docker</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ovsdb-docker</td>
+ <td><b>Jenkins Labels</b><br/> centos7-docker-2c-4g</td>
+ <td><b>Minion Template names</b><br/> centos7-docker-2c-4g</td>
+ <td><b>Packer Template</b><br/> releng/builder/packer/templates/docker.json</td>
<td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/docker.sh</td>
</tr>
<tr>
</tr>
<tr class="warning">
- <td><b>Jenkins Label</b><br/> gbp_trusty</td>
- <td><b>Minion Template name</b><br/> gbp_trusty</td>
- <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/gbp-ubuntu-docker-ovs-node</td>
+ <td><b>Jenkins Labels</b><br/> ubuntu-trusty-gbp-2c-2g</td>
+ <td><b>Minion Template names</b><br/> ubuntu-trusty-gbp-2c-2g</td>
+ <td><b>Packer Template</b><br/> releng/builder/packer/templates/gbp.json</td>
<td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/ubuntu-docker-ovs.sh</td>
</tr>
<tr>
</tr>
</table>
+Pool: ODLPUB - HOT (Heat Orchestration Templates)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+HOT integration enables to spin up integration labs servers for CSIT jobs
+using heat, rathar than using jclouds (deprecated). Image names are updated
+on the project specific job templates using the variable
+`{odl,docker,openstack,tools}_system_image` followed by image name in the
+format `<platform> - <template> - <date-stamp>`.
+
+.. code-block:: yaml
+
+ CentOS 7 - docker - 20161031-0802
+
+.. include:: cloud-images.rst
+
Creating Jenkins Jobs
---------------------
(jjb)$ jenkins-jobs --version
+TODO: Explain that only the currently merged jjb/requirements.txt is supported,
+other options described below are for troubleshooting only.
+
To change the version of JJB specified by `builder/jjb/requirements.txt
<odl-jjb-requirements.txt_>`_
to install from the latest commit to the master branch of JJB's git repository:
All jobs have a default build-timeout value of 360 minutes (6 hrs) but can be
overrided via the opendaylight-infra-wrappers' build-timeout property.
+TODO: Group jobs into categories: every-patch, after-merge, on-demand, etc.
+TODO: Reiterate that "remerge" triggers all every-patch jobs at once,
+because when only a subset of jobs is triggered, Gerrit forgets valid -1 from jobs outside the subset.
+TODO: Document that only drafts and commit-message-only edits do not trigger every-patch jobs.
+TODO: Document test-{project}-{feature} and test-{project}-all.
+
.. raw:: html
<table class="table table-bordered">
<tr class="warning">
- <td><b>Job Template</b><br/>{project}-distribution-{stream}</td>
- <td><b>Gerrit Trigger</b><br/>test-distribution</td>
+ <td><b>Job Template</b><br/>{project}-distribution-check-{stream}</td>
+ <td><b>Gerrit Trigger</b><br/>recheck</td>
</tr>
<tr>
<td colspan="2">
- This job builds a distrbution against your patch, passes distribution sanity test
- and reports back the results to Gerrit. Leave a comment with trigger keyword above
- to activate it for a particular patch.
-
- This job is maintained by the <a href="https://wiki.opendaylight.org/view/Integration/Test">Integration/Test</a>
- project.
-
- <div class="admonition note">
- <p class="first admonition-title">Note</p>
- <p>
- Running the "test-distribution" trigger will cause Jenkins to
- remove it's existing vote if it's already -1 or +1'd a comment.
- You will need to re-run your verify job (recheck) after running
- this to get Jenkins to put back the correct vote.
- </p>
- </div>
+ This job runs the PROJECT-distribution-check-BRANCH job which is
+ building also integration/distribution project in order to run SingleFeatureTest.
+ It also performs various other checks in order to prevent the change to break autorelease.
</td>
</tr>
</tr>
<tr>
<td colspan="2">
- The Merge job template is similar to the Verify Job Template except
- it will trigger once a Gerrit patch is merged into the repo. It
- also automatically runs the Maven goals <b>source:jar</b> and
- <b>javadoc:jar</b>.
-
- This job will upload artifacts to OpenDaylight's
+ This job will trigger once a Gerrit patch is merged into the repo.
+ It will build HEAD of the current project branch and also run the Maven goals
+ <b>source:jar</b> and <b>javadoc:jar</b>.
+ Artifacts are uploaded to OpenDaylight's
<a href="https://nexus.opendaylight.org">Nexus</a> on completion.
+
+ A distribution-merge-{stream} job is triggered to add the new artifacts to the
+ integration distribution.
+
+ Running the "remerge" trigger is possible before a Change is merged,
+ it would still build the actual HEAD. This job does not alter Gerrit votes.
</td>
</tr>
<tr class="warning">
<td><b>Job Template</b><br/>{project}-validate-autorelease-{stream}</td>
- <td><b>Gerrit Trigger</b><br/>recheck | reverify</td>
+ <td><b>Gerrit Trigger</b><br/>recheck</td>
</tr>
<tr>
<td colspan="2">
This job runs the PROJECT-validate-autorelease-BRANCH job which is
used as a quick sanity test to ensure that a patch does not depend on
features that do not exist in the current release.
-
- The <b>revalidate</b> trigger is useful in cases where a project's
- verify job passed however validate failed due to infra problems or
- intermittent issues. It will retrigger just the validate-autorelease
- job.
</td>
</tr>
<tr class="warning">
<td><b>Job Template</b><br/>{project}-verify-{stream}-{maven}-{jdks}</td>
- <td><b>Gerrit Trigger</b><br/>recheck | reverify</td>
+ <td><b>Gerrit Trigger</b><br/>recheck</td>
</tr>
<tr>
<td colspan="2">
- The Verify job template creates a Gerrit Trigger job that will
- trigger when a new patch is submitted to Gerrit.
+ The Verify job template creates a Gerrit Trigger job that will
+ trigger when a new patch is submitted to Gerrit.
+ The job only builds the project code (including unit and integration tests).
</td>
</tr>
<tr class="warning">
<td><b>Job Template</b><br/>{project}-verify-node-{stream}</td>
- <td><b>Gerrit Trigger</b><br/>recheck | reverify</td>
+ <td><b>Gerrit Trigger</b><br/>recheck</td>
</tr>
<tr>
<td colspan="2">
</tr>
<tr class="warning">
- <td><b>Job Template</b><br/>{project}-verify-python-{stream}</td>
- <td><b>Gerrit Trigger</b><br/>recheck | reverify</td>
+ <td><b>Job Template</b><br/>{project}-verify-python-{stream} | {project}-verify-tox-{stream}</td>
+ <td><b>Gerrit Trigger</b><br/>recheck</td>
</tr>
<tr>
<td colspan="2">
- This job template can be used by a project that contains Python. It
+ This job template can be used by a project that uses Tox to build. It
simply installs a Python virtualenv and uses tox to run the tests
defined in the project's tox.ini file. If the tox.ini is anywhere
other than the project's repo root, the path to its directory
relative to the project's repo root should be passed as {toxdir}.
+
+ The 2 template names verify-python & verify-tox are identical and are
+ aliases to each other. This allows the project to use the naming that
+ is most reasonable for them.
</td>
</tr>
</tr>
<tr>
<td colspan="2">
- This job runs a full integration test suite against your patch and
- reports back the results to Gerrit. Leave a comment with trigger
- keyword above to activate it for a particular patch.
-
- It then spawns the list of jobs in csit-list defined
- <a href="https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/integration/integration-test-jobs.yaml">here</a>.
+ </td>
+ </tr>
- This job is maintained by the <a href="https://wiki.opendaylight.org/view/Integration/Test">Integration/Test</a>
- project.
+ <tr class="warning">
+ <td><b>Job Template</b><br/>integration-patch-test-{stream}</td>
+ <td><b>Gerrit Trigger</b><br/>test-integration</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ This job builds a distribution against your Java patch and triggers distribution sanity CSIT jobs.
+ Leave a comment with trigger keyword above to activate it for a particular patch.
+ This job should not alter Gerrit votes for a given patch.
- <div class="admonition note">
- <p class="first admonition-title">Note</p>
- <p>
- Running the "test-integration" trigger will cause Jenkins to remove
- it's existing vote if it's already -1 or +1'd a comment. You will need
- to re-run your verify job (recheck) after running this to get Jenkins
- to put back the correct vote.
- </p>
- </div>
+ The list of CSIT jobs to trigger is defined in csit-list
+ <a href="https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/integration/integration-test-jobs.yaml">here</a>.
Some considerations when using this job:
<ul>
.. _spinup-scripts: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jenkins-scripts
.. _spinup-scripts-basic_settings.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/basic_settings.sh
.. _spinup-scripts-controller.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/controller.sh
-.. _vagrant-basic-java-node: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=vagrant/basic-java-node
-.. _vagrant-definitions: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=vagrant
Code Review / releng / builder.git / blobdiff