Create troubleshooting guide as a separate .rst
[functest.git] / docs / userguide / troubleshooting.rst
1
2 Troubleshooting
3 ===============
4
5 VIM
6 ---
7
8 vPing_SSH
9 ^^^^^^^^^
10
11 vPing should work on all the scenarios. In case of timeout, check your network
12 connectivity. The test case creates its own security group to allow SSH access,
13 check your network settings and your security rules.
14
15
16 vPing_userdata
17 ^^^^^^^^^^^^^^
18
19 Cloud-init in not supported on scenario dealing with ONOS.
20
21 Tempest
22 ^^^^^^^
23
24 In the upstream OpenStack CI all the Tempest test cases are supposed to pass.
25 If some test cases fail in an OPNFV deployment, the reason is very probably one
26 of the following::
27
28  +-----------------------------+------------------------------------------------+
29  | Error                       | Details                                        |
30  +=============================+================================================+
31  | Resources required for test | Such resources could be e.g. an external       |
32  | case execution are missing  | network and access to the management subnet    |
33  |                             | (adminURL) from the Functest docker container. |
34  +-----------------------------+------------------------------------------------+
35  | OpenStack components or     | Check running services in the controller and   |
36  | services are missing or not | compute nodes (e.g. with "systemctl" or        |
37  | configured properly         | "service" commands). Configuration parameters  |
38  |                             | can be verified from related .conf files       |
39  |                             | located under /etc/<component> directories.    |
40  +-----------------------------+------------------------------------------------+
41  | Some resources required for | The tempest.conf file, automatically generated |
42  | execution test cases are    | by Rally in Functest, does not contain all the |
43  | missing                     | needed parameters or some parameters are not   |
44  |                             | set properly.                                  |
45  |                             | The tempest.conf file is located in /home/opnfv|
46  |                             | /.rally/tempest/for-deployment-<UUID> in       |
47  |                             | Functest container                             |
48  |                             | Use "rally deployment list" command in order to|
49  |                             | check UUID of current deployment.              |
50  +-----------------------------+------------------------------------------------+
51
52
53 When some Tempest test case fails, captured traceback and possibly also related
54 REST API requests/responses are output to the console.
55 More detailed debug information can be found from tempest.log file stored into
56 related Rally deployment folder.
57
58
59 Rally
60 ^^^^^
61
62 Same error causes than for Tempest mentioned above may lead to error in Rally.
63
64 Controllers
65 -----------
66
67 ODL
68 ^^^
69 2 versions are supported in Brahmaputra depending on the scenario:
70  * Lithium
71  * Berylium
72
73 The upstream test suites have not been adapted, so you may get 18 or 15 tests
74 passed on 18 depending on your configuration. The 3 testcases are partly failed
75 due to wrong return code.
76
77 ONOS
78 ^^^^
79
80 TODO
81
82 OpenContrail
83 ^^^^^^^^^^^^
84
85
86 Feature
87 -------
88
89 vIMS
90 ^^^^
91 vIMS deployment may fail for several reasons, the most frequent ones are
92 described in the following table:
93
94 +===================================+====================================+
95 | Error                             |  Comments                          |
96 +-----------------------------------+------------------------------------+
97 | Keystone admin API  not reachable | Impossible to create vIMS user and |
98 |                                   | tenant                             |
99 +-----------------------------------+------------------------------------+
100 | Impossible to retrieve admin role | Impossible to create vIMS user and |
101 | id                                | tenant                             |
102 +-----------------------------------+------------------------------------+
103 | Error when uploading image from   | impossible to deploy VNF           |
104 | OpenStack to glance               |                                    |
105 +-----------------------------------+------------------------------------+
106 | Cinder quota cannot be updated    | Default quotas not sufficient, they|
107 |                                   | are adapted in the script          |
108 +-----------------------------------+------------------------------------+
109 | Impossible to create a volume     | VNF cannot be deployed             |
110 +-----------------------------------+------------------------------------+
111 | SSH connection issue between the  | if vPing test fails, vIMS test will|
112 | Test container and the VM         | fail...                            |
113 +-----------------------------------+------------------------------------+
114 | No Internet access from a VM      | the VMs of the VNF must have an    |
115 |                                   | external access to Internet        |
116 +-----------------------------------+------------------------------------+
117
118
119 Promise
120 ^^^^^^^
121
122 TODO