SDN-R read2docs

Add docs folder and project with src

Change-Id: I0299c5984c747a40a8dd1e3f79479b9e9d729d50
Issue-ID: SDNC-683
Signed-off-by: Herbert Eiselt <herbert.eiselt@highstreet-technologies.com>

14 files changed, 416 insertions, 0 deletions

diff --git a/docs/guides/onap-user/ONAP-SDN-R.png b/docs/guides/onap-user/ONAP-SDN-R.png
new file mode 100644
index 000000000..cc7bd8a2a
--- /dev/null
+++ b/docs/guides/onap-user/ONAP-SDN-R.png
diff --git a/docs/guides/onap-user/abbreviations.rst b/docs/guides/onap-user/abbreviations.rst
new file mode 100644
index 000000000..3f4ab76d3
--- /dev/null
+++ b/docs/guides/onap-user/abbreviations.rst
@@ -0,0 +1,32 @@
+.. contents::
+   :depth: 3
+..
+
+Abbreviations
+=============
+
++--------------------+----------------------------------------------------------------------------------------------------------------+
+| **Abbreviation**   | **Description**                                                                                                |
++====================+================================================================================================================+
+| A&AI               | `Active and Available Inventory <https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project>`__   |
++--------------------+----------------------------------------------------------------------------------------------------------------+
+| AAA                | `Authentication, Authorization and Accounting <https://en.wikipedia.org/wiki/AAA_(computer_security)>`__       |
++--------------------+----------------------------------------------------------------------------------------------------------------+
+| DCAE               | `Data Collection Analytics & Events <https://wiki.onap.org/pages/viewpage.action?pageId=6592895>`__            |
++--------------------+----------------------------------------------------------------------------------------------------------------+
+| GUI                | `Graphical User Interface <https://en.wikipedia.org/wiki/Graphical_user_interface>`__                          |
++--------------------+----------------------------------------------------------------------------------------------------------------+
+| MSO                | `Master Service Orchestrator <https://wiki.onap.org/pages/viewpage.action?pageId=1015834>`__                   |
++--------------------+----------------------------------------------------------------------------------------------------------------+
+| ONAP               | `Open Network Automation Platform <https://wiki.onap.org/pages/viewpage.action?pageId=1015843>`__              |
++--------------------+----------------------------------------------------------------------------------------------------------------+
+| SDN                | `Software-defined networking <https://en.wikipedia.org/wiki/Software-defined_networking>`__                    |
++--------------------+----------------------------------------------------------------------------------------------------------------+
+| SDN-C              | `SDN-Controller <https://wiki.onap.org/display/DW/SDN+Controller+Development+Guide>`__                         |
++--------------------+----------------------------------------------------------------------------------------------------------------+
+| SDN-R              | `SDN-Radio <https://wiki.onap.org/display/DW/SDN-R>`__                                                         |
++--------------------+----------------------------------------------------------------------------------------------------------------+
+| UI                 | `User Interface <https://en.wikipedia.org/wiki/User_interface>`__                                              |
++--------------------+----------------------------------------------------------------------------------------------------------------+
+| UX                 | `User Experience <https://en.wikipedia.org/wiki/User_experience>`__                                            |
++--------------------+----------------------------------------------------------------------------------------------------------------+
diff --git a/docs/guides/onap-user/connect.rst b/docs/guides/onap-user/connect.rst
new file mode 100644
index 000000000..9678dd6ff
--- /dev/null
+++ b/docs/guides/onap-user/connect.rst
@@ -0,0 +1,48 @@
+.. contents::
+   :depth: 3
+..
+
+Connect
+=======
+
+The 'Connect' application on OpenDaylight provides up-to-date
+connectivity information about the wireless devices in the network. It
+automatically displays new network elements and their connection status.
+Despite the network elements usually automatically mount themselves, an
+additional small window allows manually mounting devices/mediators. For
+better understanding alarms and status, a connection status log lists
+all the connection status changes of OpenDaylight mount points.
+
+Views
+-----
+
+The graphical user interfaces is divided in three sections.
+
+Required Network Elements
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Required Network Elements are physical network functions, which are
+planned or expected in the network. This means the identifier, IP
+addresses and its required configuration is well-known and available in
+a planning database or in ONAP A&AI.
+
+This view also offer to manually configure/mount the device with the '+'
+icon. The SDN controller will then start connecting the Netconf server.
+
+Unknown Network Elements
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Most of the physical network function support an automatic registration
+procedure to the SDN controller. It may happen, that devices are
+connected to the SDN Controller but not available in planning data.
+
+It might be a normal occurrence for very cheap devices, where an entire
+planning process to too expensive. But is may also happen that the
+identifier used in planning process differ from the identifier currently
+configured in the device.
+
+Connection Status Log
+~~~~~~~~~~~~~~~~~~~~~
+
+The log lists the connections status changes between SDN Controller and
+NetConf servers (devices).
diff --git a/docs/guides/onap-user/faq.rst b/docs/guides/onap-user/faq.rst
new file mode 100644
index 000000000..7c764ead2
--- /dev/null
+++ b/docs/guides/onap-user/faq.rst
@@ -0,0 +1,88 @@
+.. contents::
+   :depth: 3
+..
+
+Frequently asked questions
+==========================
+
+Which browser should I use to operate Opendaylight SDN-R User interface?
+------------------------------------------------------------------------
+
+An actual version of `Google
+Chromium <https://www.chromium.org/getting-involved/download-chromium>`__
+or `Google
+Chrome <https://www.google.de/search?q=chrome+download&oq=chrome+download&aqs=chrome..69i57j0l5.2718j0j4&sourceid=chrome&ie=UTF-8>`__
+is recommended.
+
+--------------
+
+How to enable detailed logs in karaf for SDN-R applications
+-----------------------------------------------------------
+
+If you like to see more details in karaf logs for the NetConf
+communication between ODL and NetConf servers (mediators/devices) please
+invoke the following commands in the karaf console.
+
+::
+
+    # Logging settings (on)
+    log:set DEBUG org.opendaylight.mwtn
+    log:set TRACE org.opendaylight.netconf
+    log:set TRACE com.highstreet.technologies.odl.app
+
+Please note, setting the debug level to 'TRACE' may impact the
+performance on the controller. In production environment make sure to
+set back the debug level to 'INFO' as soon possible.
+
+::
+
+    # Logging settings (off)
+    log:set INFO org.opendaylight.mwtn
+    log:set INFO org.opendaylight.netconf
+    log:set INFO com.highstreet.technologies.odl.app
+
+--------------
+
+Which commands should be used to analyse karaf logs?
+----------------------------------------------------
+
+::
+
+    cd $ODL_KARAF_HOME/data/log
+    rm *.txt
+    grep -anr --include=*.log* "| ERROR |" . | grep 2018 >> 01-error.txt
+    grep -anr --include=*.log* "RemoteDevice{" . | grep 2018 >> 02-devices.txt
+    grep -anr --include=*.log* "RemoteDevice{" . | grep "Unable to build schema context, unsatisfied imports" | grep 2018 >> 03-schema-issue.txt
+    grep -anr --include=*.log* "Matched request:" . | grep 2018 >> 04-matched-request.txt
+    grep -anr --include=*.log* "network-element" . | grep 2018 >> 05-network-element.txt
+    grep -anr --include=*.log* "urn:onf:params:xml:ns:yang:core-model" . | grep 2018 >> 06-core-module.txt
+    grep -anr --include=*.log* "PerformanceManagerTask" . | grep 2018 >> 07-pm-tick.txt
+    grep -anr --include=*.log* "Unable to read NE data for mountpoint" . | grep 2018 >> 08-unable-to-read.txt
+    grep -anr --include=*.log* "LKCYFL79Q01M01MSS801" . | grep 2018 >> 09-LKCYFL79Q01M01MSS801.txt
+
+How to report an odlux issue
+----------------------------
+
+If you would like to report an odlux issue which you have noticed in the
+Graphical User Interface, please provide the following information:
+
+1. **Description**: In which application you have noticed the issue?
+
+2. **Environment**:
+
+   -  Which browser is used and the version of the browser. eg: *Google
+      chrome - version 71.0.3578.80 / Mozilla Firefox.*
+   -  Which Operating system and version. eg: *Linux/ Windows 10 -
+      version 1803.*
+   -  In which language you are using the application.
+   -  The application URL which is available on the browser address bar.
+      eg: *http://hostname/odlux/index.html#/connectApp*
+
+3. **Expected Result**: What is the expected result you are looking for?
+
+4. **Actual Result**: What is the actual result you got?
+
+5. **Steps to reproduce**: Describe the steps to reproduce the scenario.
+   If possible, please provide the screenshots
+
+The above information helps us to analyze the problem quicker.
diff --git a/docs/guides/onap-user/home.rst b/docs/guides/onap-user/home.rst
new file mode 100644
index 000000000..cf8b19254
--- /dev/null
+++ b/docs/guides/onap-user/home.rst
@@ -0,0 +1,34 @@
+
+.. contents::
+   :depth: 3
+..
+
+SDN controller for 'Radio' (SDN-R)
+==================================
+
+SDN-R adds features and functionality to the OpenDaylight-based ONAP
+controller 'SDN-C'. It is built on the Common Controller Framework to
+control and manage wireless resources. Wireless resources are virtual
+network functions (e.g. vBBU, vEPC) or physical network functions (e.g.
+microwave and millimeter wave radios, eNodeB, RRH, DAS equipment).
+
+| SDN-R is integrated into ONAP. Therefore it is interfacing with PNFs
+  and VNFs and with other ONAP components, such as A&AI, DCAE and SO.
+| `See abbreviations <abbreviations>`__
+
+.. figure:: ./ONAP-SDN-R.png
+   :alt: SDN-R in ONAP
+
+   SDN-R in ONAP
+
+
+.. toctree::
+   :maxdepth: 1
+
+   connect
+   pnfFault
+   pnfMaintenance
+   pnfConfig
+   pnfPerformance
+   pnfInventory
+   pnfMediator
diff --git a/docs/guides/onap-user/mwtnLog.rst b/docs/guides/onap-user/mwtnLog.rst
new file mode 100644
index 000000000..dce9539bb
--- /dev/null
+++ b/docs/guides/onap-user/mwtnLog.rst
@@ -0,0 +1,10 @@
+.. contents::
+   :depth: 3
+..
+
+Log
+===
+
+The application displays (UX) application logs. SDN-R offer a common log
+server, so that PNFs or other ONAP/ECOMP components could log there data
+in a common way.
diff --git a/docs/guides/onap-user/mwtnTest.rst b/docs/guides/onap-user/mwtnTest.rst
new file mode 100644
index 000000000..1c012fc0c
--- /dev/null
+++ b/docs/guides/onap-user/mwtnTest.rst
@@ -0,0 +1,9 @@
+.. contents::
+   :depth: 3
+..
+
+Test
+====
+
+The view offers in a generic way data fetched from ONF-TR-532 devices
+for test and debug purposes.
diff --git a/docs/guides/onap-user/pnfConfig.rst b/docs/guides/onap-user/pnfConfig.rst
new file mode 100644
index 000000000..f751255d4
--- /dev/null
+++ b/docs/guides/onap-user/pnfConfig.rst
@@ -0,0 +1,26 @@
+.. contents::
+   :depth: 3
+..
+
+Configuration
+=============
+
+The application shows the actual values of all attributes of the
+ONF-TR-532 for a selected physical network function (PNF). Each view of
+a functional element is divide into capabilities, configuration, status,
+current problem, current performance and history performance information
+according to TR-532.
+
+A separate window is available for modifying the configuration. All
+changes made are sent to the device in a single NetConf bulk request.
+The operator is notified about successfully configuring the device.
+
+Implementation
+--------------
+
+The applications are implemented as OpenDaylight-DLUX web application
+using the RestConf northbound interface of the SDN controller. The key
+frameworks are: Maven, Angular.js, Bootstrap and UI-Grid.
+
+Connections status information are updated automatically due to a web
+socket for notifications from OpenDaylight to the browser.
diff --git a/docs/guides/onap-user/pnfFault.rst b/docs/guides/onap-user/pnfFault.rst
new file mode 100644
index 000000000..ff3a1ac47
--- /dev/null
+++ b/docs/guides/onap-user/pnfFault.rst
@@ -0,0 +1,59 @@
+.. contents::
+   :depth: 3
+..
+
+Fault Management
+================
+
+To operate a network, it is important to get an overview about the
+currently raised alarms. The application offers basic fault management
+of devices supporting ONF-TR-532. The alarms are classified according to
+the severity level (warning, minor, major, critical).
+
+Views
+-----
+
+The graphical user interface is separated in three views.
+
+Current Alarms
+~~~~~~~~~~~~~~
+
+It list all current active faults in the network. In addition it also
+list alarms sent by the SDN controller itself, which detects connections
+losses to the NetConf server (connectionLossOAM) or which detects
+connection loss to a devices via a mediator to a device
+(connectionLossNeOAM).
+
+Alarm Notifications
+~~~~~~~~~~~~~~~~~~~
+
+As long as the view is open, it lists all alarm notification reached by
+the SDN Controller. Please note that refreshing the view will start the
+collection again. Previous alarm notification can be viewed in the alarm
+log.
+
+Alarm Log
+~~~~~~~~~
+
+Next to the current active alarms an alarm log lists all alarm
+notifications of the past.
+
+Implementation
+--------------
+
+The application has two parts. While the server is listening for NetConf
+notifications to store them in the database the client retrieves the
+information from the database and displays them in a grid view.
+
+The server synchronizes with the current alarm lists of the devices and
+calculates based on raise and clear notifications the current alarm
+status of the network. The current alarms are stored in a database. In
+addition all Problem Notifications received by the SDN controller are
+stored. There is no logic implemented on the client.
+
+An alarm status bar on top of each graphical user interface informs the
+operator about the health status of the network.
+
+The OpenDaylight DLUX web application uses web sockets for updating the
+graphical user interface in case of Problem Notification (devices) and
+Connection Status Notifications (ODL).
diff --git a/docs/guides/onap-user/pnfInventory.rst b/docs/guides/onap-user/pnfInventory.rst
new file mode 100644
index 000000000..0a9bf16c7
--- /dev/null
+++ b/docs/guides/onap-user/pnfInventory.rst
@@ -0,0 +1,35 @@
+.. contents::
+   :depth: 3
+..
+
+Inventory
+=========
+
+The application offers basic inventory management of devices supporting
+ONF-TR-512.
+
+The view displays the inventory data of the network element - basically
+serial-numbers and part-numbers are displaced according to the
+containment of the equipment.
+
+Inventory Export:
+-----------------
+
+As the default pagination size is set to 10, when you export the data
+only first 10 rows or the first 10 filtered rows shown on the page will
+be exported to a file. The inventory export allows the export of up to
+1000 entries, when the pagination size is increased to 1000.  So, It is
+recommended to change the pagination size 'Rows per page' to 1000 if you
+want to export the complete Inventory data.
+
+To export the Inventory data: The behaviour is different depending on
+the browser:
+
+a) Some browsers allows you to save the file with the predefined name
+   export.csv. In case your browser does not offer this function please
+   use 'Save as..' option and define the filename with extension csv.
+
+b) Some browsers saves the file automatically with the alphanumeric name
+   without an extension. In such case please go to the downloaded file
+   location and rename the file with the extension after the download.
+   (eg: export\_file.csv)
diff --git a/docs/guides/onap-user/pnfMaintenance.rst b/docs/guides/onap-user/pnfMaintenance.rst
new file mode 100644
index 000000000..9a0be0b00
--- /dev/null
+++ b/docs/guides/onap-user/pnfMaintenance.rst
@@ -0,0 +1,23 @@
+.. contents::
+   :depth: 3
+..
+
+Maintenance
+===========
+
+The 'Maintenance' application on the OpenDaylight provides the
+information of the Network Elements which are set for Maintenance,
+currently or in the future. User can manage devices to set the
+maintenance mode so that no unnecessary alarms are created. When the
+device is in Maintenace alarms are not forwarded to DCAE and when the
+device maintenance is turned off the alarms will start flowing again.
+
+'Active' field in this application shows if the Network Element is in
+maintenance mode currently or not. If it is 'active' it means the
+Network Element is currently undergoing maintenance, If 'not active' it
+means maintenance might have been set for future or maintenance is
+already completed.
+
+Users have access to disable the Maintenance mode or change the
+maintenance start and end dates at any point of time by using the
+available options in actions column.
diff --git a/docs/guides/onap-user/pnfMediator.rst b/docs/guides/onap-user/pnfMediator.rst
new file mode 100644
index 000000000..43aefb9c0
--- /dev/null
+++ b/docs/guides/onap-user/pnfMediator.rst
@@ -0,0 +1,11 @@
+.. contents::
+   :depth: 3
+..
+
+Mediator
+========
+
+Some device vendors (Altiostar, CommScope, Dragonwave-X) uses the
+`generic mediator
+framework <https://github.com/Melacon/NetConf2SNMP>`__. Such mediator
+offers an API to create, delete, start and stop mediator instances.
diff --git a/docs/guides/onap-user/pnfPerformance.rst b/docs/guides/onap-user/pnfPerformance.rst
new file mode 100644
index 000000000..9a1a8fcb5
--- /dev/null
+++ b/docs/guides/onap-user/pnfPerformance.rst
@@ -0,0 +1,20 @@
+.. contents::
+   :depth: 3
+..
+
+Performance
+===========
+
+Performance Monitoring values measured by the devices are necessary to
+analyze and optimize the network. Therefore the application
+automatically retrieves all historical performance values from the
+devices and stores them in a database. The client part just retrieves
+the values from the database and displays them in graphical user
+interface.
+
+Performance history values
+--------------------------
+
+After selection of a connected PNF supporting ONF-TR-532 and an physical
+interface, the application collects the received and centralized stored
+performance values for this interface and displays them in table views.
diff --git a/docs/guides/onap-user/sdnr.rst b/docs/guides/onap-user/sdnr.rst
new file mode 100644
index 000000000..804556b16
--- /dev/null
+++ b/docs/guides/onap-user/sdnr.rst
@@ -0,0 +1,21 @@
+.. contents::
+   :depth: 3
+..
+
+SDN controller for 'Radio' (SDN-R)
+==================================
+
+SDN-R adds features and functionality to the OpenDaylight-based ONAP
+controller 'SDN-C'. It is built on the Common Controller Framework to
+control and manage wireless resources. Wireless resources are virtual
+network functions (e.g. vBBU, vEPC) or physical network functions (e.g.
+microwave and millimeter wave radios, eNodeB, RRH, DAS equipment).
+
+| SDN-R is integrated into ONAP. Therefore it is interfacing with PNFs
+  and VNFs and with other ONAP components, such as A&AI, DCAE and SO.
+| `See abbreviations <abbreviations.md>`__
+
+.. figure:: ./ONAP-SDN-R.png
+   :alt: SDN-R in ONAP
+
+   SDN-R in ONAP