Update documentation
[oam.git] / docs / faq.rst
1 .. contents::
2    :depth: 3
3 ..
4
5 Frequently asked questions
6 ==========================
7
8 Which browser should I use to operate Opendaylight SDN-R User interface?
9 ------------------------------------------------------------------------
10
11 An actual version of `Google
12 Chromium <https://www.chromium.org/getting-involved/download-chromium>`__
13 or `Google
14 Chrome <https://www.google.de/search?q=chrome+download&oq=chrome+download&aqs=chrome..69i57j0l5.2718j0j4&sourceid=chrome&ie=UTF-8>`__
15 is recommended.
16
17 --------------
18
19 How to enable detailed logs in karaf for SDN-R applications
20 -----------------------------------------------------------
21
22 If you like to see more details in karaf logs for the NetConf
23 communication between ODL and NetConf servers (mediators/devices) please
24 invoke the following commands in the karaf console.
25
26 ::
27
28     # Logging settings (on)
29     log:set DEBUG org.onap.ccsdk.features.sdnr
30     log:set TRACE org.opendaylight.netconf
31     log:set TRACE com.highstreet.technologies.odl.app
32
33 Please note, setting the debug level to 'TRACE' may impact the
34 performance on the controller. In production environment make sure to
35 set back the debug level to 'INFO' as soon possible.
36
37 ::
38
39     # Logging settings (off)
40     log:set INFO org.onap.ccsdk.features.sdnr
41     log:set INFO org.opendaylight.netconf
42     log:set INFO com.highstreet.technologies.odl.app
43
44 --------------
45
46 Which commands should be used to analyse karaf logs?
47 ----------------------------------------------------
48
49 ::
50
51     cd $ODL_KARAF_HOME/data/log
52     rm *.txt
53     grep -anr --include=*.log* "| ERROR |" . | grep 2018 >> 01-error.txt
54     grep -anr --include=*.log* "RemoteDevice{" . | grep 2018 >> 02-devices.txt
55     grep -anr --include=*.log* "RemoteDevice{" . | grep "Unable to build schema context, unsatisfied imports" | grep 2018 >> 03-schema-issue.txt
56     grep -anr --include=*.log* "Matched request:" . | grep 2018 >> 04-matched-request.txt
57     grep -anr --include=*.log* "network-element" . | grep 2018 >> 05-network-element.txt
58     grep -anr --include=*.log* "urn:onf:params:xml:ns:yang:core-model" . | grep 2018 >> 06-core-module.txt
59     grep -anr --include=*.log* "PerformanceManagerTask" . | grep 2018 >> 07-pm-tick.txt
60     grep -anr --include=*.log* "Unable to read NE data for mountpoint" . | grep 2018 >> 08-unable-to-read.txt
61     grep -anr --include=*.log* "LKCYFL79Q01M01MSS801" . | grep 2018 >> 09-LKCYFL79Q01M01MSS801.txt
62
63 How to report an odlux issue
64 ----------------------------
65
66 If you would like to report an odlux issue which you have noticed in the
67 Graphical User Interface, please provide the following information:
68
69 1. **Description**: In which application you have noticed the issue?
70
71 2. **Environment**:
72
73    -  Which browser is used and the version of the browser. eg: *Google
74       chrome - version 71.0.3578.80 / Mozilla Firefox.*
75    -  Which Operating system and version. eg: *Linux/ Windows 10 -
76       version 1803.*
77    -  In which language you are using the application.
78    -  The application URL which is available on the browser address bar.
79       eg: *http://hostname/odlux/index.html#/connectApp*
80
81 3. **Expected Result**: What is the expected result you are looking for?
82
83 4. **Actual Result**: What is the actual result you got?
84
85 5. **Steps to reproduce**: Describe the steps to reproduce the scenario.
86    If possible, please provide the screenshots
87
88 The above information helps us to analyze the problem quicker.