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