Merge "Update cirros image to latest version"

[functest.git] / docs / userguide / troubleshooting.rst

diff --git a/docs/userguide/troubleshooting.rst b/docs/userguide/troubleshooting.rst
index cd79baf..8455019 100644 (file)
--- a/docs/userguide/troubleshooting.rst
+++ b/docs/userguide/troubleshooting.rst
@@ -44,13 +44,10 @@ These test cases can be run inside the container, using new Functest CLI as foll
 
 The Functest CLI is designed to route a call to the corresponding internal
 python scripts, located in paths:
-*$repos_dir/functest/testcases/vPing/CI/libraries/vPing_ssh.py* and
-*$repos_dir/functest/testcases/vPing/CI/libraries/vPing_userdata.py*
+*$REPOS_DIR/functest/functest/opnfv_tests/vPing/CI/libraries/vPing_ssh.py* and
+*$REPOS_DIR/functest/functest/opnfv_tests/vPing/CI/libraries/vPing_userdata.py*
 
 Notes:
-  #. In this Colorado Funtest Userguide, the use of the Functest CLI is
-     emphasized. The Functest CLI replaces the earlier Bash shell script
-     *run_tests.sh*.
 
   #. There is one difference, between the Functest CLI based test case
      execution compared to the earlier used Bash shell script, which is
@@ -103,7 +100,7 @@ In this case, proceed to create it manually. These are some hints::
     --protocol tcp --port-range-min 80 --port-range-max 80 --remote-ip-prefix 0.0.0.0/0
 
 The next step is to create the instances. The image used is located in
-*/home/opnfv/functest/data/cirros-0.3.4-x86_64-disk.img* and a Glance image is created
+*/home/opnfv/functest/data/cirros-0.3.5-x86_64-disk.img* and a Glance image is created
 with the name **functest-vping**. If booting the instances fails (i.e. the status
 is not **ACTIVE**), you can check why it failed by doing::
 
@@ -125,7 +122,7 @@ This test case creates a floating IP on the external network and assigns it to
 the second instance **opnfv-vping-2**. The purpose of this is to establish
 a SSH connection to that instance and SCP a script that will ping the first
 instance. This script is located in the repository under
-*$repos_dir/functest/testcases/OpenStack/vPing/ping.sh* and takes an IP as
+*$REPOS_DIR/functest/functest/opnfv_tests/OpenStack/vPing/ping.sh* and takes an IP as
 a parameter. When the SCP is completed, the test will do an SSH call to that script
 inside the second instance. Some problems can happen here::
 
@@ -263,7 +260,7 @@ lead to errors in Rally as well.
 It is possible to run only one Rally scenario, instead of the whole suite.
 To do that, call the alternative python script as follows::
 
-  python $repos_dir/functest/testcases/OpenStack/rally/run_rally-cert.py -h
+  python $REPOS_DIR/functest/functest/opnfv_tests/OpenStack/rally/run_rally-cert.py -h
   usage: run_rally-cert.py [-h] [-d] [-r] [-s] [-v] [-n] test_name
 
   positional arguments:
@@ -282,7 +279,7 @@ To do that, call the alternative python script as follows::
 
 For example, to run the Glance scenario with debug information::
 
-  python $repos_dir/functest/testcases/OpenStack/rally/run_rally-cert.py -d glance
+  python $REPOS_DIR/functest/functest/opnfv_tests/OpenStack/rally/run_rally-cert.py -d glance
 
 Possible scenarios are:
  * authenticate
@@ -297,7 +294,7 @@ Possible scenarios are:
  * vm
 
 To know more about what those scenarios are doing, they are defined in directory:
-*$repos_dir/functest/testcases/OpenStack/rally/scenario*
+*$REPOS_DIR/functest/functest/opnfv_tests/OpenStack/rally/scenario*
 For more info about Rally scenario definition please refer to the Rally official
 documentation. `[3]`_
 
@@ -312,15 +309,19 @@ To check any possible problems with Rally, the logs are stored under
 Controllers
 -----------
 
-ODL
-^^^
-2 versions are supported in Colorado, depending on the scenario:
- * Lithium
- * Berylium
+Opendaylight
+^^^^^^^^^^^^
+
+If the Basic Restconf test suite fails, check that the ODL controller is
+reachable and its Restconf module has been installed.
+
+If the Neutron Reachability test fails, verify that the modules
+implementing Neutron requirements have been properly installed.
+
+If any of the other test cases fails, check that Neutron and ODL have
+been correctly configured to work together. Check Neutron configuration
+files, accounts, IP addresses etc.).
 
-The upstream test suites have not been adapted, so you may get 18 or 15 tests
-passed on 18 depending on your configuration. The 3 testcases are partly failed
-due to wrong return code.
 
 ONOS
 ^^^^
@@ -331,27 +332,21 @@ Please refer to the ONOS documentation. `ONOSFW User Guide`_ .
 Features
 --------
 
-
-Doctor
-^^^^^^
-Please refer to the Doctor documentation. `Doctor User Guide`_
+Please refer to the dedicated feature user guides for details.
 
 
-Promise
-^^^^^^^
-Please refer to the Promise documentation. `Promise User Guide`_
+security_scan
+^^^^^^^^^^^^^
 
+See OpenSCAP web site: https://www.open-scap.org/
 
-bgpvpn
-^^^^^^
-Please refer to the SNVPN documentation. `SDNVPN User Guide`_
 
 
 NFV
 ---
 
-vIMS
-^^^^
+cloudify_ims
+^^^^^^^^^^^^
 vIMS deployment may fail for several reasons, the most frequent ones are
 described in the following table:
 
@@ -383,4 +378,10 @@ described in the following table:
 +-----------------------------------+------------------------------------+
 
 
+parser
+^^^^^^
+
+For now log info is the only way to do trouble shooting
+
+
 .. _`OPNFV Functest Developer Guide`:  http://artifacts.opnfv.org/functest/docs/devguide/#