docs/jenkins.rst

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