Merge "rename test suite script"

[yardstick.git] / docs / userguide / 03-installation.rst

diff --git a/docs/userguide/03-installation.rst b/docs/userguide/03-installation.rst
index 1a74955..a3144ef 100644 (file)
--- a/docs/userguide/03-installation.rst
+++ b/docs/userguide/03-installation.rst
@@ -171,7 +171,7 @@ Run the Docker image:
     -e "INSTALLER_TYPE=${INSTALLER_TYPE}" \
     -e "INSTALLER_IP=${INSTALLER_IP}" \
     opnfv/yardstick \
-    run_tests.sh ${YARDSTICK_DB_BACKEND} ${YARDSTICK_SUITE_NAME}
+    exec_tests.sh ${YARDSTICK_DB_BACKEND} ${YARDSTICK_SUITE_NAME}
 
 Where ``${INSTALLER_TYPE}`` can be apex, compass, fuel or joid, ``${INSTALLER_IP}``
 is the installer master node IP address (i.e. 10.20.0.2 is default for fuel). ``${YARDSTICK_DB_BACKEND}``
@@ -180,6 +180,11 @@ For more details, please refer to the Jenkins job defined in Releng project, lab
 and sshkey are required. See the link
 https://git.opnfv.org/cgit/releng/tree/jjb/yardstick/yardstick-ci-jobs.yml.
 
+Note: exec_tests.sh is used for executing test suite here, furthermore, if someone wants to execute the
+test suite manually, it can be used as long as the parameters are configured correct. Another script
+called run_tests.sh is used for unittest in Jenkins verify job, in local manaul environment,
+it is recommended to run before test suite execuation.
+
 Basic steps performed by the **Yardstick-CI** container:
 
 1. clone yardstick and releng repos