Jenkins
=======

The `Release Engineering Project <releng-wiki_>`_ consolidates the Jenkins jobs from
project-specific VMs to a single Jenkins server. Each OpenDaylight project
has a tab for their jobs on the `jenkins-master`_. The system utilizes
`Jenkins Job Builder <jjb-docs_>`_ for the creation and management of the
Jenkins jobs.

Sections:

.. contents::
   :depth: 3
   :local:

New Project Quick Start
-----------------------

This section attempts to provide details on how to get going as a new project
quickly with minimal steps. The rest of the guide should be read and understood
by those who need to create and contribute new job types that is not already
covered by the existing job templates provided by OpenDaylight's JJB repo.

As a new project you will be mainly interested in getting your jobs to appear
in the jenkins-master_ silo and this can be achieved by simply creating a
<project>.yaml in the releng/builder project's jjb directory.

.. code-block:: bash

    git clone https://git.opendaylight.org/gerrit/releng/builder
    cd builder
    mkdir jjb/<new-project>

Where <new-project> should be the same name as your project's git repo in
Gerrit. So if your project is called "aaa" then create a new jjb/aaa directory.

Next we will create <new-project>.yaml as follows:

.. 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: '<NEW_PROJECT>'
        project-name: '<NEW_PROJECT>'
        stream: carbon
        branch: 'master'
        jdk: openjdk8
        jdks:
            - openjdk8
        maven:
            - 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'
        dependencies: 'odlparent-merge-{stream},yangtools-merge-{stream},controller-merge-{stream}'
        email-upstream: '[<NEW_PROJECT>] [odlparent] [yangtools] [controller]'
        archive-artifacts: ''

    - project:
        name: <NEW_PROJECT>-sonar
        jobs:
            - '{project-name}-sonar'

        project: '<NEW_PROJECT>'
        project-name: '<NEW_PROJECT>'
        branch: 'master'
        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'

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
types into the job list for the release you are participating.


.. code-block:: yaml

    - '{project-name}-distribution-check-{stream}'
    - '{project-name}-validate-autorelease-{stream}'

If you'd like to explore the additional tweaking options available
please refer to the `Jenkins Job Templates`_ section.

Finally we need to push these files to Gerrit for review by the releng/builder
team to push your jobs to Jenkins.

.. code-block:: bash

    git add jjb/<new-project>
    git commit -sm "Add <new-project> jobs to Jenkins"
    git review

This will push the jobs to Gerrit and your jobs will appear in Jenkins once the
releng/builder team has reviewed and merged your patch.

Jenkins Master
--------------

The `jenkins-master`_ is the home for all project's Jenkins jobs. All
maintenance and configuration of these jobs must be done via JJB through the
`releng-builder-repo`_. Project contributors can no longer edit the Jenkins jobs
directly on the server.

Build Minions
-------------

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.

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
are available. The following are the current minion types and descriptions.
Minion Template Names are needed for jobs that take advantage of multiple
minions as they must be specifically called out by template name instead of
label.

Adding New Components to the 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 Packer's templates  in
  the `packer/templates`_ directory that configures your new piece of
  software which get baked into the image.

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.

.. note::

   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
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.

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
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`_.
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.

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
snapshot. Examples could include installing new package or setting up a virtual
environment. Its imperative to ensure modifications to these spinup scripts have
considered time taken to install the packages, as this could increase the build
time for every job which runs on the image. After all of these scripts have
executed Jenkins will finally attach the minion as an actual minion and start
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>
      </tr>
      <tr>
        <td colspan="4">
          A CentOS 7 huild 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
          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>Spinup Script</b><br/> releng/builder/jenkins-scripts/robot.sh</td>
      </tr>
      <tr>
        <td colspan="4">
          A CentOS 7 minion that is configured with OpenJDK 1.7 (Java7), OpenJDK
          1.8 (Java8) and all the current packages used by the integration
          project for doing robot driven jobs. If you are executing robot
          framework jobs then your job should be using this as the minion that
          you are tied to. This image does not contain the needed libraries for
          building components of OpenDaylight, only for executing robot tests.
        </td>
      </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>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
      </tr>
      <tr>
        <td colspan="4">
          Basic Ubuntu system with ovs 2.0.2 and mininet 2.1.0
        </td>
      </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>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
      </tr>
      <tr>
        <td colspan="4">
          Basic Ubuntu system with ovs 2.3 and mininet 2.2.1
        </td>
      </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>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
      </tr>
      <tr>
        <td colspan="4">
          Basic Ubuntu system with ovs 2.5 and mininet 2.2.2
        </td>
      </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>Spinup Script</b><br/> releng/builder/jenkins-scripts/devstack.sh</td>
      </tr>
      <tr>
        <td colspan="4">
          A CentOS 7 system purpose built for doing OpenStack testing using
          DevStack. This minion is primarily targeted at the needs of the OVSDB
          project. It has OpenJDK 1.7 (aka Java7) and OpenJDK 1.8 (Java8) and
          other basic DevStack related bits installed.
        </td>
      </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>Spinup Script</b><br/> releng/builder/jenkins-scripts/docker.sh</td>
      </tr>
      <tr>
        <td colspan="4">
          A CentOS 7 system that is configured with OpenJDK 1.7 (aka Java7),
          OpenJDK 1.8 (Java8) and Docker. This system was originally custom
          built for the test needs of the OVSDB project but other projects have
          expressed interest in using it.
        </td>
      </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>Spinup Script</b><br/> releng/builder/jenkins-scripts/ubuntu-docker-ovs.sh</td>
      </tr>
      <tr>
        <td colspan="4">
          A basic Ubuntu node with latest OVS and docker installed. Used by Group Based Policy.
        </td>
      </tr>
    </table>

Creating Jenkins Jobs
---------------------

Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format
and uses them to configure Jenkins.

* `Jenkins Job Builder (JJB) documentation <jjb-docs_>`_
* `RelEng/Builder Gerrit <releng-builder-gerrit_>`_
* `RelEng/Builder Git repository <releng-builder-repo_>`_

Getting Jenkins Job Builder
---------------------------

OpenDaylight uses Jenkins Job Builder to translate our in-repo YAML job
configuration into job descriptions suitable for consumption by Jenkins.
When testing new Jenkins Jobs in the `Jenkins Sandbox`_, you'll
need to use the `jenkins-jobs` executable to translate a set of jobs into
their XML descriptions and upload them to the sandbox Jenkins server.

We document `installing <Installing Jenkins Job Builder_>`_ `jenkins-jobs`
below. We also provide
a `pre-built Docker image <jjb-docker_>`_ with `jenkins-jobs` already installed.

Installing Jenkins Job Builder
------------------------------

For users who aren't already experienced with Docker or otherwise don't want
to use our `pre-built JJB Docker image <jjb-docker_>`_, installing JJB into a
virtual environment is an equally good option.

We recommend using `pip <Installing JJB using pip_>`_ to assist with JJB
installs, but we
also document `installing from a git repository manually
<Installing JJB Manually_>`_.
For both, we recommend using Python `Virtual Environments`_
to isolate JJB and its dependencies.

The `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file contains the currently
recommended JJB version. Because JJB is fairly unstable, it may be necessary
to debug things by installing different versions. This is documented for both
`pip-assisted <Installing JJB using pip_>`_ and `manual
<Installing JJB Manually_>`_ installs.

Virtual Environments
--------------------

For both `pip-assisted <Installing JJB using pip_>`_ and `manual
<Installing JJB Manually_>`_ JJB
installs, we recommend using `Python Virtual Environments <python-virtualenv_>`_
to manage JJB and its
Python dependencies. The `python-virtualenvwrapper`_ tool can help you do so.

There are good docs for installing `python-virtualenvwrapper`_. On Linux systems
with pip (typical), they amount to:

.. code-block:: bash

    sudo pip install virtualenvwrapper

A virtual environment is simply a directory that you install Python programs
into and then append to the front of your path, causing those copies to be
found before any system-wide versions.

Create a new virtual environment for JJB.

.. code-block:: bash

    # Virtaulenvwrapper uses this dir for virtual environments
    $ echo $WORKON_HOME
    /home/daniel/.virtualenvs
    # Make a new virtual environment
    $ mkvirtualenv jjb
    # A new venv dir was created
    (jjb)$ ls -rc $WORKON_HOME | tail -n 1
    jjb
    # The new venv was added to the front of this shell's path
    (jjb)$ echo $PATH
    /home/daniel/.virtualenvs/jjb/bin:<my normal path>
    # Software installed to venv, like pip, is found before system-wide copies
    (jjb)$ command -v pip
    /home/daniel/.virtualenvs/jjb/bin/pip

With your virtual environment active, you should install JJB. Your install will
be isolated to that virtual environment's directory and only visible when the
virtual environment is active.

You can easily leave and return to your venv. Make sure you activate it before
each use of JJB.

.. code-block:: bash

    (jjb)$ deactivate
    $ command -v jenkins-jobs
    # No jenkins-jobs executable found
    $ workon jjb
    (jjb)$ command -v jenkins-jobs
    $WORKON_HOME/jjb/bin/jenkins-jobs

Installing JJB using pip
------------------------

The recommended way to install JJB is via pip.

First, clone the latest version of the `releng-builder-repo`_.

.. code-block:: bash

    $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git

Before actually installing JJB and its dependencies, make sure you've `created
and activated <Virtual Environments_>`_ a virtual environment for JJB.

.. code-block:: bash

    $ mkvirtualenv jjb

The recommended version of JJB to install is the version specified in the
`builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file.

.. code-block:: bash

    # From the root of the releng/builder repo
    (jjb)$ pip install -r jjb/requirements.txt

To validate that JJB was successfully installed you can run this command:

.. code-block:: bash

    (jjb)$ jenkins-jobs --version

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:

.. code-block:: bash

    $ cat jjb/requirements.txt
    -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder#egg=jenkins-job-builder

To install from a tag, like 1.4.0:

.. code-block:: bash

    $ cat jjb/requirements.txt
    -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder@1.4.0#egg=jenkins-job-builder

Installing JJB Manually
-----------------------

This section documents installing JJB from its manually cloned repository.

Note that `installing via pip <Installing JJB using pip_>`_ is typically simpler.

Checkout the version of JJB's source you'd like to build.

For example, using master:

.. code-block:: bash

    $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder

Using a tag, like 1.4.0:

.. code-block:: bash

    $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
    $ cd jenkins-job-builder
    $ git checkout tags/1.4.0

Before actually installing JJB and its dependencies, make sure you've `created
and activated <Virtual Environments_>`_ a virtual environment for JJB.

.. code-block:: bash

    $ mkvirtualenv jjb

You can then use JJB's `requirements.txt <jjb-requirements.txt_>`_ file to
install its
dependencies. Note that we're not using `sudo` to install as root, since we want
to make use of the venv we've configured for our current user.

.. code-block:: bash

    # In the cloned JJB repo, with the desired version of the code checked out
    (jjb)$ pip install -r requirements.txt

Then install JJB from the repo with:

.. code-block:: bash

    (jjb)$ pip install .

To validate that JJB was successfully installed you can run this command:

.. code-block:: bash

    (jjb)$ jenkins-jobs --version

JJB Docker Image
----------------

`Docker <docker-docs_>`_ is an open platform used to create virtualized Linux containers
for shipping self-contained applications. Docker leverages LinuX Containers
\(LXC\) running on the same operating system as the host machine, whereas a
traditional VM runs an operating system over the host.

.. code-block:: bash

    docker pull zxiiro/jjb-docker
    docker run --rm -v ${PWD}:/jjb jjb-docker

This `Dockerfile <jjb-dockerfile_>`_ created the
`zxiiro/jjb-docker image <jjb-docker_>`_.
By default it will run:

.. code-block:: bash

    jenkins-jobs test .

You'll need to use the `-v/--volume=[]` parameter to mount a directory
containing your YAML files, as well as a configured `jenkins.ini` file if you
wish to upload your jobs to the `Jenkins Sandbox`_.

Jenkins Job Templates
---------------------

The OpenDaylight `RelEng/Builder <releng-builder-wiki_>`_ project provides
`jjb-templates`_ that can be used to define basic jobs.

The *Gerrit Trigger* listed in the jobs are keywords that can be used to
trigger the job to run manually by simply leaving a comment in Gerrit for the
patch you wish to trigger against.

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.

.. 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>
      </tr>
      <tr>
        <td colspan="2">
          This job builds a distrbution against your patch, tiggers distribution sanity CSIT jobs
          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 jobs (recheck) after running
              this to get Jenkins to put back the correct vote.
            </p>
          </div>
        </td>
      </tr>

      <tr class="warning">
        <td><b>Job Template</b><br/>{project}-distribution-check-{stream}</td>
        <td><b>Gerrit Trigger</b><br/>recheck | redistcheck</td>
      </tr>
      <tr>
        <td colspan="2">
          This job runs the PROJECT-distribution-check-BRANCH job which is
          building also integration/distribution project in order to run SingleFeatureTest.

          The <b>redistcheck</b> trigger is useful in cases where a project's
          other jobs passed, however this job failed due to infra problems or
          intermittent issues. It will retrigger just this job to save time.

          BEWARE: If there were other failed jobs, redistcheck could lead
          to false Verified+1 vote, risking a merge which breaks other projetcs.
          Redistcheck is only for committers who are familiar with the risks involved.
          If in doubt, use the safe trigger word: recheck.
          Recheck triggers every job involved in verifying latest patch set in the Change.
        </td>
      </tr>

      <tr class="warning">
        <td><b>Job Template</b><br/>{project}-integration-{stream}</td>
        <td></td>
      </tr>
      <tr>
        <td colspan="2">
          The Integration Job Template creates a job which runs when a project that your
          project depends on is successfully built. This job type is basically the same
          as a verify job except that it triggers from other Jenkins jobs instead of via
          Gerrit review updates. The dependencies that triger integration jobs are listed
          in your project.cfg file under the <b>DEPENDENCIES</b> variable.

          If no dependencies are listed then this job type is disabled by default.
        </td>
      </tr>

      <tr class="warning">
        <td><b>Job Template</b><br/>{project}-merge-{stream}</td>
        <td><b>Gerrit Trigger</b><br/>remerge</td>
      </tr>
      <tr>
        <td colspan="2">
          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.

          Running the "remerge" trigger is possible before a Change is merged,
          in which case it 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 jobs (recheck) after running
          this to get Jenkins to put back the correct vote.
        </td>
      </tr>

      <tr class="warning">
        <td><b>Job Template</b><br/>{project}-sonar</td>
        <td><b>Gerrit Trigger</b><br/>run-sonar</td>
      </tr>
      <tr>
        <td colspan="2">
          This job runs Sonar analysis and reports the results to
          OpenDaylight's <a href="https://sonar.opendaylight.org">Sonar</a>
          dashboard.

          The Sonar Job Template creates a job which will run against the
          master branch, or if BRANCHES are specified in the CFG file it will
          create a job for the <b>First</b> branch listed.

          <div class="admonition note">
            <p class="first admonition-title">Note</p>
            <p>
              Running the "run-sonar" trigger will cause Jenkins to remove
              its existing vote if it's already -1'd or +1'd a comment. You
              will need to re-run your verify job (recheck) after running
              this to get Jenkins to re-vote.
            </p>
          </div>
        </td>
      </tr>

      <tr class="warning">
        <td><b>Job Template</b><br/>{project}-validate-autorelease-{stream}</td>
        <td><b>Gerrit Trigger</b><br/>recheck | revalidate</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
          other job passed, however this job failed due to infra problems or
          intermittent issues. It will retrigger just this job to save time.

          BEWARE: If there were other failed jobs, revalidate could lead
          to false Verified+1 vote, risking a merge which breaks other projetcs.
          Revalidate is only for committers who are familiar with the risks involved.
          If in doubt, use the safe trigger word: recheck.
        </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>
      </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 job only builds the project code (including unit and integration tests).

          The <b>reverify</b> trigger is useful in cases where a project's
          other jobs passed however this job failed due to infra problems or
          intermittent issues. It will retrigger just this job to save time.

          BEWARE: If there were other failed jobs, reverify could lead
          to false Verified+1 vote, risking a merge which breaks other projetcs.
          Reverify is only for committers who are familiar with the risks involved.
          If in doubt, use the safe trigger word: recheck.
          Recheck triggers every job involved in verifying latest patch set in the Change.
        </td>
      </tr>

      <tr class="warning">
        <td><b>Job Template</b><br/>{project}-verify-node-{stream}</td>
        <td><b>Gerrit Trigger</b><br/>recheck | renode</td>
      </tr>
      <tr>
        <td colspan="2">
          This job template can be used by a project that is NodeJS based. It
          simply installs a python virtualenv and uses that to install nodeenv
          which is then used to install another virtualenv for nodejs. It then
          calls <b>npm install</b> and <b>npm test</b> to run the unit tests.
          When  using this template you need to provide a {nodedir} and
          {nodever} containing the directory relative to the project root
          containing the nodejs package.json and version of node you wish to
          run tests with.

          The <b>renode</b> trigger is useful in cases where a project's
          other jobs passed, however this job failed due to infra problems or
          intermittent issues. It will retrigger just this job to save time.

          BEWARE: If there were other failed jobs, renode could lead
          to false Verified+1 vote, risking a merge which breaks other projetcs.
          Renode is only for committers who are familiar with the risks involved.
          If in doubt, use the safe trigger word: recheck.
          Recheck triggers every job involved in verifying latest patch set in the Change.
        </td>
      </tr>

      <tr class="warning">
        <td><b>Job Template</b><br/>{project}-verify-python-{stream} | {project}-verify-tox-{stream}</td>
        <td><b>Gerrit Trigger</b><br/>recheck | retox</td>
      </tr>
      <tr>
        <td colspan="2">
          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.

          The <b>retox</b> trigger is useful in cases where a project's
          other verify jobs passed, however this job failed due to infra problems or
          intermittent issues. It will retrigger just this job to save time.

          BEWARE: If there were other failed jobs, retox could lead
          to false Verified+1 vote, risking a merge which breaks other projetcs.
          Retox is only for committers who are familiar with the risks involved.
          If in doubt, use the safe trigger word: recheck.
          Recheck triggers every job involved in verifying latest patch set in the Change.
        </td>
      </tr>

      <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 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>.

          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-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>

          Some considerations when using this job:
          <ul>
            <li>
              The patch test verification takes some time (~2 hours) + consumes a lot of
              resources so it is not meant to be used for every patch.
            </li>
            <li>
              The system tests for master patches will fail most of the times because both
              code and test are unstable during the release cycle (should be good by the
              end of the cycle).
            </li>
            <li>
              Because of the above, patch test results typically have to be interpreted by
              system test experts. The <a href="https://wiki.opendaylight.org/view/Integration/Test">Integration/Test</a>
              project can help with that.
            </li>
        </td>
      </tr>
    </table>

Maven Properties
----------------

We provide a properties which your job can take advantage of if you want to do
something different depending on the job type that is run. If you create a
profile that activates on a property listed blow. The JJB templated jobs will
be able to activate the profile during the build to run any custom code you
wish to run in your project.

.. code-block:: bash

    -Dmerge   : This flag is passed in our Merge job and is equivalent to the
                Maven property
                <merge>true</merge>.
    -Dsonar   : This flag is passed in our Sonar job and is equivalent to the
                Maven property
                <sonar>true</sonar>.

Jenkins Sandbox
---------------

The `jenkins-sandbox`_ instance's purpose is to allow projects to test their JJB
setups before merging their code over to the RelEng master silo. It is
configured similarly to the master instance, although it cannot publish
artifacts or vote in Gerrit.

If your project requires access to the sandbox please open an OpenDaylight
Helpdesk ticket (<helpdesk@opendaylight.org>) and provide your ODL ID.

Notes Regarding the Sandbox
^^^^^^^^^^^^^^^^^^^^^^^^^^^

* Jobs are automatically deleted every Saturday at 08:00 UTC
* Committers can login and configure Jenkins jobs in the sandbox directly
  (unlike with the master silo)
* Sandbox configuration mirrors the master silo when possible
* Sandbox jobs can NOT upload artifacts to Nexus
* Sandbox jobs can NOT vote on Gerrit

Configuration
^^^^^^^^^^^^^

Make sure you have Jenkins Job Builder [properly installed](#jjb_install).

If you do not already have access, open an OpenDaylight Helpdesk ticket
(<helpdesk@opendaylight.org>) to request access to ODL's sandbox instance.
Integration/Test (`integration-test-wiki`_) committers have access by default.

JJB reads user-specific configuration from a `jenkins.ini`_. An
example is provided by releng/builder at `example-jenkins.ini`_.

.. code-block:: bash

    # If you don't have RelEng/Builder's repo, clone it
    $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git
    # Make a copy of the example JJB config file (in the builder/ directory)
    $ cp jenkins.ini.example jenkins.ini
    # Edit jenkins.ini with your username, API token and ODL's sandbox URL
    $ cat jenkins.ini
    <snip>
    [jenkins]
    user=<your ODL username>
    password=<your ODL Jenkins sandbox API token>
    url=https://jenkins.opendaylight.org/sandbox
    <snip>

To get your API token, `login to the Jenkins **sandbox** instance
<jenkins-sandbox-login_>`_ (*not
the main master Jenkins instance, different tokens*), go to your user page (by
clicking on your username, for example), click "Configure" and then "Show API
Token".

Manual Method
^^^^^^^^^^^^^

If you `installed JJB locally into a virtual environment
<Installing Jenkins Job Builder_>`_,
you should now activate that virtual environment to access the `jenkins-jobs`
executable.

.. code-block:: bash

    $ workon jjb
    (jjb)$

You'll want to work from the root of the RelEng/Builder repo, and you should
have your `jenkins.ini` file [properly configured](#sandbox_config).

Testing Jobs
^^^^^^^^^^^^

It's good practice to use the `test` command to validate your JJB files before
pushing them.

.. code-block:: bash

    jenkins-jobs --conf jenkins.ini test jjb/ <job-name>

If the job you'd like to test is a template with variables in its name, it
must be manually expanded before use. For example, the commonly used template
`{project}-csit-verify-1node-{functionality}` might expand to
`ovsdb-csit-verify-1node-netvirt`.

.. code-block:: bash

    jenkins-jobs --conf jenkins.ini test jjb/ ovsdb-csit-verify-1node-netvirt

Successful tests output the XML description of the Jenkins job described by
the specified JJB job name.

Pushing Jobs
^^^^^^^^^^^^

Once you've `configured your \`jenkins.ini\` <Configuration_>`_ and `verified your
JJB jobs <Testing Jobs_>`_ produce valid XML descriptions of Jenkins jobs you
can push them to the Jenkins sandbox.

.. important::

    When pushing with `jenkins-jobs`, a log message with the number
    of jobs you're pushing will be issued, typically to stdout.
    **If the number is greater than 1** (or the number of jobs you
    passed to the command to push) then you are pushing too many
    jobs and should **`ctrl+c` to cancel the upload**. Else you will
    flood the system with jobs.

    .. code-block:: bash

        INFO:jenkins_jobs.builder:Number of jobs generated:  1

    **Failing to provide the final `<job-name>` param will push all
    jobs!**

    .. code-block:: bash

        # Don't push all jobs by omitting the final param! (ctrl+c to abort)
        jenkins-jobs --conf jenkins.ini update jjb/ <job-name>

Running Jobs
^^^^^^^^^^^^

Once you have your Jenkins job configuration `pushed to the
Sandbox <Pushing Jobs_>`_ you can trigger it to run.

Find your newly-pushed job on the `Sandbox's web UI <jenkins-sandbox_>`_. Click
on its name to see the job's details.

Make sure you're `logged in <jenkins-sandbox-login_>`_ to the Sandbox.

Click "Build with Parameters" and then "Build".

Wait for your job to be scheduled and run. Click on the job number to see
details, including console output.

Make changes to your JJB configuration, re-test, re-push and re-run until
your job is ready.

Docker Method
^^^^^^^^^^^^^

If `using Docker <JJB Docker image_>`_:

.. code-block:: bash

    # To test
    docker run --rm -v ${PWD}:/jjb zxiiro/jjb-docker

.. important::

    When pushing with `jenkins-jobs`, a log message with
    the number of jobs you're pushing will be issued, typically to stdout.
    **If the number is greater than 1** (or the number of jobs you passed to
    the command to push) then you are pushing too many jobs and should **`ctrl+c`
    to cancel the upload**. Else you will flood the system with jobs.

    .. code-block:: bash

          INFO:jenkins_jobs.builder:Number of jobs generated:  1

    **Failing to provide the final `<job-name>` param will push all jobs!**

    .. code-block:: bash

        # To upload jobs to the sandbox
        # Please ensure that you include a configured jenkins.ini in your volume mount
        # Making sure not to push more jobs than expected, ctrl+c to abort
        docker run --rm -v ${PWD}:/jjb zxiiro/jjb-docker jenkins-jobs --conf jenkins.ini update . openflowplugin-csit-periodic-1node-cds-longevity-only-master

.. _docker-docs: https://www.docker.com/whatisdocker/
.. _example-jenkins.ini: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins.ini.example
.. _integration-test-wiki: https://wiki.opendaylight.org/view/Integration/Test
.. _jenkins-master: https://jenkins.opendaylight.org/releng
.. _jenkins-sandbox: https://jenkins.opendaylight.org/sandbox
.. _jenkins-sandbox-login: https://jenkins.opendaylight.org/sandbox/login
.. _jenkins.ini: http://docs.openstack.org/infra/jenkins-job-builder/execution.html#configuration-file
.. _jjb-autoupdate-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-autoupdate-project.py
.. _jjb-docker: https://hub.docker.com/r/zxiiro/jjb-docker/
.. _jjb-dockerfile: https://github.com/zxiiro/jjb-docker/blob/master/Dockerfile
.. _jjb-docs: http://ci.openstack.org/jenkins-job-builder/
.. _jjb-init-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-init-project.py
.. _jjb-repo: https://github.com/openstack-infra/jenkins-job-builder
.. _jjb-requirements.txt: https://github.com/openstack-infra/jenkins-job-builder/blob/master/requirements.txt
.. _jjb-templates: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jjb
.. _odl-jjb-requirements.txt: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/requirements.txt
.. _odl-nexus: https://nexus.opendaylight.org
.. _odl-sonar: https://sonar.opendaylight.org
.. _python-virtualenv: https://virtualenv.readthedocs.org/en/latest/
.. _python-virtualenvwrapper: https://virtualenvwrapper.readthedocs.org/en/latest/
.. _releng-wiki: https://wiki.opendaylight.org/view/RelEng:Main
.. _releng-builder-gerrit: https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder
.. _releng-builder-repo: https://git.opendaylight.org/gerrit/gitweb?p=releng%2Fbuilder.git;a=summary
.. _releng-builder-wiki: https://wiki.opendaylight.org/view/RelEng/Builder
.. _streams-design-background: https://lists.opendaylight.org/pipermail/release/2015-July/003139.html
.. _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