Add a snippet about using jjb-deploy keyword

[integration/test.git] / docs / system-test-guide.rst

diff --git a/docs/system-test-guide.rst b/docs/system-test-guide.rst
index 731bd4164b180e99aa2813352c69748b9444b064..e76d64adde3545b1dd4ba8945e94d74d1466010e 100644 (file)
--- a/docs/system-test-guide.rst
+++ b/docs/system-test-guide.rst
@@ -100,8 +100,8 @@ configplans folder::
 
   vim test/csit/scriptplans/$project-$functionality.txt
 
-Save and push changes
-^^^^^^^^^^^^^^^^^^^^^
+Save and push Test changes
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 Add the changes and push them in the integration/test repo::
 
   git add -A
@@ -162,8 +162,8 @@ Explanation:
 * jobs: replace 1node by 3node if your test is develop for 3node cluster.
 * project: set your your project name here (e.g. openflowplugin).
 * functionality: set the functionality you want to test (e.g. flow-services).
-  Note this has also to match the robot test plan name you defined in earlier
-  `section <Create a test plan_>`_ (e.g. openflowplugin-flow-services.txt)
+  Note this has also to match the robot test plan name you defined in the earlier
+  section `<Create a test plan_>`_ (e.g. openflowplugin-flow-services.txt)
 * stream: list the project branches you are going to generate system test. Only
   last branch if the project is new.
 * install: this specifies controller installation, 'only' means only features in
@@ -357,9 +357,18 @@ Before pushing your system test job into jenkins-releng_, it is recommended to
 debug the job as well as the you system test code in the sandbox. To do that:
 
 * Set up sandbox access using jenkins-sandbox-install_ instruction.
-* Push you new csit job to sandbox::
+* Push your new csit job to sandbox:
 
-    jenkins-jobs --conf jenkins.ini update jjb/ $project-csit-1node-$functionality-only-$branch
+  Method 1:
+
+  you can write a comment in a releng/builder gerrit patch to have the job automatically created
+  in the sandbox. The format of the comment is::
+
+      jjb-deploy <job name>
+
+  Method 2::
+
+      jenkins-jobs --conf jenkins.ini update jjb/ $project-csit-1node-$functionality-only-$branch
 
 * Open your job in jenkins-sandbox_ and start a build replacing the PATCHREFSPEC
   parameter by your int/test patch REFSPEC (e.g. refs/changes/85/23185/1). you
@@ -384,8 +393,8 @@ Note this will run a self-made debug script with sudo access in a VM of your
 choice. In the example above you debug on the tools VM (TOOLS_SYSTEM_IP),
 use ODL_SYSTEM_IP to debug in controller VM.
 
-Save and push changes
-^^^^^^^^^^^^^^^^^^^^^
+Save and push JJB changes
+^^^^^^^^^^^^^^^^^^^^^^^^^
 Once you are happy with your system test, save the changes and push them in the
 releng builder repo::