Add info about running jobs in Sandbox to JJB docs

[releng/builder.git] / src / site / markdown / jenkins.md

diff --git a/src/site/markdown/jenkins.md b/src/site/markdown/jenkins.md
index d1540a6877a1b245bda8fca0cc09eefe2657cd19..143cb250f75d7c81328e75f8862be0c839c67ca8 100644 (file)
--- a/src/site/markdown/jenkins.md
+++ b/src/site/markdown/jenkins.md
@@ -21,6 +21,9 @@ Sections:
 * [Jenkins Sandbox](#jenkins_sandbox)
     * [Configuration](#sandbox_config)
     * [Manual Method](#jjb_use_manual)
+        * [Test Jobs](#jjb_manual_test)
+        * [Push Jobs](#jjb_manual_push)
+        * [Run Jobs](#jjb_manual_run)
     * [Docker Method](#jjb_use_docker)
 
 # <a name="jenkins_master">Jenkins Master</a>
@@ -241,6 +244,34 @@ actual slave and start handling jobs on it.
   </tr>
 </table>
 
+<table class="table table-bordered">
+  <tr>
+    <td><b>Jenkins Label</b><br/> ubuntu_mininet</td>
+    <td><b>Slave Template name</b><br/> ubuntu-trusty-mininet</td>
+    <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ubuntu-mininet</td>
+    <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
+  </tr>
+  <tr>
+    <td colspan="4">
+      Basic Ubuntu system with ovs 2.0.2 and mininet 2.1.0
+    </td>
+  </tr>
+</table>
+
+<table class="table table-bordered">
+  <tr>
+    <td><b>Jenkins Label</b><br/> ubuntu_mininet_ovs_23</td>
+    <td><b>Slave Template name</b><br/> ubuntu-trusty-mininet-ovs-23</td>
+    <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ubuntu-mininet-ovs-23</td>
+    <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
+  </tr>
+  <tr>
+    <td colspan="4">
+      Basic Ubuntu system with ovs 2.3 and mininet 2.2.1
+    </td>
+  </tr>
+</table>
+
 ### Pool: Rackspace DFW - Matrix
 
 <table class="table table-bordered">
@@ -347,7 +378,7 @@ each use of JJB.
 
 The recommended way to install JJB is via pip.
 
-Clone the latest version of the [`releng/builder`][4] repo.
+First, clone the latest version of the [`releng/builder`][4] repo.
 
     $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git
 
@@ -356,22 +387,26 @@ and activated](#jjb_install_venv) a virtual environment for JJB.
 
     $ mkvirtualenv jjb
 
-When in doubt, the best version of JJB to attempt to use is the version
-specified in the [`builder/jjb/requirements.txt`][33] file.
+The recommended version of JJB to install is the version specified in the
+[`builder/jjb/requirements.txt`][33] file.
 
     # From the root of the releng/builder repo
     (jjb)$ pip install -r jjb/requirements.txt
 
+To validate that JJB was successfully installed you can run this command:
+
+    (jjb)$ jenkins-jobs --version
+
 To change the version of JJB specified by [`builder/jjb/requirements.txt`][33]
 to install from the latest commit to the master branch of JJB's git repository:
 
     $ cat jjb/requirements.txt
     -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder#egg=jenkins-job-builder
 
-To install from a tag, like 1.3.0:
+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.3.0#egg=jenkins-job-builder
+    -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder@1.4.0#egg=jenkins-job-builder
 
 #### <a name="jjb_install_manual">Installing JJB Manually</a>
 
@@ -385,11 +420,11 @@ For example, using master:
 
     $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
 
-Using a tag, like 1.3.0:
+Using a tag, like 1.4.0:
 
     $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
     $ cd jenkins-job-builder
-    $ git checkout tags/1.3.0
+    $ git checkout tags/1.4.0
 
 Before actually installing JJB and its dependencies, make sure you've [created
 and activated](#jjb_install_venv) a virtual environment for JJB.
@@ -397,18 +432,19 @@ and activated](#jjb_install_venv) a virtual environment for JJB.
     $ mkvirtualenv jjb
 
 You can then use [JJB's `requirements.txt`][20] file to install its
-dependences.
+dependencies. Note that we're not using `sudo` to install as root, since we want
+to make use of the venv we've configured for our current user.
 
     # In the cloned JJB repo, with the desired version of the code checked out
     (jjb)$ pip install -r requirements.txt
 
-Finally, install JJB.
+Then install JJB from the repo with:
 
-    # In the cloned JJB repo, with the desired version of the code checked out
-    (jjb)$ python setup.py install
+    (jjb)$ pip install .
+
+To validate that JJB was successfully installed you can run this command:
 
-Note that we're not using `sudo` to install as root, since we want to make
-use of the venv we've configured for our current user.
+    (jjb)$ jenkins-jobs --version
 
 ### <a name="jjb_install_docker">JJB Docker Image</a>
 
@@ -751,6 +787,24 @@ 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>
 
+### <a name="jjb_manual_run">Running Jobs</a>
+
+Once you have your Jenkins job configuration [pushed to the
+Sandbox](#jjb_manual_push) you can trigger it to run.
+
+Find your newly-pushed job on the [Sandbox's web UI][27]. Click on its name to
+see the job's details.
+
+Make sure you're [logged in][32] to the Sandbox.
+
+Click "Build with Parameters" and then "Build".
+
+Wait for your job to be scheduled and run. Click on the job number to see
+details, including console output.
+
+Make changes to your JJB configuration, re-test, re-push and re-run until
+your job is ready.
+
 ## <a name="jjb_use_docker">Docker Method</a>
 
 If [using Docker](#jjb_install_docker):