Merge "Install lftools into the openstack venv"

[releng/builder.git] / docs / jenkins.rst

diff --git a/docs/jenkins.rst b/docs/jenkins.rst
index 5c998e875855e6508c59661592c5292c34bc7547..93c5bdf6eec32550604a5c9699e90c6a157af901 100644 (file)
--- a/docs/jenkins.rst
+++ b/docs/jenkins.rst
@@ -1,3 +1,5 @@
+.. _odl-jenkins:
+
 Jenkins
 =======
 
@@ -202,50 +204,38 @@ accounts in the cloud so should ensure consistent performance.
      - CPUs
      - Memory
 
-   * - v2-standard-1
+   * - odl-standard-1
      - 1
      - 4
 
-   * - v2-standard-2
+   * - odl-standard-2
      - 2
      - 8
 
-   * - v2-standard-4
+   * - odl-standard-4
      - 4
      - 16
 
-   * - v2-standard-8
+   * - odl-standard-8
      - 8
      - 32
 
-   * - v2-standard-16
+   * - odl-standard-16
      - 16
      - 64
 
-   * - v2-highcpu-1
-     - 1
-     - 1
-
-   * - v2-highcpu-2
+   * - odl-highcpu-2
      - 2
      - 2
 
-   * - v2-highcpu-4
+   * - odl-highcpu-4
      - 4
      - 4
 
-   * - v2-highcpu-8
+   * - odl-highcpu-8
      - 8
      - 8
 
-   * - v2-highcpu-16
-     - 16
-     - 16
-
-   * - v2-highcpu-32
-     - 32
-     - 32
-
 Pool: ODLVEX
 ^^^^^^^^^^^^
 
@@ -253,13 +243,21 @@ Pool: ODLVEX
 
     <table class="table table-bordered">
       <tr class="warning">
-        <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>Jenkins Labels</b><br/>
+          centos7-builder-2c-1g,<br/>
+          centos7-builder-2c-2g,<br/>
+          centos7-builder-2c-8g,<br/>
+          centos7-builder-4c-4g,<br/>
+          centos7-builder-8c-8g,<br/>
+          centos7-autorelease-4c-16g
+        </td>
+        <td><b>Minion Template names</b><br/>
+          prd-centos7-builder-2c-1g,<br/>
+          prd-centos7-builder-2c-2g,<br/>
+          prd-centos7-builder-2c-8g,<br/>
+          prd-centos7-builder-4c-4g,<br/>
+          prd-centos7-builder-8c-8g,<br/>
+          prd-centos7-autorelease-4c-16g
         <td><b>Packer Template</b><br/>
         releng/builder/packer/templates/builder.json</td>
         <td><b>Spinup Script</b><br/>
@@ -529,6 +527,29 @@ To install from a tag, like 1.4.0:
     $ cat jjb/requirements.txt
     -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder@1.4.0#egg=jenkins-job-builder
 
+Updating releng/builder repo or global-jjb
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Follow these steps to update the releng/builder repo. The repo uses a submodule from
+a global-jjb repo so that common source can be shared across different projects. This
+requires updating the releng/builder repo periodically to pick up the changes. New
+versions of jjb could also require updating the releng/builder repo. Follow the
+previous steps earlier for updating jenkins-jobs using the
+`builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file. Ensure that the
+version listed in the file is the currently supported version, otherwise install a
+different version or simply upgrade using `pip install --upgrade jenkins-job-builder`.
+
+The example below assumes the user has cloned releng/builder to `~/git/releng/builder`.
+Update the repo, update the submodules and then submit a test to verify it works.
+
+.. code-block:: bash
+
+    cd ~/git/releng/builder
+    git checkout master
+    git pull
+    git submodule update --init --recursive
+    jenkins-jobs --conf jenkins.ini test jjb/ netvirt-csit-1node-openstack-queens-upstream-stateful-fluorine
+
 Installing JJB Manually
 -----------------------
 
@@ -784,6 +805,7 @@ TODO: Document test-{project}-{feature} and test-{project}-all.
           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.
+          Use multipatch-build-fast (vs multipatch-build) for building projects fast (-Pq).
           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>
@@ -809,6 +831,8 @@ wish to run in your project.
                 Maven property
                 <sonar>true</sonar>.
 
+.. _odl-jenkins-sandbox:
+
 Jenkins Sandbox
 ---------------
 
@@ -936,6 +960,11 @@ pushing, those changes will exist in the sandbox job. The format of the comment
 
         jjb-deploy <job name>
 
+.. note::
+
+    Also note that wildcards can be used in <job name> which
+    will expand all jobs that exist for the pattern.
+
 Running Jobs
 ^^^^^^^^^^^^