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