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