update documents

- fix outdated info
- correct mistakes

Change-Id: I8ac41e69d4ba6c2120c74c1af405083918282e21
Signed-off-by: zhihui wu <wu.zhihui1@zte.com.cn>

diff --git a/docs/testing/user/configguide/configuration.rst b/docs/testing/user/configguide/configuration.rst
index ae74534..d04f5ba 100644 (file)
--- a/docs/testing/user/configguide/configuration.rst
+++ b/docs/testing/user/configguide/configuration.rst
@@ -40,8 +40,9 @@ Run and enter the docker instance
 1. If you want to run benchmarks:
 ::
 
-  envs="INSTALLER_TYPE={INSTALLER_TYPE} -e INSTALLER_IP={INSTALLER_IP} -e  NODE_NAME={NODE_NAME}"
+  envs="INSTALLER_TYPE={INSTALLER_TYPE} -e INSTALLER_IP={INSTALLER_IP} -e NODE_NAME={NODE_NAME}"
   docker run -p [HOST_IP:]<HOST_PORT>:5000 --name qtip -id -e $envs opnfv/qtip
+  docker start qtip
   docker exec -i -t qtip /bin/bash
 
 ``INSTALLER_TYPE`` should be one of OPNFV installer, e.g. apex, compass, daisy, fuel
@@ -90,7 +91,7 @@ Environment configuration
 Hardware configuration
 ----------------------
 
-QTIP does not have specific hardware requriements, and it can runs over any
+QTIP does not have specific hardware requirements, and it can runs over any
 OPNFV installer.
 
 

diff --git a/docs/testing/user/userguide/compute.rst b/docs/testing/user/userguide/compute.rst
index f889bfe..7c5adc2 100644 (file)
--- a/docs/testing/user/userguide/compute.rst
+++ b/docs/testing/user/userguide/compute.rst
@@ -16,10 +16,11 @@ test compute components.
 
 All the compute benchmarks could be run in the scenario:
 On Baremetal Machines provisioned by an OPNFV installer (Host machines)
+On Virtual machines provisioned by OpenStack deployed by an OPNFV installer
 
 Note: The Compute benchmank constains relatively old benchmarks such as dhrystone
 and whetstone. The suite would be updated for better benchmarks such as Linbench for
-the OPNFV E release.
+the OPNFV future release.
 
 
 Getting started
@@ -32,7 +33,7 @@ Inventory File
 
 QTIP uses Ansible to trigger benchmark test. Ansible uses an inventory file to
 determine what hosts to work against. QTIP can automatically generate a inventory
-file via OPNFV installer. Users also can write their own inventory infomation into
+file via OPNFV installer. Users also can write their own inventory information into
 ``/home/opnfv/qtip/hosts``. This file is just a text file containing a list of host
 IP addresses. For example:
 ::
@@ -53,19 +54,33 @@ manual. If *CI_DEBUG* is not set or set to *false*, QTIP will delete the key fro
 remote hosts before the execution ends. Please make sure the key deleted from remote
 hosts or it can introduce a security flaw.
 
-Commands
---------
+Execution
+---------
 
-In a QTIP container, you can run compute QPI by using QTIP CLI:
-::
+There are two ways to execute compute QPI:
+
+* Script
+
+    You can run compute QPI with docker exec:
+    ::
+
+      # run with baremetal machines provisioned by an OPNFV installer
+      docker exec <qtip container> bash -x /home/opnfv/repos/qtip/qtip/scripts/quickstart.sh -q compute
+
+      # run with virtual machines provisioned by OpenStack
+      docker exec <qtip container> bash -x /home/opnfv/repos/qtip/qtip/scripts/quickstart.sh -q compute -u vnf
+
+* Commands
+
+    In a QTIP container, you can run compute QPI by using QTIP CLI. You can get more details from
+    *userguide/cli.rst*.
 
-  mkdir result
-  qtip plan run <plan_name> -p $PWD/result
+Test result
+------------
 
-QTIP generates results in the ``$PWD/result`` directory are listed down under the
+QTIP generates results in the ``/home/opnfv/<project_name>/results/`` directory are listed down under the
 timestamp name.
 
-you can get more details from *userguide/cli.rst*.
 
 Metrics
 -------

diff --git a/docs/testing/user/userguide/storage.rst b/docs/testing/user/userguide/storage.rst
index 7681ff7..9457e67 100644 (file)
--- a/docs/testing/user/userguide/storage.rst
+++ b/docs/testing/user/userguide/storage.rst
@@ -87,12 +87,23 @@ Then, you use the following commands to start storage QPI service.
 Execution
 ---------
 
-You can run storage QPI with docker exec:
-::
+* Script
+
+    You can run storage QPI with docker exec:
+    ::
+
+      docker exec <qtip container> bash -x /home/opnfv/repos/qtip/qtip/scripts/quickstart.sh
+
+* Commands
 
-  docker exec <qtip container> bash -x /home/opnfv/repos/qtip/qtip/scripts/quickstart.sh
+    In a QTIP container, you can run storage QPI by using QTIP CLI. You can get more
+    details from *userguide/cli.rst*.
+
+
+Test result
+------------
 
-QTIP generates results in the ``$PWD/results/`` directory are listed down under the
+QTIP generates results in the ``/home/opnfv/<project_name>/results/`` directory are listed down under the
 timestamp name.
 
 Metrics