Merge "Add multipatch job documentation"
[releng/builder.git] / docs / jenkins.rst
index 40057f03b9e2b3d31dc6dc648b157731515628ef..5c998e875855e6508c59661592c5292c34bc7547 100644 (file)
@@ -169,9 +169,9 @@ triggered by verify-packer and merge-packer jobs.
 
 Please note that the combination of a Packer definitions from `vars`, `templates`
 and the `provision` scripts is what defines a given minion. For instance, a minion
-may be defined as `centos7-java-builder` which is a combination of Packer OS image
+may be defined as `centos7-builder` which is a combination of Packer OS image
 definitions from `vars/centos.json`, Packer template definitions from
-`templates/java-buidler.json` and spinup scripts from `provision/java-builder.sh`.
+`templates/builder.json` and spinup scripts from `provision/builder.sh`.
 This combination provides the full definition of the realized minion.
 
 Jenkins starts a minion using the latest image which is built and linked into the
@@ -188,22 +188,80 @@ time for every job which runs on the image. After all of these scripts have
 executed Jenkins will finally attach the minion as an actual minion and start
 handling jobs on it.
 
-Pool: ODLRPC
+Flavors
+^^^^^^^
+
+Performance flavors come with dedicated CPUs and are not shared with other
+accounts in the cloud so should ensure consistent performance.
+
+.. list-table:: Flavors
+   :widths: auto
+   :header-rows: 1
+
+   * - Instance Type
+     - CPUs
+     - Memory
+
+   * - v2-standard-1
+     - 1
+     - 4
+
+   * - v2-standard-2
+     - 2
+     - 8
+
+   * - v2-standard-4
+     - 4
+     - 16
+
+   * - v2-standard-8
+     - 8
+     - 32
+
+   * - v2-standard-16
+     - 16
+     - 64
+
+   * - v2-highcpu-1
+     - 1
+     - 1
+
+   * - v2-highcpu-2
+     - 2
+     - 2
+
+   * - v2-highcpu-4
+     - 4
+     - 4
+
+   * - v2-highcpu-8
+     - 8
+     - 8
+
+   * - v2-highcpu-16
+     - 16
+     - 16
+
+   * - v2-highcpu-32
+     - 32
+     - 32
+
+Pool: ODLVEX
 ^^^^^^^^^^^^
 
 .. raw:: html
 
     <table class="table table-bordered">
       <tr class="warning">
-        <td><b>Jenkins Labels</b><br/> centos7-java-builder-2c-4g,
-          centos7-java-builder-2c-8g, centos7-java-builder-4c-8g,
-          centos7-java-builder-8c-8g, centos7-java-builder-4c-16g</td>
-        <td><b>Minion Template names</b><br/> centos7-java-builder-2c-4g,
-          centos7-java-builder-2c-4g, centos7-java-builder-2c-8g,
-          centos7-java-builder-4c-8g, centos7-java-builder-8c-8g,
-          centos7-java-builder-4c-16g</td>
+        <td><b>Jenkins Labels</b><br/> centos7-builder-2c-4g,
+          centos7-builder-2c-8g, centos7-java-builder-4c-8g,
+          centos7-builder-8c-8g, centos7-java-builder-4c-16g</td>
+        <td><b>Minion Template names</b><br/> centos7-builder-2c-4g,
+          centos7-builder-2c-4g, centos7-java-builder-2c-8g,
+          centos7-builder-4c-8g, centos7-java-builder-8c-8g,
+          centos7-builder-4c-16g</td>
         <td><b>Packer Template</b><br/>
-        releng/builder/packer/templates/java-builder.json</td>
+        releng/builder/packer/templates/builder.json</td>
         <td><b>Spinup Script</b><br/>
         releng/builder/jenkins-scripts/builder.sh</td>
       </tr>
@@ -316,7 +374,7 @@ Pool: ODLRPC
 
     </table>
 
-Pool: ODLPUB - HOT (Heat Orchestration Templates)
+Pool: ODLVEX - HOT (Heat Orchestration Templates)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 HOT integration enables to spin up integration labs servers for CSIT jobs
@@ -325,10 +383,6 @@ on the project specific job templates using the variable
 `{odl,docker,openstack,tools}_system_image` followed by image name in the
 format `<platform> - <template> - <date-stamp>`.
 
-.. code-block:: yaml
-
-    CentOS 7 - docker - 20161031-0802
-
 .. include:: cloud-images.rst
 
 Creating Jenkins Jobs
@@ -683,15 +737,6 @@ TODO: Document test-{project}-{feature} and test-{project}-all.
         </td>
       </tr>
 
-      <tr class="warning">
-        <td><b>Job Template</b><br/>integration-patch-test-{stream}</td>
-        <td><b>Gerrit Trigger</b><br/>test-integration</td>
-      </tr>
-      <tr>
-        <td colspan="2">
-        </td>
-      </tr>
-
       <tr class="warning">
         <td><b>Job Template</b><br/>integration-patch-test-{stream}</td>
         <td><b>Gerrit Trigger</b><br/>test-integration</td>
@@ -723,6 +768,27 @@ TODO: Document test-{project}-{feature} and test-{project}-all.
             </li>
         </td>
       </tr>
+
+      <tr class="warning">
+        <td><b>Job Template</b><br/>integration-multipatch-test-{stream}</td>
+        <td><b>Gerrit Trigger</b><br/>multipatch-build</td>
+      </tr>
+      <tr>
+        <td colspan="2">
+          This job builds a list of patches provided in an specific order, and finally builds
+          a distribution from either provided patch or latest code in branch.
+          For example if someone leaves the following comment in a patch:
+          multipatch-build:controller=61/29761/5:45/29645/6,neutron=51/65551/4,netvirt:59/60259/17
+          the job will checkout controller patch 61/29761/5, cherry-pick 45/29645/6 and build controller,
+          checkout neutron patch 51/65551/4 and build neutron, checkout latest netvirt code,
+          cherry-pick 59/60259/17 and build netvirt, finally it will checkout latest distribution
+          code and build a distribution. The resulting distribution is stored in Nexus and the URL
+          is stored in a variable called BUNDLE_URL visible in the job console.
+          This job should not alter Gerrit votes for a given patch, nor will do anything with the
+          given patch unless the patch is added to the build list.
+        </td>
+      </tr>
+
     </table>
 
 Maven Properties
@@ -863,6 +929,13 @@ can push them to the Jenkins sandbox.
         # Don't push all jobs by omitting the final param! (ctrl+c to abort)
         jenkins-jobs --conf jenkins.ini update jjb/ <job-name>
 
+Alternatively, you can push a job to the Jenkins sandbox with a special comment in a
+releng/builder gerrit patch. The job will be based off of the code your patch is
+based upon. Meaning, if your patch is changing something related to the job you are
+pushing, those changes will exist in the sandbox job. The format of the comment is::
+
+        jjb-deploy <job name>
+
 Running Jobs
 ^^^^^^^^^^^^