Create wt-odlux directory

Include odlux apps, helpserver and readthedocs

Issue-ID: CCSDK-3970
Change-Id: I1aee1327e7da12e8f658185b9a985a5204ad6065
Signed-off-by: Ravi Pendurty <ravi.pendurty@highstreet-technologies.com>

5 files changed, 234 insertions, 0 deletions

diff --git a/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/applications.rst b/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/applications.rst
new file mode 100644
index 000000000..2c0c9c6df
--- /dev/null
+++ b/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/applications.rst
@@ -0,0 +1,18 @@
+Applications
+============
+Below are the UX Applications.
+
+
+.. toctree::
+   :maxdepth: 1
+
+   connect
+   pnfFault
+   pnfMaintenance
+   pnfConfig
+   pnfPerformance
+   pnfInventory
+   pnfEventLog
+   pnfMediator
+   networkMap
+   linkCalculator
diff --git a/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/home.rst b/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/home.rst
new file mode 100644
index 000000000..217e565cc
--- /dev/null
+++ b/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/home.rst
@@ -0,0 +1,32 @@
+
+.. 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.html>`__
+
+.. figure:: ./ONAP-SDN-R.png
+   :alt: SDN-R in ONAP
+
+   SDN-R in ONAP
+
+
+.. toctree::
+   :maxdepth: 1
+
+   general
+   applications
+   installation
+   faq
+   abbreviations
diff --git a/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/installation.rst b/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/installation.rst
new file mode 100644
index 000000000..7fe4dafd3
--- /dev/null
+++ b/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/installation.rst
@@ -0,0 +1,14 @@
+Installation
+============
+
+Below is the installation procedure for SDN-R Images and Configuration parameters
+
+
+.. toctree::
+   :maxdepth: 1
+
+   sdnr_WT_Service_Configuration_parameters
+   sdnr_Docker_Image_configuration
+
+
+
diff --git a/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/sdnr_Docker_Image_configuration.rst b/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/sdnr_Docker_Image_configuration.rst
new file mode 100644
index 000000000..5297a0944
--- /dev/null
+++ b/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/sdnr_Docker_Image_configuration.rst
@@ -0,0 +1,52 @@
+.. contents::
+   :depth: 3
+..
+
+SDN-R Docker Image configuration
+================================
+
+Introduction
+~~~~~~~~~~~~
+
+ONAP SDN-R is running in a docker container using ONAP/SDN-C image
+"onap/sdnc".
+
+The container is available as Alpine and Ubuntu version. The description
+uses examples for the Alpine version.
+
+The alpine based sdnc docker imanges are stored in \ `ONAP Nexus sdnc
+image <https://nexus3.onap.org:10001/v2/onap/sdnc-image/tags/list>`__.
+
+The docker image contains a Opendaylight distribution in a standard
+configuration and ONAP/SDN-R specific microservices.
+
+The Root location of ODL Karaf directory structure
+is \ *ODL\_HOME=/opt/opendaylight.*
+
+During container provisioning the installation of the feature is done,
+according to the provided configuration setting.
+
+The docker image configuration is done by
+
+-  Specific Environment variables settings
+
+-  Files that are provided
+
+Container startup parameters
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The SDN-R specific configurations are provided during container start. 
+
+Different SDN-R services are using different parameter to be installed.
+
++------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+
+| **Parameter**    | **Content**         | **Description**                                                                                                         |
++==================+=====================+=========================================================================================================================+
+| SDNRWT           | true\|\ **false**   | Set true to activate sdnr wt featureset. Set this during container start.                                               |
+|                  |                     |                                                                                                                         |
+|                  |                     | Devicemanager configuration is provided via *$ODL\_HOME/etc/devicemanager.properties*                                   |
+|                  |                     |                                                                                                                         |
+|                  |                     | See  `SDN-R WT Service Configuration parameters <sdnr_WT_Service_Configuration_parameters.html>`__			   |
++------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+
+| SDNRNORTHBOUND   | true\|\ **false**   | Set true to activate sdnr oofpci service.                                                                               |
++------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+
diff --git a/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst b/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst
new file mode 100644
index 000000000..a27e5113f
--- /dev/null
+++ b/sdnr/wt-odlux/readthedocs/src/docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst
@@ -0,0 +1,118 @@
+.. contents::
+   :depth: 3
+..
+
+SDN-R WT Service Configuration parameters
+=========================================
+
+ODL is operated as a cluster. The configuration settings must be the
+same for each cluster node.
+
+-  `Sections <#SDN-RWTServiceConfigurationparameters-S>`__
+
+   -  `toggleAlarmFilter <#SDN-RWTServiceConfigurationparameters-t>`__
+   -  `devicemonitor <#SDN-RWTServiceConfigurationparameters-d>`__
+
+Backgrounds regarding the container inter structure is described
+in \ `SDN-R Docker Image configuration <sdnr_Docker_Image_configuration.html>`__.
+
+The configuration information of sdnr wireless transport parameters are
+in a single file.
+
+For different devicemanager services, like DeviceMonitor there  are
+individual sections in the configuration file available.
+
+Configuration file location: 
+***$ODL\_HOME/etc/devicemanager.properties***
+
+If SDN-R WT is starting
+
+-  and the file exists, the configuration is used. 
+-  if it does not exist it will be created with the default parameters.
+
+Below an example of the content.
+
+- Example 
+  ::
+
+    [toggleAlarmFilter]
+    taEnabled=true
+    taDelay=3000
+ 
+    [es]
+    esCluster=sdnr
+    esArchiveCheckIntervalSeconds=0
+    esArchiveLifetimeSeconds=2592000
+
+    [dcae]
+    dcaeUrl=off
+    dcaeUserCredentials=admin:admin
+    dcaeHeartbeatPeriodSeconds=120
+
+    [aai]
+    aaiUrl=off
+    aaiUserCredentials=
+    aaiHeaders=["X-TransactionId: 9999"]
+    aaiDeleteOnMountpointRemove=false
+    aaiTrustAllCerts=false
+    aaiPropertiesFile=
+    aaiApiVersion=aai/v13
+    aaiApplicationId=SDNR
+    aaiClientConnectionTimeout=30000
+    aaiPcks12ClientCertFile=
+    aaiPcks12ClientCertPassphrase=
+
+    [pm]
+    pmEnabled=true
+    pmCluster=sdnr
+
+    [devicemonitor]
+    SeverityconnectionLossOAM=Major
+    SeverityconnectionLossMediator=Major
+    SeverityconnectionLossNeOAM=Major
+
+Sections
+--------
+
+toggleAlarmFilter
+~~~~~~~~~~~~~~~~~
+
+Configure toggle alarm filter.
+
+taEnabled=true taDelay=3000
+
++-----------------+---------------+---------------+----------------+------------------------------------------------------+
+| **Parameter**   | **Values**    | **Default**   | **Unit**       | **Description**                                      |
++=================+===============+===============+================+======================================================+
+| taEnabled       | true, false   | false         |                | Enable or disable this service                       |
++-----------------+---------------+---------------+----------------+------------------------------------------------------+
+| taDelay         | number        |               | milliseconds   | Integration time to take over the new alarm status   |
++-----------------+---------------+---------------+----------------+------------------------------------------------------+
+
+devicemonitor
+~~~~~~~~~~~~~
+
+Configure alarm severity of related alarms, generated by Device Monitor.
+
+`SDNC-616 <https://jira.onap.org/browse/SDNC-616>`__ - SDN-R WT app need to change alarm severity "Configurable" for ConnectionLossxxx alarm family (received from Mediator) , when it passed to DCAE VES collector.
+
+
+Syntax: Parameter=Value
+
+Example: SeverityconnectionLossOAM=Major
+
++----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+
+|                                  | **Values**                                    | **Default**   | **Unit**   | **Description**                                              |
++==================================+===============================================+===============+============+==============================================================+
+| SeverityconnectionLossOAM        | NonAlarmed, Warning, Minor, Major, Critical   | Major         |            | SDN-Controller <> Mediator                                   |
+|                                  |                                               |               |            |                                                              |
+|                                  |                                               |               |            | Mountpoint monitoring. Indicates a not connected mounpoint   |
++----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+
+| SeverityconnectionLossMediator   | NonAlarmed, Warning, Minor, Major, Critical   | Major         |            | SDN-Controller <> NetworkElement                             |
+|                                  |                                               |               |            |                                                              |
+|                                  |                                               |               |            | Device monitoring. No LTPs provided                          |
++----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+
+| SeverityconnectionLossNeOAM      | NonAlarmed, Warning, Minor, Major, Critical   | Major         |            | SDN-Controller <> NetworkElement                             |
+|                                  |                                               |               |            |                                                              |
+|                                  |                                               |               |            | Device monitoring. SSH Connetion, Core model not answering   |
++----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+