Add task file and test case description file for TC063_StorageCapacity

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

diff --git a/docs/userguide/03-installation.rst b/docs/userguide/03-installation.rst
index 47a3ea8..a3144ef 100644 (file)
--- a/docs/userguide/03-installation.rst
+++ b/docs/userguide/03-installation.rst
@@ -1,7 +1,7 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International
 .. License.
 .. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, Ericsson AB and others.
+.. (c) OPNFV, Ericsson AB, Huawei Technologies Co.,Ltd and others.
 
 Yardstick Installation
 ======================
@@ -34,8 +34,20 @@ Installing Yardstick framework
 Install dependencies:
 ::
 
-  sudo apt-get install python-virtualenv python-dev
-  sudo apt-get install libffi-dev libssl-dev git
+  sudo apt-get update && sudo apt-get install -y \
+      wget \
+      git \
+      sshpass \
+      qemu-utils \
+      kpartx \
+      libffi-dev \
+      libssl-dev \
+      python \
+      python-dev \
+      python-virtualenv \
+      libxml2-dev \
+      libxslt1-dev \
+      python-setuptools
 
 Create a python virtual environment, source it and update setuptools:
 ::
@@ -65,6 +77,7 @@ Yardstick has an internal plotting tool ``yardstick-plot``, which can be install
 using the following command:
 ::
 
+  sudo apt-get install -y g++ libfreetype6-dev libpng-dev pkg-config
   python setup.py develop easy_install yardstick[plot]
 
 .. _guest-image:
@@ -75,6 +88,14 @@ Yardstick has a tool for building an Ubuntu Cloud Server image containing all
 the required tools to run test cases supported by Yardstick. It is necessary to
 have sudo rights to use this tool.
 
+Also you may need install several additional packages to use this tool, by
+follwing the commands below:
+::
+
+  apt-get update && apt-get install -y \
+      qemu-utils \
+      kpartx
+
 This image can be built using the following command while in the directory where
 Yardstick is installed (``~/yardstick`` if the framework is installed
 by following the commands above):
@@ -134,7 +155,10 @@ Pull the Yardstick-CI Docker image from Docker hub:
 
 ::
 
-  docker pull opnfv/yardstick-ci
+  docker pull opnfv/yardstick:$DOCKER_TAG
+
+Where ``$DOCKER_TAG`` is latest for master branch, as for the release branches,
+this coincides with its release name, such as brahmaputra.1.0.
 
 Run the Docker image:
 
@@ -146,11 +170,20 @@ Run the Docker image:
     -t \
     -e "INSTALLER_TYPE=${INSTALLER_TYPE}" \
     -e "INSTALLER_IP=${INSTALLER_IP}" \
-    opnfv/yardstick-ci \
-    run_benchmarks
-
-Where ``${INSTALLER_TYPE}`` can be fuel, foreman or compass and ``${INSTALLER_IP}``
-is the installer master node IP address (i.e. 10.20.0.2 is default for fuel).
+    opnfv/yardstick \
+    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}``
+is the IP and port number of DB, ``${YARDSTICK_SUITE_NAME}`` is the test suite you want to run.
+For more details, please refer to the Jenkins job defined in Releng project, labconfig information
+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: