docs/jenkins.rst

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