Doc: added required libraries and python modules

JIRA: FUNCTEST-9

Change-Id: Ie86cdb9883a875ac3fd44708abe8ce3453def8c5
Signed-off-by: jose.lausuch <jose.lausuch@ericsson.com>

diff --git a/docs/functest.rst b/docs/functest.rst
index 3e2d4f1..3db860f 100644 (file)
--- a/docs/functest.rst
+++ b/docs/functest.rst
@@ -76,6 +76,22 @@ For release 1, the tools are automatically installed, but the tests are not full
 .. _pharos: https://wiki.opnfv.org/pharos
 
 It is recommended to install the different tools on the jump host server as defined in the pharos_ project.
+
+For functest, the following libraries are needed. You can install them either with yum install or apt-get install, depending on your operating system:
+ * python-pip
+ * python-dev
+ * libffi-dev
+ * libxml2-dev
+ * libxslt1-dev
+
+You will also need some Python modules:
+ * sudo pip install GitPython
+ * sudo pip install python-novaclient
+ * sudo pip install python-neutronclient
+ * sudo pip install python-glanceclient
+ * sudo pip install python-keystoneclient
+
+
 The high level architecture can be described as follow::
 
  CIMC/Lights+out management                  Admin     Private   Public   Storage
@@ -292,7 +308,7 @@ This script will:
 
 
 When integrated in CI, the only prerequisite consists in retrieving the OpenStack credentials (rc file).
-This file shall be saved on the jumphost. It must be sourced by the user (who shall have sudo rights) executing the tests. 
+This file shall be saved on the jumphost. It must be sourced by the user (who shall have sudo rights) executing the tests.
 
 For the Continuous Integration we store this file under $HOME/functest/opnfv-openrc.sh on the jumphost server so CI can automatically execute the suite of tests
 
@@ -538,7 +554,7 @@ OpenDaylight
 .. _`functest wiki (ODL section)`: https://wiki.opnfv.org/r1_odl_suite
 
 
-The results of ODL tests can be seen in the console:: 
+The results of ODL tests can be seen in the console::
 
  ==============================================================================
  Basic