docs/jenkins.rst

   1 Jenkins
   2 =======
   3
   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
   8 Jenkins jobs.
   9
  10 Sections:
  11
  12 .. contents::
  13    :depth: 3
  14    :local:
  15
  16 New Project Quick Start
  17 -----------------------
  18
  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.
  23
  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.
  27
  28 .. code-block:: bash
  29
  30     git clone https://git.opendaylight.org/gerrit/releng/builder
  31     cd builder
  32     mkdir jjb/<new-project>
  33
  34 Where <new-project> should be the same name as your project's git repo in
  35 Gerrit. So if your project is called "aaa" then create a new jjb/aaa directory.
  36
  37 Next we will create <new-project>.yaml as follows:
  38
  39 .. code-block:: yaml
  40
  41     ---
  42     - project:
  43         name: <NEW_PROJECT>-carbon
  44         jobs:
  45           - '{project-name}-clm-{stream}'
  46           - '{project-name}-integration-{stream}'
  47           - '{project-name}-merge-{stream}'
  48           - '{project-name}-verify-{stream}-{maven}-{jdks}'
  49
  50         project: '<NEW_PROJECT>'
  51         project-name: '<NEW_PROJECT>'
  52         stream: carbon
  53         branch: 'master'
  54         jdk: openjdk8
  55         jdks:
  56           - openjdk8
  57         maven:
  58           - mvn33:
  59               mvn-version: 'mvn33'
  60         mvn-settings: '<NEW_PROJECT>-settings'
  61         mvn-goals: 'clean install -Dmaven.repo.local=/tmp/r -Dorg.ops4j.pax.url.mvn.localRepository=/tmp/r'
  62         mvn-opts: '-Xmx1024m -XX:MaxPermSize=256m'
  63         dependencies: 'odlparent-merge-{stream},yangtools-merge-{stream},controller-merge-{stream}'
  64         email-upstream: '[<NEW_PROJECT>] [odlparent] [yangtools] [controller]'
  65         archive-artifacts: ''
  66
  67     - project:
  68         name: <NEW_PROJECT>-sonar
  69         jobs:
  70           - '{project-name}-sonar'
  71
  72         project: '<NEW_PROJECT>'
  73         project-name: '<NEW_PROJECT>'
  74         branch: 'master'
  75         mvn-settings: '<NEW_PROJECT>-settings'
  76         mvn-goals: 'clean install -Dmaven.repo.local=/tmp/r -Dorg.ops4j.pax.url.mvn.localRepository=/tmp/r'
  77         mvn-opts: '-Xmx1024m -XX:MaxPermSize=256m'
  78
  79 Replace all instances of <new-project> with the name of your project. This will
  80 create the jobs with the default job types we recommend for Java projects. If
  81 your project is participating in the simultanious-release and ultimately will
  82 be included in the final distribution, it is required to add the following job
  83 types into the job list for the release you are participating.
  84
  85
  86 .. code-block:: yaml
  87
  88     - '{project-name}-distribution-check-{stream}'
  89     - '{project-name}-validate-autorelease-{stream}'
  90
  91 If you'd like to explore the additional tweaking options available
  92 please refer to the `Jenkins Job Templates`_ section.
  93
  94 Finally we need to push these files to Gerrit for review by the releng/builder
  95 team to push your jobs to Jenkins.
  96
  97 .. code-block:: bash
  98
  99     git add jjb/<new-project>
 100     git commit -sm "Add <new-project> jobs to Jenkins"
 101     git review
 102
 103 This will push the jobs to Gerrit and your jobs will appear in Jenkins once the
 104 releng/builder team has reviewed and merged your patch.
 105
 106 Jenkins Master
 107 --------------
 108
 109 The `jenkins-master`_ is the home for all project's Jenkins jobs. All
 110 maintenance and configuration of these jobs must be done via JJB through the
 111 `releng-builder-repo`_. Project contributors can no longer edit the Jenkins jobs
 112 directly on the server.
 113
 114 Build Minions
 115 -------------
 116
 117 The Jenkins jobs are run on build minions (executors) which are created on an
 118 as-needed basis. If no idle build minions are available a new VM is brought
 119 up. This process can take up to 2 minutes. Once the build minion has finished a
 120 job, it will be destroyed.
 121
 122 Our Jenkins master supports many types of dynamic build minions. If you are
 123 creating custom jobs then you will need to have an idea of what type of minions
 124 are available. The following are the current minion types and descriptions.
 125 Minion Template Names are needed for jobs that take advantage of multiple
 126 minions as they must be specifically called out by template name instead of
 127 label.
 128
 129 Adding New Components to the Minions
 130 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 131
 132 If your project needs something added to one of the minions, you can help us
 133 get things added faster by doing one of the following:
 134
 135 * Submit a patch to RelEng/Builder for the appropriate `jenkins-scripts`
 136   definition which configure software during minion boot up.
 137 * Submit a patch to RelEng/Builder for the `packer/provision` scripts that
 138   configures software during minion instance imaging.
 139 * Submit a patch to RelEng/Builder for the Packer's templates  in
 140   the `packer/templates` directory that configures a new instance definition
 141   along with changes in `packer/provision`.
 142
 143 Going the first route will be faster in the short term as we can inspect the
 144 changes and make test modifications in the sandbox to verify that it works.
 145
 146 .. note::
 147
 148    The first route may add additional setup time considering this is run every
 149    time the minion is booted.
 150
 151 The second and third routes, however, is better for the community as a whole as
 152 it will allow others to utilize our Packer setups to replicate our systems more
 153 closely. It is, however, more time consuming as an image snapshot needs to be
 154 created based on the updated Packer definitions before it can be attached to the
 155 Jenkins configuration on sandbox for validation testing.
 156
 157 In either case, the changes must be validated in the sandbox with tests to
 158 make sure that we don't break current jobs and that the new software features
 159 are operating as intended. Once this is done the changes will be merged and
 160 the updates applied to the RelEng Jenkins production silo. Any changes to
 161 files under `releng/builder/packer` will be validated and images would be built
 162 triggered by verify-packer and merge-packer jobs.
 163
 164 Please note that the combination of a Packer definitions from `vars`, `templates`
 165 and the `provision` scripts is what defines a given minion. For instance, a minion
 166 may be defined as `centos7-java-builder` which is a combination of Packer OS image
 167 definitions from `vars/centos.json`, Packer template definitions from
 168 `templates/java-buidler.json` and spinup scripts from `provision/java-builder.sh`.
 169 This combination provides the full definition of the realized minion.
 170
 171 Jenkins starts a minion using the latest image which is built and linked into the
 172 Jenkins configuration. Once the base instance is online Jenkins checks out the
 173 RelEng/Builder repo on it and executes two scripts. The first is
 174 `provision/baseline.sh`, which is a baseline for all of the minions.
 175
 176 The second is the specialized script, which handles any system updates,
 177 new software installs or extra environment tweaks that don't make sense in a
 178 snapshot. Examples could include installing new package or setting up a virtual
 179 environment. Its imperative to ensure modifications to these spinup scripts have
 180 considered time taken to install the packages, as this could increase the build
 181 time for every job which runs on the image. After all of these scripts have
 182 executed Jenkins will finally attach the minion as an actual minion and start
 183 handling jobs on it.
 184
 185 Pool: ODLRPC
 186 ^^^^^^^^^^^^
 187
 188 .. raw:: html
 189
 190     <table class="table table-bordered">
 191       <tr class="warning">
 192         <td><b>Jenkins Labels</b><br/> centos7-java-builder-2c-4g,
 193           centos7-java-builder-2c-8g, centos7-java-builder-4c-8g,
 194           centos7-java-builder-8c-8g, centos7-java-builder-4c-16g</td>
 195         <td><b>Minion Template names</b><br/> centos7-java-builder-2c-4g,
 196           centos7-java-builder-2c-4g, centos7-java-builder-2c-8g,
 197           centos7-java-builder-4c-8g, centos7-java-builder-8c-8g,
 198           centos7-java-builder-4c-16g</td>
 199         <td><b>Packer Template</b><br/>
 200         releng/builder/packer/templates/java-builder.json</td>
 201         <td><b>Spinup Script</b><br/>
 202         releng/builder/jenkins-scripts/builder.sh</td>
 203       </tr>
 204       <tr>
 205         <td colspan="4">
 206           A CentOS 7 build minion. This system has OpenJDK 1.7 (Java7) and OpenJDK
 207           1.8 (Java8) installed on it along with all the other components and
 208           libraries needed for building any current OpenDaylight project. This is
 209           the label that is used for all basic verify, merge and daily builds for
 210           projects.
 211         </td>
 212       </tr>
 213
 214       <tr class="warning">
 215         <td><b>Jenkins Labels</b><br/> centos7-robot-2c-2g</td>
 216         <td><b>Minion Template names</b><br/> centos7-robot-2c-2g</td>
 217         <td><b>Packer Template</b><br/>
 218         releng/builder/packer/templates/robot.json</td>
 219         <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/robot.sh</td>
 220       </tr>
 221       <tr>
 222         <td colspan="4">
 223           A CentOS 7 minion that is configured with OpenJDK 1.7 (Java7), OpenJDK
 224           1.8 (Java8) and all the current packages used by the integration
 225           project for doing robot driven jobs. If you are executing robot
 226           framework jobs then your job should be using this as the minion that
 227           you are tied to. This image does not contain the needed libraries for
 228           building components of OpenDaylight, only for executing robot tests.
 229         </td>
 230       </tr>
 231
 232       <tr class="warning">
 233         <td><b>Jenkins Labels</b><br/> ubuntu1404-mininet-2c-2g</td>
 234         <td><b>Minion Template names</b><br/> ubuntu1404-mininet-2c-2g</td>
 235         <td><b>Packer Template</b><br/>
 236         releng/builder/packer/teamplates/mininet.json</td>
 237         <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
 238       </tr>
 239       <tr>
 240         <td colspan="4">
 241           Basic Ubuntu system with ovs 2.0.2 and mininet 2.1.0
 242         </td>
 243       </tr>
 244
 245       <tr class="warning">
 246         <td><b>Jenkins Labels</b><br/> ubuntu1404-mininet-ovs-23-2c-2g</td>
 247         <td><b>Minion Template names</b><br/> ubuntu1404-mininet-ovs-23-2c-2g</td>
 248         <td><b>Packer Template</b><br/> releng/builder/packer/templates/mininet-ovs-2.3.json</td>
 249         <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
 250       </tr>
 251       <tr>
 252         <td colspan="4">
 253           Basic Ubuntu system with ovs 2.3 and mininet 2.2.1
 254         </td>
 255       </tr>
 256
 257       <tr class="warning">
 258         <td><b>Jenkins Labels</b><br/> ubuntu1404-mininet-ovs-25-2c-2g</td>
 259         <td><b>Minion Template names</b><br/> ubuntu1404-mininet-ovs-25-2c-2g</td>
 260         <td><b>Packer Template</b><br/> releng/builder/packer/templates/mininet-ovs-2.5.json</td>
 261         <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
 262       </tr>
 263       <tr>
 264         <td colspan="4">
 265           Basic Ubuntu system with ovs 2.5 and mininet 2.2.2
 266         </td>
 267       </tr>
 268
 269       <tr class="warning">
 270         <td><b>Jenkins Labels</b><br/> centos7-devstack-2c-4g</td>
 271         <td><b>Minion Template names</b><br/> centos7-devstack-2c-4g</td>
 272         <td><b>Packer Template</b><br/> releng/builder/packer/templates/devstack.json</td>
 273         <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/devstack.sh</td>
 274       </tr>
 275       <tr>
 276         <td colspan="4">
 277           A CentOS 7 system purpose built for doing OpenStack testing using
 278           DevStack. This minion is primarily targeted at the needs of the OVSDB
 279           project. It has OpenJDK 1.7 (aka Java7) and OpenJDK 1.8 (Java8) and
 280           other basic DevStack related bits installed.
 281         </td>
 282       </tr>
 283
 284       <tr class="warning">
 285         <td><b>Jenkins Labels</b><br/> centos7-docker-2c-4g</td>
 286         <td><b>Minion Template names</b><br/> centos7-docker-2c-4g</td>
 287         <td><b>Packer Template</b><br/> releng/builder/packer/templates/docker.json</td>
 288         <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/docker.sh</td>
 289       </tr>
 290       <tr>
 291         <td colspan="4">
 292           A CentOS 7 system that is configured with OpenJDK 1.7 (aka Java7),
 293           OpenJDK 1.8 (Java8) and Docker. This system was originally custom
 294           built for the test needs of the OVSDB project but other projects have
 295           expressed interest in using it.
 296         </td>
 297       </tr>
 298
 299       <tr class="warning">
 300         <td><b>Jenkins Labels</b><br/> ubuntu1404-gbp-2c-2g</td>
 301         <td><b>Minion Template names</b><br/> ubuntu1404-gbp-2c-2g</td>
 302         <td><b>Packer Template</b><br/> releng/builder/packer/templates/gbp.json</td>
 303         <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/ubuntu-docker-ovs.sh</td>
 304       </tr>
 305       <tr>
 306         <td colspan="4">
 307           A basic Ubuntu node with latest OVS and docker installed. Used by Group Based Policy.
 308         </td>
 309       </tr>
 310     </table>
 311
 312 Pool: ODLPUB - HOT (Heat Orchestration Templates)
 313 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 314
 315 HOT integration enables to spin up integration labs servers for CSIT jobs
 316 using heat, rathar than using jclouds (deprecated). Image names are updated
 317 on the project specific job templates using the variable
 318 `{odl,docker,openstack,tools}_system_image` followed by image name in the
 319 format `<platform> - <template> - <date-stamp>`.
 320
 321 .. code-block:: yaml
 322
 323     CentOS 7 - docker - 20161031-0802
 324
 325 .. include:: cloud-images.rst
 326
 327 Creating Jenkins Jobs
 328 ---------------------
 329
 330 Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format
 331 and uses them to configure Jenkins.
 332
 333 * `Jenkins Job Builder (JJB) documentation <jjb-docs_>`_
 334 * `RelEng/Builder Gerrit <releng-builder-gerrit_>`_
 335 * `RelEng/Builder Git repository <releng-builder-repo_>`_
 336
 337 Getting Jenkins Job Builder
 338 ---------------------------
 339
 340 OpenDaylight uses Jenkins Job Builder to translate our in-repo YAML job
 341 configuration into job descriptions suitable for consumption by Jenkins.
 342 When testing new Jenkins Jobs in the `Jenkins Sandbox`_, you'll
 343 need to use the `jenkins-jobs` executable to translate a set of jobs into
 344 their XML descriptions and upload them to the sandbox Jenkins server.
 345
 346 We document `installing <Installing Jenkins Job Builder_>`_ `jenkins-jobs`
 347 below. We also provide
 348 a `pre-built Docker image <jjb-docker_>`_ with `jenkins-jobs` already installed.
 349
 350 Installing Jenkins Job Builder
 351 ------------------------------
 352
 353 For users who aren't already experienced with Docker or otherwise don't want
 354 to use our `pre-built JJB Docker image <jjb-docker_>`_, installing JJB into a
 355 virtual environment is an equally good option.
 356
 357 We recommend using `pip <Installing JJB using pip_>`_ to assist with JJB
 358 installs, but we
 359 also document `installing from a git repository manually
 360 <Installing JJB Manually_>`_.
 361 For both, we recommend using Python `Virtual Environments`_
 362 to isolate JJB and its dependencies.
 363
 364 The `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file contains the currently
 365 recommended JJB version. Because JJB is fairly unstable, it may be necessary
 366 to debug things by installing different versions. This is documented for both
 367 `pip-assisted <Installing JJB using pip_>`_ and `manual
 368 <Installing JJB Manually_>`_ installs.
 369
 370 Virtual Environments
 371 --------------------
 372
 373 For both `pip-assisted <Installing JJB using pip_>`_ and `manual
 374 <Installing JJB Manually_>`_ JJB
 375 installs, we recommend using `Python Virtual Environments <python-virtualenv_>`_
 376 to manage JJB and its
 377 Python dependencies. The `python-virtualenvwrapper`_ tool can help you do so.
 378
 379 There are good docs for installing `python-virtualenvwrapper`_. On Linux systems
 380 with pip (typical), they amount to:
 381
 382 .. code-block:: bash
 383
 384     sudo pip install virtualenvwrapper
 385
 386 A virtual environment is simply a directory that you install Python programs
 387 into and then append to the front of your path, causing those copies to be
 388 found before any system-wide versions.
 389
 390 Create a new virtual environment for JJB.
 391
 392 .. code-block:: bash
 393
 394     # Virtaulenvwrapper uses this dir for virtual environments
 395     $ echo $WORKON_HOME
 396     /home/daniel/.virtualenvs
 397     # Make a new virtual environment
 398     $ mkvirtualenv jjb
 399     # A new venv dir was created
 400     (jjb)$ ls -rc $WORKON_HOME | tail -n 1
 401     jjb
 402     # The new venv was added to the front of this shell's path
 403     (jjb)$ echo $PATH
 404     /home/daniel/.virtualenvs/jjb/bin:<my normal path>
 405     # Software installed to venv, like pip, is found before system-wide copies
 406     (jjb)$ command -v pip
 407     /home/daniel/.virtualenvs/jjb/bin/pip
 408
 409 With your virtual environment active, you should install JJB. Your install will
 410 be isolated to that virtual environment's directory and only visible when the
 411 virtual environment is active.
 412
 413 You can easily leave and return to your venv. Make sure you activate it before
 414 each use of JJB.
 415
 416 .. code-block:: bash
 417
 418     (jjb)$ deactivate
 419     $ command -v jenkins-jobs
 420     # No jenkins-jobs executable found
 421     $ workon jjb
 422     (jjb)$ command -v jenkins-jobs
 423     $WORKON_HOME/jjb/bin/jenkins-jobs
 424
 425 Installing JJB using pip
 426 ------------------------
 427
 428 The recommended way to install JJB is via pip.
 429
 430 First, clone the latest version of the `releng-builder-repo`_.
 431
 432 .. code-block:: bash
 433
 434     $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git
 435
 436 Before actually installing JJB and its dependencies, make sure you've `created
 437 and activated <Virtual Environments_>`_ a virtual environment for JJB.
 438
 439 .. code-block:: bash
 440
 441     $ mkvirtualenv jjb
 442
 443 The recommended version of JJB to install is the version specified in the
 444 `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file.
 445
 446 .. code-block:: bash
 447
 448     # From the root of the releng/builder repo
 449     (jjb)$ pip install -r jjb/requirements.txt
 450
 451 To validate that JJB was successfully installed you can run this command:
 452
 453 .. code-block:: bash
 454
 455     (jjb)$ jenkins-jobs --version
 456
 457 TODO: Explain that only the currently merged jjb/requirements.txt is supported,
 458 other options described below are for troubleshooting only.
 459
 460 To change the version of JJB specified by `builder/jjb/requirements.txt
 461 <odl-jjb-requirements.txt_>`_
 462 to install from the latest commit to the master branch of JJB's git repository:
 463
 464 .. code-block:: bash
 465
 466     $ cat jjb/requirements.txt
 467     -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder#egg=jenkins-job-builder
 468
 469 To install from a tag, like 1.4.0:
 470
 471 .. code-block:: bash
 472
 473     $ cat jjb/requirements.txt
 474     -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder@1.4.0#egg=jenkins-job-builder
 475
 476 Installing JJB Manually
 477 -----------------------
 478
 479 This section documents installing JJB from its manually cloned repository.
 480
 481 Note that `installing via pip <Installing JJB using pip_>`_ is typically simpler.
 482
 483 Checkout the version of JJB's source you'd like to build.
 484
 485 For example, using master:
 486
 487 .. code-block:: bash
 488
 489     $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
 490
 491 Using a tag, like 1.4.0:
 492
 493 .. code-block:: bash
 494
 495     $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
 496     $ cd jenkins-job-builder
 497     $ git checkout tags/1.4.0
 498
 499 Before actually installing JJB and its dependencies, make sure you've `created
 500 and activated <Virtual Environments_>`_ a virtual environment for JJB.
 501
 502 .. code-block:: bash
 503
 504     $ mkvirtualenv jjb
 505
 506 You can then use JJB's `requirements.txt <jjb-requirements.txt_>`_ file to
 507 install its
 508 dependencies. Note that we're not using `sudo` to install as root, since we want
 509 to make use of the venv we've configured for our current user.
 510
 511 .. code-block:: bash
 512
 513     # In the cloned JJB repo, with the desired version of the code checked out
 514     (jjb)$ pip install -r requirements.txt
 515
 516 Then install JJB from the repo with:
 517
 518 .. code-block:: bash
 519
 520     (jjb)$ pip install .
 521
 522 To validate that JJB was successfully installed you can run this command:
 523
 524 .. code-block:: bash
 525
 526     (jjb)$ jenkins-jobs --version
 527
 528 JJB Docker Image
 529 ----------------
 530
 531 `Docker <docker-docs_>`_ is an open platform used to create virtualized Linux containers
 532 for shipping self-contained applications. Docker leverages LinuX Containers
 533 \(LXC\) running on the same operating system as the host machine, whereas a
 534 traditional VM runs an operating system over the host.
 535
 536 .. code-block:: bash
 537
 538     docker pull zxiiro/jjb-docker
 539     docker run --rm -v ${PWD}:/jjb jjb-docker
 540
 541 This `Dockerfile <jjb-dockerfile_>`_ created the
 542 `zxiiro/jjb-docker image <jjb-docker_>`_.
 543 By default it will run:
 544
 545 .. code-block:: bash
 546
 547     jenkins-jobs test .
 548
 549 You'll need to use the `-v/--volume=[]` parameter to mount a directory
 550 containing your YAML files, as well as a configured `jenkins.ini` file if you
 551 wish to upload your jobs to the `Jenkins Sandbox`_.
 552
 553 Jenkins Job Templates
 554 ---------------------
 555
 556 The OpenDaylight `RelEng/Builder <releng-builder-wiki_>`_ project provides
 557 `jjb-templates`_ that can be used to define basic jobs.
 558
 559 The *Gerrit Trigger* listed in the jobs are keywords that can be used to
 560 trigger the job to run manually by simply leaving a comment in Gerrit for the
 561 patch you wish to trigger against.
 562
 563 All jobs have a default build-timeout value of 360 minutes (6 hrs) but can be
 564 overrided via the opendaylight-infra-wrappers' build-timeout property.
 565
 566 TODO: Group jobs into categories: every-patch, after-merge, on-demand, etc.
 567 TODO: Reiterate that "remerge" triggers all every-patch jobs at once,
 568 because when only a subset of jobs is triggered, Gerrit forgets valid -1 from jobs outside the subset.
 569 TODO: Document that only drafts and commit-message-only edits do not trigger every-patch jobs.
 570 TODO: Document test-{project}-{feature} and test-{project}-all.
 571
 572 .. raw:: html
 573
 574     <table class="table table-bordered">
 575       <tr class="warning">
 576         <td><b>Job Template</b><br/>{project}-distribution-check-{stream}</td>
 577         <td><b>Gerrit Trigger</b><br/>recheck</td>
 578       </tr>
 579       <tr>
 580         <td colspan="2">
 581           This job runs the PROJECT-distribution-check-BRANCH job which is
 582           building also integration/distribution project in order to run SingleFeatureTest.
 583           It also performs various other checks in order to prevent the change to break autorelease.
 584         </td>
 585       </tr>
 586
 587       <tr class="warning">
 588         <td><b>Job Template</b><br/>{project}-integration-{stream}</td>
 589         <td></td>
 590       </tr>
 591       <tr>
 592         <td colspan="2">
 593           The Integration Job Template creates a job which runs when a project that your
 594           project depends on is successfully built. This job type is basically the same
 595           as a verify job except that it triggers from other Jenkins jobs instead of via
 596           Gerrit review updates. The dependencies that triger integration jobs are listed
 597           in your project.cfg file under the <b>DEPENDENCIES</b> variable.
 598
 599           If no dependencies are listed then this job type is disabled by default.
 600         </td>
 601       </tr>
 602
 603       <tr class="warning">
 604         <td><b>Job Template</b><br/>{project}-merge-{stream}</td>
 605         <td><b>Gerrit Trigger</b><br/>remerge</td>
 606       </tr>
 607       <tr>
 608         <td colspan="2">
 609           This job will trigger once a Gerrit patch is merged into the repo.
 610           It will build HEAD of the current project branch and also run the Maven goals
 611           <b>source:jar</b> and <b>javadoc:jar</b>.
 612           Artifacts are uploaded to OpenDaylight's
 613           <a href="https://nexus.opendaylight.org">Nexus</a> on completion.
 614
 615           A distribution-merge-{stream} job is triggered to add the new artifacts to the
 616           integration distribution.
 617
 618           Running the "remerge" trigger is possible before a Change is merged,
 619           it would still build the actual HEAD. This job does not alter Gerrit votes.
 620         </td>
 621       </tr>
 622
 623       <tr class="warning">
 624         <td><b>Job Template</b><br/>{project}-sonar</td>
 625         <td><b>Gerrit Trigger</b><br/>run-sonar</td>
 626       </tr>
 627       <tr>
 628         <td colspan="2">
 629           This job runs Sonar analysis and reports the results to
 630           OpenDaylight's <a href="https://sonar.opendaylight.org">Sonar</a>
 631           dashboard.
 632
 633           The Sonar Job Template creates a job which will run against the
 634           master branch, or if BRANCHES are specified in the CFG file it will
 635           create a job for the <b>First</b> branch listed.
 636
 637           <div class="admonition note">
 638             <p class="first admonition-title">Note</p>
 639             <p>
 640               Running the "run-sonar" trigger will cause Jenkins to remove
 641               its existing vote if it's already -1'd or +1'd a comment. You
 642               will need to re-run your verify job (recheck) after running
 643               this to get Jenkins to re-vote.
 644             </p>
 645           </div>
 646         </td>
 647       </tr>
 648
 649       <tr class="warning">
 650         <td><b>Job Template</b><br/>{project}-validate-autorelease-{stream}</td>
 651         <td><b>Gerrit Trigger</b><br/>recheck</td>
 652       </tr>
 653       <tr>
 654         <td colspan="2">
 655           This job runs the PROJECT-validate-autorelease-BRANCH job which is
 656           used as a quick sanity test to ensure that a patch does not depend on
 657           features that do not exist in the current release.
 658         </td>
 659       </tr>
 660
 661       <tr class="warning">
 662         <td><b>Job Template</b><br/>{project}-verify-{stream}-{maven}-{jdks}</td>
 663         <td><b>Gerrit Trigger</b><br/>recheck</td>
 664       </tr>
 665       <tr>
 666         <td colspan="2">
 667           The Verify job template creates a Gerrit Trigger job that will
 668           trigger when a new patch is submitted to Gerrit.
 669           The job only builds the project code (including unit and integration tests).
 670         </td>
 671       </tr>
 672
 673       <tr class="warning">
 674         <td><b>Job Template</b><br/>{project}-verify-node-{stream}</td>
 675         <td><b>Gerrit Trigger</b><br/>recheck</td>
 676       </tr>
 677       <tr>
 678         <td colspan="2">
 679           This job template can be used by a project that is NodeJS based. It
 680           simply installs a python virtualenv and uses that to install nodeenv
 681           which is then used to install another virtualenv for nodejs. It then
 682           calls <b>npm install</b> and <b>npm test</b> to run the unit tests.
 683           When  using this template you need to provide a {nodedir} and
 684           {nodever} containing the directory relative to the project root
 685           containing the nodejs package.json and version of node you wish to
 686           run tests with.
 687         </td>
 688       </tr>
 689
 690       <tr class="warning">
 691         <td><b>Job Template</b><br/>{project}-verify-python-{stream} | {project}-verify-tox-{stream}</td>
 692         <td><b>Gerrit Trigger</b><br/>recheck</td>
 693       </tr>
 694       <tr>
 695         <td colspan="2">
 696           This job template can be used by a project that uses Tox to build. It
 697           simply installs a Python virtualenv and uses tox to run the tests
 698           defined in the project's tox.ini file. If the tox.ini is anywhere
 699           other than the project's repo root, the path to its directory
 700           relative to the project's repo root should be passed as {toxdir}.
 701
 702           The 2 template names verify-python & verify-tox are identical and are
 703           aliases to each other. This allows the project to use the naming that
 704           is most reasonable for them.
 705         </td>
 706       </tr>
 707
 708       <tr class="warning">
 709         <td><b>Job Template</b><br/>integration-patch-test-{stream}</td>
 710         <td><b>Gerrit Trigger</b><br/>test-integration</td>
 711       </tr>
 712       <tr>
 713         <td colspan="2">
 714         </td>
 715       </tr>
 716
 717       <tr class="warning">
 718         <td><b>Job Template</b><br/>integration-patch-test-{stream}</td>
 719         <td><b>Gerrit Trigger</b><br/>test-integration</td>
 720       </tr>
 721       <tr>
 722         <td colspan="2">
 723           This job builds a distribution against your Java patch and triggers distribution sanity CSIT jobs.
 724           Leave a comment with trigger keyword above to activate it for a particular patch.
 725           This job should not alter Gerrit votes for a given patch.
 726
 727           The list of CSIT jobs to trigger is defined in csit-list
 728           <a href="https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/integration/integration-test-jobs.yaml">here</a>.
 729
 730           Some considerations when using this job:
 731           <ul>
 732             <li>
 733               The patch test verification takes some time (~2 hours) + consumes a lot of
 734               resources so it is not meant to be used for every patch.
 735             </li>
 736             <li>
 737               The system tests for master patches will fail most of the times because both
 738               code and test are unstable during the release cycle (should be good by the
 739               end of the cycle).
 740             </li>
 741             <li>
 742               Because of the above, patch test results typically have to be interpreted by
 743               system test experts. The <a href="https://wiki.opendaylight.org/view/Integration/Test">Integration/Test</a>
 744               project can help with that.
 745             </li>
 746         </td>
 747       </tr>
 748     </table>
 749
 750 Maven Properties
 751 ----------------
 752
 753 We provide a properties which your job can take advantage of if you want to do
 754 something different depending on the job type that is run. If you create a
 755 profile that activates on a property listed blow. The JJB templated jobs will
 756 be able to activate the profile during the build to run any custom code you
 757 wish to run in your project.
 758
 759 .. code-block:: bash
 760
 761     -Dmerge   : This flag is passed in our Merge job and is equivalent to the
 762                 Maven property
 763                 <merge>true</merge>.
 764     -Dsonar   : This flag is passed in our Sonar job and is equivalent to the
 765                 Maven property
 766                 <sonar>true</sonar>.
 767
 768 Jenkins Sandbox
 769 ---------------
 770
 771 The `jenkins-sandbox`_ instance's purpose is to allow projects to test their JJB
 772 setups before merging their code over to the RelEng master silo. It is
 773 configured similarly to the master instance, although it cannot publish
 774 artifacts or vote in Gerrit.
 775
 776 If your project requires access to the sandbox please open an OpenDaylight
 777 Helpdesk ticket (<helpdesk@opendaylight.org>) and provide your ODL ID.
 778
 779 Notes Regarding the Sandbox
 780 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 781
 782 * Jobs are automatically deleted every Saturday at 08:00 UTC
 783 * Committers can login and configure Jenkins jobs in the sandbox directly
 784   (unlike with the master silo)
 785 * Sandbox configuration mirrors the master silo when possible
 786 * Sandbox jobs can NOT upload artifacts to Nexus
 787 * Sandbox jobs can NOT vote on Gerrit
 788
 789 Configuration
 790 ^^^^^^^^^^^^^
 791
 792 Make sure you have Jenkins Job Builder [properly installed](#jjb_install).
 793
 794 If you do not already have access, open an OpenDaylight Helpdesk ticket
 795 (<helpdesk@opendaylight.org>) to request access to ODL's sandbox instance.
 796 Integration/Test (`integration-test-wiki`_) committers have access by default.
 797
 798 JJB reads user-specific configuration from a `jenkins.ini`_. An
 799 example is provided by releng/builder at `example-jenkins.ini`_.
 800
 801 .. code-block:: bash
 802
 803     # If you don't have RelEng/Builder's repo, clone it
 804     $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git
 805     # Make a copy of the example JJB config file (in the builder/ directory)
 806     $ cp jenkins.ini.example jenkins.ini
 807     # Edit jenkins.ini with your username, API token and ODL's sandbox URL
 808     $ cat jenkins.ini
 809     <snip>
 810     [jenkins]
 811     user=<your ODL username>
 812     password=<your ODL Jenkins sandbox API token>
 813     url=https://jenkins.opendaylight.org/sandbox
 814     <snip>
 815
 816 To get your API token, `login to the Jenkins **sandbox** instance
 817 <jenkins-sandbox-login_>`_ (*not
 818 the main master Jenkins instance, different tokens*), go to your user page (by
 819 clicking on your username, for example), click "Configure" and then "Show API
 820 Token".
 821
 822 Manual Method
 823 ^^^^^^^^^^^^^
 824
 825 If you `installed JJB locally into a virtual environment
 826 <Installing Jenkins Job Builder_>`_,
 827 you should now activate that virtual environment to access the `jenkins-jobs`
 828 executable.
 829
 830 .. code-block:: bash
 831
 832     $ workon jjb
 833     (jjb)$
 834
 835 You'll want to work from the root of the RelEng/Builder repo, and you should
 836 have your `jenkins.ini` file [properly configured](#sandbox_config).
 837
 838 Testing Jobs
 839 ^^^^^^^^^^^^
 840
 841 It's good practice to use the `test` command to validate your JJB files before
 842 pushing them.
 843
 844 .. code-block:: bash
 845
 846     jenkins-jobs --conf jenkins.ini test jjb/ <job-name>
 847
 848 If the job you'd like to test is a template with variables in its name, it
 849 must be manually expanded before use. For example, the commonly used template
 850 `{project}-csit-verify-1node-{functionality}` might expand to
 851 `ovsdb-csit-verify-1node-netvirt`.
 852
 853 .. code-block:: bash
 854
 855     jenkins-jobs --conf jenkins.ini test jjb/ ovsdb-csit-verify-1node-netvirt
 856
 857 Successful tests output the XML description of the Jenkins job described by
 858 the specified JJB job name.
 859
 860 Pushing Jobs
 861 ^^^^^^^^^^^^
 862
 863 Once you've `configured your \`jenkins.ini\` <Configuration_>`_ and `verified your
 864 JJB jobs <Testing Jobs_>`_ produce valid XML descriptions of Jenkins jobs you
 865 can push them to the Jenkins sandbox.
 866
 867 .. important::
 868
 869     When pushing with `jenkins-jobs`, a log message with the number
 870     of jobs you're pushing will be issued, typically to stdout.
 871     **If the number is greater than 1** (or the number of jobs you
 872     passed to the command to push) then you are pushing too many
 873     jobs and should **`ctrl+c` to cancel the upload**. Else you will
 874     flood the system with jobs.
 875
 876     .. code-block:: bash
 877
 878         INFO:jenkins_jobs.builder:Number of jobs generated:  1
 879
 880     **Failing to provide the final `<job-name>` param will push all
 881     jobs!**
 882
 883     .. code-block:: bash
 884
 885         # Don't push all jobs by omitting the final param! (ctrl+c to abort)
 886         jenkins-jobs --conf jenkins.ini update jjb/ <job-name>
 887
 888 Running Jobs
 889 ^^^^^^^^^^^^
 890
 891 Once you have your Jenkins job configuration `pushed to the
 892 Sandbox <Pushing Jobs_>`_ you can trigger it to run.
 893
 894 Find your newly-pushed job on the `Sandbox's web UI <jenkins-sandbox_>`_. Click
 895 on its name to see the job's details.
 896
 897 Make sure you're `logged in <jenkins-sandbox-login_>`_ to the Sandbox.
 898
 899 Click "Build with Parameters" and then "Build".
 900
 901 Wait for your job to be scheduled and run. Click on the job number to see
 902 details, including console output.
 903
 904 Make changes to your JJB configuration, re-test, re-push and re-run until
 905 your job is ready.
 906
 907 Docker Method
 908 ^^^^^^^^^^^^^
 909
 910 If `using Docker <JJB Docker image_>`_:
 911
 912 .. code-block:: bash
 913
 914     # To test
 915     docker run --rm -v ${PWD}:/jjb zxiiro/jjb-docker
 916
 917 .. important::
 918
 919     When pushing with `jenkins-jobs`, a log message with
 920     the number of jobs you're pushing will be issued, typically to stdout.
 921     **If the number is greater than 1** (or the number of jobs you passed to
 922     the command to push) then you are pushing too many jobs and should **`ctrl+c`
 923     to cancel the upload**. Else you will flood the system with jobs.
 924
 925     .. code-block:: bash
 926
 927           INFO:jenkins_jobs.builder:Number of jobs generated:  1
 928
 929     **Failing to provide the final `<job-name>` param will push all jobs!**
 930
 931     .. code-block:: bash
 932
 933         # To upload jobs to the sandbox
 934         # Please ensure that you include a configured jenkins.ini in your volume mount
 935         # Making sure not to push more jobs than expected, ctrl+c to abort
 936         docker run --rm -v ${PWD}:/jjb zxiiro/jjb-docker jenkins-jobs --conf jenkins.ini update . openflowplugin-csit-periodic-1node-cds-longevity-only-master
 937
 938 .. _docker-docs: https://www.docker.com/whatisdocker/
 939 .. _example-jenkins.ini: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins.ini.example
 940 .. _integration-test-wiki: https://wiki.opendaylight.org/view/Integration/Test
 941 .. _jenkins-master: https://jenkins.opendaylight.org/releng
 942 .. _jenkins-sandbox: https://jenkins.opendaylight.org/sandbox
 943 .. _jenkins-sandbox-login: https://jenkins.opendaylight.org/sandbox/login
 944 .. _jenkins.ini: http://docs.openstack.org/infra/jenkins-job-builder/execution.html#configuration-file
 945 .. _jjb-autoupdate-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-autoupdate-project.py
 946 .. _jjb-docker: https://hub.docker.com/r/zxiiro/jjb-docker/
 947 .. _jjb-dockerfile: https://github.com/zxiiro/jjb-docker/blob/master/Dockerfile
 948 .. _jjb-docs: http://ci.openstack.org/jenkins-job-builder/
 949 .. _jjb-init-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-init-project.py
 950 .. _jjb-repo: https://github.com/openstack-infra/jenkins-job-builder
 951 .. _jjb-requirements.txt: https://github.com/openstack-infra/jenkins-job-builder/blob/master/requirements.txt
 952 .. _jjb-templates: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jjb
 953 .. _odl-jjb-requirements.txt: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/requirements.txt
 954 .. _odl-nexus: https://nexus.opendaylight.org
 955 .. _odl-sonar: https://sonar.opendaylight.org
 956 .. _python-virtualenv: https://virtualenv.readthedocs.org/en/latest/
 957 .. _python-virtualenvwrapper: https://virtualenvwrapper.readthedocs.org/en/latest/
 958 .. _releng-wiki: https://wiki.opendaylight.org/view/RelEng:Main
 959 .. _releng-builder-gerrit: https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder
 960 .. _releng-builder-repo: https://git.opendaylight.org/gerrit/gitweb?p=releng%2Fbuilder.git;a=summary
 961 .. _releng-builder-wiki: https://wiki.opendaylight.org/view/RelEng/Builder
 962 .. _streams-design-background: https://lists.opendaylight.org/pipermail/release/2015-July/003139.html
 963 .. _spinup-scripts: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jenkins-scripts
 964 .. _spinup-scripts-basic_settings.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/basic_settings.sh
 965 .. _spinup-scripts-controller.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/controller.sh