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