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