SDN-R readthedocs content changes 22/91822/1
authorsai-neetha <sai-neetha.phulmali@highstreet-technologies.com>
Mon, 22 Jul 2019 15:31:08 +0000 (17:31 +0200)
committersai-neetha <sai-neetha.phulmali@highstreet-technologies.com>
Mon, 22 Jul 2019 16:04:03 +0000 (18:04 +0200)
SDN-R readthedocs content and tree structure changes

Issue-ID: SDNC-819
Signed-off-by: sai-neetha <sai-neetha.phulmali@highstreet-technologies.com>
Change-Id: I025d59d59dddc3d68bae5390ef541ca718939a50

docs/guides/onap-user/abbreviations.rst
docs/guides/onap-user/applications.rst [new file with mode: 0644]
docs/guides/onap-user/home.rst
docs/guides/onap-user/installation.rst [new file with mode: 0644]
docs/guides/onap-user/sdnr_Docker_Image_configuration.rst [new file with mode: 0644]
docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst [new file with mode: 0644]
docs/index.rst
sdnr/wt/readthedocs/src/home.rst
sdnr/wt/readthedocs/src/index.rst

index 3f4ab76..65e79bf 100644 (file)
 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>`__                                            |
-+--------------------+----------------------------------------------------------------------------------------------------------------+
++-------------------+-------------------+
+| **Abbreviation**  | **Description**   |
++===================+===================+
+| AAF               | `Application      |
+|                   | Authorization     |
+|                   | Framework <https: |
+|                   | //wiki.onap.org/d |
+|                   | isplay/DW/Applica |
+|                   | tion+Authorizatio |
+|                   | n+Framework+Proje |
+|                   | ct>`__            |
++-------------------+-------------------+
+| A&AI              | `Active &         |
+|                   | Available         |
+|                   | Inventory <https: |
+|                   | //wiki.onap.org/d |
+|                   | isplay/DW/Active+ |
+|                   | and+Available+Inv |
+|                   | entory+Project>`_ |
+|                   | _                 |
++-------------------+-------------------+
+| AAA               | `Authentication,  |
+|                   | Authorization and |
+|                   | Accounting <https |
+|                   | ://en.wikipedia.o |
+|                   | rg/wiki/AAA_(comp |
+|                   | uter_security)>`_ |
+|                   | _                 |
++-------------------+-------------------+
+| AID               | Architecture      |
+|                   | Integration       |
+|                   | Document          |
++-------------------+-------------------+
+| APPC              | `Application      |
+|                   | Controller <https |
+|                   | ://wiki.onap.org/ |
+|                   | display/DW/Applic |
+|                   | ation+Controller+ |
+|                   | Project>`__       |
++-------------------+-------------------+
+| BPEL              | Business Process  |
+|                   | Execution         |
+|                   | Language          |
++-------------------+-------------------+
+| BPMN              | `Business Process |
+|                   | Model and         |
+|                   | Notation or       |
+|                   | Business Process  |
+|                   | Management        |
+|                   | Notation <https:/ |
+|                   | /en.wikipedia.org |
+|                   | /wiki/Business_Pr |
+|                   | ocess_Model_and_N |
+|                   | otation>`__       |
++-------------------+-------------------+
+| BRMS              | Business Rules    |
+|                   | Management System |
++-------------------+-------------------+
+| BSS               | Business Support  |
+|                   | System            |
++-------------------+-------------------+
+| CCSDK             | Common Controller |
+|                   | SDK project       |
++-------------------+-------------------+
+| CDAP              | `Cask Data        |
+|                   | Application       |
+|                   | Platform <https:/ |
+|                   | /cdap.io/>`__     |
++-------------------+-------------------+
+| CDS               | Controller Design |
+|                   | Studio            |
++-------------------+-------------------+
+| CI/CD             | Continuous        |
+|                   | Integration /     |
+|                   | Continuous        |
+|                   | Delivery          |
++-------------------+-------------------+
+| CL                | Control Loop      |
++-------------------+-------------------+
+| CLAMP             | Closed Loop       |
+|                   | Automation        |
+|                   | Management        |
+|                   | Platform          |
+|                   | (project)         |
++-------------------+-------------------+
+| CLI               | `Command Line     |
+|                   | Interface         |
+|                   | (project) <https: |
+|                   | //wiki.onap.org/d |
+|                   | isplay/DW/Command |
+|                   | +Line+Interface+P |
+|                   | roject>`__        |
++-------------------+-------------------+
+| CMA               | Change Management |
+|                   | Application       |
+|                   | (within ONAP)     |
++-------------------+-------------------+
+| CNF               | Cloud Native      |
+|                   | network Function. |
++-------------------+-------------------+
+| COE               | Container         |
+|                   | Orchestration     |
+|                   | Engine            |
++-------------------+-------------------+
+| CPE               | Customer Premise  |
+|                   | Equipment         |
++-------------------+-------------------+
+| CSAR              | `Cloud Service    |
+|                   | ARchive           |
+|                   | (link) <http://op |
+|                   | enbaton.github.io |
+|                   | /documentation/to |
+|                   | sca-CSAR-onboardi |
+|                   | ng/>`__           |
++-------------------+-------------------+
+| DAO               | `Data Access      |
+|                   | Object <https://e |
+|                   | n.wikipedia.org/w |
+|                   | iki/Data_access_o |
+|                   | bject>`__         |
++-------------------+-------------------+
+| DCAE              | `Data Collection  |
+|                   | Analytics &       |
+|                   | Events <https://w |
+|                   | iki.onap.org/page |
+|                   | s/viewpage.action |
+|                   | ?pageId=6592895>` |
+|                   | __                |
++-------------------+-------------------+
+| DDoS              | Distributed       |
+|                   | Denial-of-Service |
+|                   | attack            |
++-------------------+-------------------+
+| DG                | Directed Graph    |
++-------------------+-------------------+
+| DG Builder        | Directed Graph    |
+|                   | Builder           |
++-------------------+-------------------+
+| DMaaP             | `Data Movement as |
+|                   | a                 |
+|                   | Platform <https:/ |
+|                   | /wiki.onap.org/di |
+|                   | splay/DW/DMaaP>`_ |
+|                   | _                 |
++-------------------+-------------------+
+| DME               | `Direct Messaging |
+|                   | Engine (common    |
+|                   | service within    |
+|                   | ONAP) <https://wi |
+|                   | ki.onap.org/displ |
+|                   | ay/DW/Common+Serv |
+|                   | ices>`__          |
++-------------------+-------------------+
+| DNS               | Domain Name       |
+|                   | System            |
++-------------------+-------------------+
+| DPDK              | Data Plane        |
+|                   | Development Kit   |
++-------------------+-------------------+
+| EELF              | `Event and        |
+|                   | Error-Logging     |
+|                   | Framework <https: |
+|                   | //wiki.onap.org/d |
+|                   | isplay/DW/Common+ |
+|                   | Services>`__      |
++-------------------+-------------------+
+| EMS               | `Element          |
+|                   | Management        |
+|                   | System <https://e |
+|                   | n.wikipedia.org/w |
+|                   | iki/Element_manag |
+|                   | ement_system>`__  |
++-------------------+-------------------+
+| ESR               | `External System  |
+|                   | Register <https:/ |
+|                   | /wiki.onap.org/pa |
+|                   | ges/viewpage.acti |
+|                   | on?pageId=5734948 |
+|                   | >`__              |
++-------------------+-------------------+
+| ETSI              | `European         |
+|                   | Telecommunication |
+|                   | s                 |
+|                   | Standards         |
+|                   | Institute <http:/ |
+|                   | /www.etsi.org/tec |
+|                   | hnologies-cluster |
+|                   | s/technologies/68 |
+|                   | 9-network-functio |
+|                   | ns-virtualisation |
+|                   | >`__              |
++-------------------+-------------------+
+| EUAG              | `ONAP End User    |
+|                   | Advisory          |
+|                   | Group <https://wi |
+|                   | ki.lfnetworking.o |
+|                   | rg/pages/viewpage |
+|                   | .action?pageId=29 |
+|                   | 16362>`__         |
++-------------------+-------------------+
+| FCAPS             | Fault             |
+|                   | Configuration     |
+|                   | Accounting        |
+|                   | Performance       |
+|                   | Security          |
++-------------------+-------------------+
+| GBP               | `Group-Based      |
+|                   | Policy <https://w |
+|                   | iki.openstack.org |
+|                   | /wiki/GroupBasedP |
+|                   | olicy>`__         |
++-------------------+-------------------+
+| GNFC              | `Genric Network   |
+|                   | Function          |
+|                   | Controller <https |
+|                   | ://wiki.onap.org/ |
+|                   | download/attachme |
+|                   | nts/45300148/ONAP |
+|                   | _GNF_ControllersS |
+|                   | OL003.pptx?versio |
+|                   | n=1&modificationD |
+|                   | ate=1548619943000 |
+|                   | &api=v2>`__       |
++-------------------+-------------------+
+| GUI               | `Graphical User   |
+|                   | Interface <https: |
+|                   | //en.wikipedia.or |
+|                   | g/wiki/Graphical_ |
+|                   | user_interface>`_ |
+|                   | _                 |
++-------------------+-------------------+
+| HAS               | `Homing and       |
+|                   | Allocation        |
+|                   | Service <https:// |
+|                   | wiki.onap.org/pag |
+|                   | es/viewpage.actio |
+|                   | n?pageId=16005528 |
+|                   | >`__              |
++-------------------+-------------------+
+| HDFS              | Hadoop            |
+|                   | Distributed File  |
+|                   | System            |
++-------------------+-------------------+
+| HPA               | Hardware Platform |
+|                   | Awareness         |
++-------------------+-------------------+
+| HTTP              | HyperText         |
+|                   | Transfer          |
+|                   | Protococol        |
++-------------------+-------------------+
+| HV VES            | `High Volume      |
+|                   | Virtual function  |
+|                   | Event             |
+|                   | Stream <https://w |
+|                   | iki.onap.org/disp |
+|                   | lay/DW/High+Volum |
+|                   | e+VES+Collector>` |
+|                   | __                |
++-------------------+-------------------+
+| IAM/IDAM          | Identity and      |
+|                   | Access Management |
++-------------------+-------------------+
+| ICE               | Incubation and    |
+|                   | Certification     |
+|                   | Environment       |
++-------------------+-------------------+
+| IDS               | `Intrusion        |
+|                   | Detection         |
+|                   | System <https://e |
+|                   | n.wikipedia.org/w |
+|                   | iki/Intrusion_det |
+|                   | ection_system>`__ |
++-------------------+-------------------+
+| IETF              | `Internet         |
+|                   | Engineering Task  |
+|                   | Force <http://www |
+|                   | .ietf.org>`__     |
++-------------------+-------------------+
+| IKE               | `Internet Key     |
+|                   | Exchange <https:/ |
+|                   | /en.wikipedia.org |
+|                   | /wiki/Internet_Ke |
+|                   | y_Exchange>`__    |
++-------------------+-------------------+
+| IPS               | `Intrusion        |
+|                   | Prevention        |
+|                   | System <https://e |
+|                   | n.wikipedia.org/w |
+|                   | iki/Intrusion_det |
+|                   | ection_system>`__ |
++-------------------+-------------------+
+| IPSEC             | `Internet         |
+|                   | Protocol          |
+|                   | Security <https:/ |
+|                   | /en.wikipedia.org |
+|                   | /wiki/IPsec>`__   |
++-------------------+-------------------+
+| JAR               | `Java             |
+|                   | Archive <https:// |
+|                   | en.wikipedia.org/ |
+|                   | wiki/JAR_(file_fo |
+|                   | rmat)>`__         |
++-------------------+-------------------+
+| JSC               | `Java Service     |
+|                   | Container <https: |
+|                   | //wiki.onap.org/d |
+|                   | isplay/DW/Common+ |
+|                   | Services>`__      |
++-------------------+-------------------+
+| JSON              | JavaScript Object |
+|                   | Notation          |
++-------------------+-------------------+
+| LCM               | Life Cycle        |
+|                   | Management        |
++-------------------+-------------------+
+| LFN CVC           | `Linux Foundation |
+|                   | Networking        |
+|                   | Compliance/Verifi |
+|                   | cation            |
+|                   | Committee <https: |
+|                   | //wiki.onap.org/d |
+|                   | isplay/DW/LFN+CVC |
+|                   | +Testing+in+VNFSD |
+|                   | K>`__             |
++-------------------+-------------------+
+| LFN CVP           | `Linux Foundation |
+|                   | Networking        |
+|                   | Compliance/Verifi |
+|                   | cation            |
+|                   | Program <https:// |
+|                   | wiki.onap.org/dis |
+|                   | play/DW/LFN+CVC+T |
+|                   | esting+in+VNFSDK> |
+|                   | `__               |
++-------------------+-------------------+
+| LRM               | Local Resource    |
+|                   | Monitor           |
++-------------------+-------------------+
+| M0                | Release Kick-off  |
+|                   | milestone. See    |
+|                   | also Release      |
+|                   | Lifecycle         |
++-------------------+-------------------+
+| M1                | Release Planning  |
+|                   | milestone. See    |
+|                   | also Release      |
+|                   | Lifecycle         |
++-------------------+-------------------+
+| M2                | Release           |
+|                   | Functionality     |
+|                   | Freeze milestone. |
+|                   | See also Release  |
+|                   | Lifecycle         |
++-------------------+-------------------+
+| M3                | Release API       |
+|                   | Freeze milestone. |
+|                   | See also Release  |
+|                   | Lifecycle         |
++-------------------+-------------------+
+| M4                | Release Code      |
+|                   | Freeze milestone. |
+|                   | See also Release  |
+|                   | Lifecycle         |
++-------------------+-------------------+
+| MACD              | (Vendor specific) |
+|                   | Move Add Change   |
+|                   | Delete/Disconnect |
++-------------------+-------------------+
+| MANO              | MANagement and    |
+|                   | Organization of   |
+|                   | NFV               |
++-------------------+-------------------+
+| MD-SAL            | Model Driven      |
+|                   | Service           |
+|                   | Abstraction Layer |
++-------------------+-------------------+
+| MR                | Message Router (a |
+|                   | Common Service of |
+|                   | ONAP)             |
++-------------------+-------------------+
+| MOP               | Method of         |
+|                   | Procedure         |
++-------------------+-------------------+
+| MOTS              | Mechanized        |
+|                   | Operations        |
+|                   | Tracking System   |
++-------------------+-------------------+
+| MSB               | Microservice Bus  |
++-------------------+-------------------+
+| MSO               | `Master Service   |
+|                   | Orchestrator <htt |
+|                   | ps://wiki.onap.or |
+|                   | g/pages/viewpage. |
+|                   | action?pageId=101 |
+|                   | 5834>`__          |
++-------------------+-------------------+
+| MVP               | `Minimum Viable   |
+|                   | Product <https:// |
+|                   | en.wikipedia.org/ |
+|                   | wiki/Minimum_viab |
+|                   | le_product>`__    |
++-------------------+-------------------+
+| NAI               | Network           |
+|                   | Artificial        |
+|                   | Intelligence      |
++-------------------+-------------------+
+| NANCSP            | Network Cloud     |
+|                   | Service Provider  |
++-------------------+-------------------+
+| NBI               | North Bound       |
+|                   | Interface         |
++-------------------+-------------------+
+| NEP               | Network Equipment |
+|                   | Provider          |
++-------------------+-------------------+
+| NETCONF           | `Network          |
+|                   | Configuration     |
+|                   | Protocol <https:/ |
+|                   | /en.wikipedia.org |
+|                   | /wiki/NETCONF>`__ |
++-------------------+-------------------+
+| NFV               | `Network Function |
+|                   | Virtualization <h |
+|                   | ttps://en.wikiped |
+|                   | ia.org/wiki/Netwo |
+|                   | rk_function_virtu |
+|                   | alization>`__     |
++-------------------+-------------------+
+| NFVI              | `network          |
+|                   | functions         |
+|                   | virtualization    |
+|                   | infrastructure <h |
+|                   | ttps://www.sdxcen |
+|                   | tral.com/nfv/defi |
+|                   | nitions/nfv-mano/ |
+|                   | >`__              |
++-------------------+-------------------+
+| NOD               | Network On Demand |
++-------------------+-------------------+
+| NS                | Network Services  |
++-------------------+-------------------+
+| NS                | (Vendor Specific) |
+|                   | New Start         |
++-------------------+-------------------+
+| OA&M              | Operations,       |
+|                   | Administration    |
+|                   | and Management    |
++-------------------+-------------------+
+| OMF               | Operational       |
+|                   | Management        |
+|                   | Framework (of     |
+|                   | ONAP)             |
++-------------------+-------------------+
+| OMSA              | ONAP Microservice |
+|                   | Architecture      |
++-------------------+-------------------+
+| ONAP              | `Open Network     |
+|                   | Automation        |
+|                   | Platform <https:/ |
+|                   | /wiki.onap.org/pa |
+|                   | ges/viewpage.acti |
+|                   | on?pageId=1015843 |
+|                   | >`__              |
++-------------------+-------------------+
+| OOF               | ONAP Optimization |
+|                   | Framework         |
++-------------------+-------------------+
+| ODL               | `OpenDaylight <ht |
+|                   | tps://www.openday |
+|                   | light.org/>`__    |
++-------------------+-------------------+
+| OOM               | `ONAP Operations  |
+|                   | Manager <https:// |
+|                   | wiki.onap.org/dis |
+|                   | play/DW/OOM+User+ |
+|                   | Guide>`__         |
++-------------------+-------------------+
+| OPNFV             | `Open Platform    |
+|                   | for NFV           |
+|                   | Project <https:// |
+|                   | www.sdxcentral.co |
+|                   | m/nfv/definitions |
+|                   | /opnfv/>`__       |
++-------------------+-------------------+
+| OSAM              | `Open Source      |
+|                   | Access            |
+|                   | Manager <https:// |
+|                   | wiki.onap.org/dis |
+|                   | play/DW/OpenSourc |
+|                   | e+Access+Manager+ |
+|                   | %28OSAM%29+Use+Ca |
+|                   | se>`__            |
++-------------------+-------------------+
+| OSS               | Operations        |
+|                   | Support System    |
++-------------------+-------------------+
+| PAP               | Policy            |
+|                   | Administration    |
+|                   | Point (ONAP)      |
++-------------------+-------------------+
+| PCE               | Path Computation  |
+|                   | and Element       |
+|                   | (ONAP)            |
++-------------------+-------------------+
+| PCI               | Physical Cell ID  |
++-------------------+-------------------+
+| pCPE              | physical Customer |
+|                   | Premise Equipment |
++-------------------+-------------------+
+| PDP-x             | Policy Decision   |
+|                   | Point - XACML     |
+|                   | (ONAP)            |
++-------------------+-------------------+
+| PDP-d             | Policy Decision   |
+|                   | Point - Drools    |
+|                   | (ONAP)            |
++-------------------+-------------------+
+| PO                | Platform          |
+|                   | Orchestrator      |
++-------------------+-------------------+
+| PoC               | Proof of Concept  |
++-------------------+-------------------+
+| POMBA             | `Post             |
+|                   | Orchestration     |
+|                   | Model Based       |
+|                   | Audit <https://wi |
+|                   | ki.onap.org/displ |
+|                   | ay/DW/POMBA>`__   |
++-------------------+-------------------+
+| PNDA              | `Open source      |
+|                   | Platform for      |
+|                   | Network Data      |
+|                   | Analytics <https: |
+|                   | //wiki.onap.org/d |
+|                   | isplay/DW/Integra |
+|                   | ting+PNDA>`__     |
++-------------------+-------------------+
+| PNF               | Physical Network  |
+|                   | Function          |
++-------------------+-------------------+
+| RCA               | Root Cause        |
+|                   | Analysis          |
++-------------------+-------------------+
+| RCT               | Reference         |
+|                   | Connection Tool   |
++-------------------+-------------------+
+| REST              | `Representational |
+|                   | State             |
+|                   | Transfer <https:/ |
+|                   | /en.wikipedia.org |
+|                   | /wiki/Representat |
+|                   | ional_state_trans |
+|                   | fer>`__           |
++-------------------+-------------------+
+| RESTCONF          | REST + NETCONF    |
++-------------------+-------------------+
+| RO                | Resource          |
+|                   | Orchestrator      |
++-------------------+-------------------+
+| RPC               | Remote Procedure  |
+|                   | Call              |
++-------------------+-------------------+
+| S3P               | `Stability,       |
+|                   | Security,         |
+|                   | Scalability,      |
+|                   | Performance <http |
+|                   | s://wiki.onap.org |
+|                   | /pages/viewpage.a |
+|                   | ction?pageId=1600 |
+|                   | 3367>`__          |
++-------------------+-------------------+
+| SDC               | Service Design    |
+|                   | and Creation      |
+|                   | (component of     |
+|                   | ONAP for visual   |
+|                   | modeling and      |
+|                   | design)           |
++-------------------+-------------------+
+| SDN               | `Software-defined |
+|                   | networking <https |
+|                   | ://en.wikipedia.o |
+|                   | rg/wiki/Software- |
+|                   | defined_networkin |
+|                   | g>`__             |
++-------------------+-------------------+
+| SDN-C             | `SDN-Controller < |
+|                   | https://wiki.onap |
+|                   | .org/display/DW/S |
+|                   | DN+Controller+Dev |
+|                   | elopment+Guide>`_ |
+|                   | _                 |
++-------------------+-------------------+
+| SDN-R             | `SDN-Radio <https |
+|                   | ://wiki.onap.org/ |
+|                   | display/DW/SDN-R> |
+|                   | `__               |
++-------------------+-------------------+
+| SDN-GP            | Software Defined  |
+|                   | Network - Global  |
+|                   | Platform          |
++-------------------+-------------------+
+| SEBA              | SDN-Enabled       |
+|                   | Broadband Access, |
+|                   | see also          |
++-------------------+-------------------+
+| SLA               | Service Level     |
+|                   | Agreement         |
++-------------------+-------------------+
+| SLI               | Service Logic     |
+|                   | Interpreter       |
++-------------------+-------------------+
+| SME               | Subject Matter    |
+|                   | Expert            |
++-------------------+-------------------+
+| SMTP              | Simple Mail       |
+|                   | Transfer Protocol |
++-------------------+-------------------+
+| SNMP              | Simple Network    |
+|                   | Management        |
+|                   | Protocol          |
++-------------------+-------------------+
+| SO                | `Service          |
+|                   | Orchestrator      |
+|                   | (project) <https: |
+|                   | //wiki.onap.org/d |
+|                   | isplay/DW/Service |
+|                   | +Orchestrator+Pro |
+|                   | ject>`__          |
++-------------------+-------------------+
+| SOT               | Source Of Truth   |
++-------------------+-------------------+
+| SR-IOV            | `Single-Root      |
+|                   | Input/Output      |
+|                   | Virtualization <h |
+|                   | ttps://en.wikiped |
+|                   | ia.org/wiki/Singl |
+|                   | e-root_input/outp |
+|                   | ut_virtualization |
+|                   | >`__              |
++-------------------+-------------------+
+| SSL               | `Secure Sockets   |
+|                   | Layer <https://en |
+|                   | .wikipedia.org/wi |
+|                   | ki/Transport_Laye |
+|                   | r_Security>`__    |
++-------------------+-------------------+
+| SUPP              | (Vendor Specific) |
+|                   | short for         |
+|                   | supplement,       |
+|                   | changing a        |
+|                   | connection before |
+|                   | activation        |
++-------------------+-------------------+
+| Swagger           | legacy name for   |
+|                   | the OpenAPI       |
+|                   | Specification     |
++-------------------+-------------------+
+| TCP               | Transmission      |
+|                   | Control Protocol  |
++-------------------+-------------------+
+| TEM               | Telecom           |
+|                   | Electronics       |
+|                   | Manufacturer      |
++-------------------+-------------------+
+| TLS               | `Transport Layer  |
+|                   | Security <https:/ |
+|                   | /en.wikipedia.org |
+|                   | /wiki/Transport_L |
+|                   | ayer_Security>`__ |
++-------------------+-------------------+
+| TOSCA             | `Topology and     |
+|                   | Orchestration     |
+|                   | Specification for |
+|                   | Cloud             |
+|                   | Applications <htt |
+|                   | ps://www.oasis-op |
+|                   | en.org/committees |
+|                   | /tc_home.php?wg_a |
+|                   | bbrev=tosca>`__   |
++-------------------+-------------------+
+| TPS               | Transactions Per  |
+|                   | Second            |
++-------------------+-------------------+
+| TSC               | Technical         |
+|                   | Steering          |
+|                   | Committee         |
++-------------------+-------------------+
+| U-UI              | `Usecase User     |
+|                   | Interface <https: |
+|                   | //wiki.onap.org/d |
+|                   | isplay/DW/Usecase |
+|                   | +UI+Project>`__   |
++-------------------+-------------------+
+| UI                | `User             |
+|                   | Interface <https: |
+|                   | //en.wikipedia.or |
+|                   | g/wiki/User_inter |
+|                   | face>`__          |
++-------------------+-------------------+
+| UX                | `User             |
+|                   | Experience <https |
+|                   | ://en.wikipedia.o |
+|                   | rg/wiki/User_expe |
+|                   | rience>`__        |
++-------------------+-------------------+
+| vCE               | virtual CE        |
+|                   | (Customer Edge)   |
+|                   | router (an        |
+|                   | example VNF)      |
++-------------------+-------------------+
+| vCPE              | Virtual Customer  |
+|                   | Premise Equipment |
++-------------------+-------------------+
+| vDNS              | Virtual Domain    |
+|                   | Name Server (an   |
+|                   | example VNF)      |
++-------------------+-------------------+
+| VDU               | `Virtualisation   |
+|                   | Deployment        |
+|                   | Unit <https://wik |
+|                   | i.onap.org/displa |
+|                   | y/DW/Comparison+o |
+|                   | f+Current+R3+Clea |
+|                   | n+Version+with+IF |
+|                   | A011+v2.5.1>`__   |
++-------------------+-------------------+
+| VES               | `Virtual function |
+|                   | Event             |
+|                   | Stream <https://w |
+|                   | iki.opnfv.org/dow |
+|                   | nload/attachments |
+|                   | /6819329/OPNVF%20 |
+|                   | VES.pptx?version= |
+|                   | 4&modificationDat |
+|                   | e=1466395653000&a |
+|                   | pi=v2>`__         |
++-------------------+-------------------+
+| vF                | Virtual Firewall  |
+|                   | (an example VNF)  |
++-------------------+-------------------+
+| VF                | Virtual Function  |
++-------------------+-------------------+
+| VFC               | `Virtual Function |
+|                   | Controller <https |
+|                   | ://wiki.onap.org/ |
+|                   | display/DW/Virtua |
+|                   | l+Function+Contro |
+|                   | ller+Project>`__  |
++-------------------+-------------------+
+| VFC               | Virtual Function  |
+|                   | Component         |
+|                   | (Resource         |
+|                   | Onboarding)       |
++-------------------+-------------------+
+| vfModule          | Virtual Function  |
+|                   | Module            |
++-------------------+-------------------+
+| VID               | Virtual           |
+|                   | Instantiation     |
+|                   | Deployment        |
++-------------------+-------------------+
+| VID               | `Virtual          |
+|                   | Infrastructure    |
+|                   | Deployment        |
+|                   | (Project) <https: |
+|                   | //wiki.onap.org/d |
+|                   | isplay/DW/Virtual |
+|                   | +Infrastructure+D |
+|                   | eployment+Project |
+|                   | >`__              |
++-------------------+-------------------+
+| VIM               | Virtualized       |
+|                   | Infrastructure    |
+|                   | Manager           |
++-------------------+-------------------+
+| VLAN              | Virtual Local     |
+|                   | Area Network      |
++-------------------+-------------------+
+| VM                | Virtual Machine   |
++-------------------+-------------------+
+| VNF               | `Virtual Network  |
+|                   | Function <http:// |
+|                   | searchsdn.techtar |
+|                   | get.com/definitio |
+|                   | n/virtual-network |
+|                   | -functions>`__    |
++-------------------+-------------------+
+| VNFC              | Virtual Network   |
+|                   | Function          |
+|                   | Component         |
++-------------------+-------------------+
+| VNFD              | `VNF              |
+|                   | Descriptor <https |
+|                   | ://wiki.onap.org/ |
+|                   | pages/viewpage.ac |
+|                   | tion?pageId=82260 |
+|                   | 59>`__            |
++-------------------+-------------------+
+| VNFM              | VNF Manager       |
++-------------------+-------------------+
+| VNO               | Virtual Network   |
+|                   | Operator          |
++-------------------+-------------------+
+| vPE               | virtual PE        |
+|                   | (Provider Edge)   |
+|                   | router (an        |
+|                   | example of a VNF) |
++-------------------+-------------------+
+| VPP               | `Vector Packet    |
+|                   | Processing <https |
+|                   | ://wiki.fd.io/vie |
+|                   | w/VPP/What_is_VPP |
+|                   | %3F>`__           |
++-------------------+-------------------+
+| VSP               | Vendor Software   |
+|                   | Product (from SDC |
+|                   | Demo Guide)       |
++-------------------+-------------------+
+| VTP               | `VNF Test         |
+|                   | Platform <https:/ |
+|                   | /wiki.onap.org/pa |
+|                   | ges/viewpage.acti |
+|                   | on?pageId=4338630 |
+|                   | 4>`__             |
++-------------------+-------------------+
+| VVP               | `VNF Validation   |
+|                   | Program <https:// |
+|                   | wiki.onap.org/dis |
+|                   | play/DW/VNF+Valid |
+|                   | ation+Program+Pro |
+|                   | ject>`__          |
++-------------------+-------------------+
+| WAR               | `Web application  |
+|                   | Archive <https:// |
+|                   | en.wikipedia.org/ |
+|                   | wiki/WAR_(file_fo |
+|                   | rmat)>`__         |
++-------------------+-------------------+
+| YANG              | A Data Modeling   |
+|                   | Language for the  |
+|                   | Network           |
+|                   | Configuration     |
+|                   | Protocol          |
+|                   | (NETCONF)         |
++-------------------+-------------------+
diff --git a/docs/guides/onap-user/applications.rst b/docs/guides/onap-user/applications.rst
new file mode 100644 (file)
index 0000000..fb908da
--- /dev/null
@@ -0,0 +1,16 @@
+Applications
+============
+Below are the UX Applications.
+
+
+.. toctree::
+   :maxdepth: 1
+
+   connect
+   pnfFault
+   pnfMaintenance
+   pnfConfig
+   pnfPerformance
+   pnfInventory
+   pnfMediator
+
index cf8b192..8885721 100644 (file)
@@ -25,10 +25,7 @@ microwave and millimeter wave radios, eNodeB, RRH, DAS equipment).
 .. toctree::
    :maxdepth: 1
 
-   connect
-   pnfFault
-   pnfMaintenance
-   pnfConfig
-   pnfPerformance
-   pnfInventory
-   pnfMediator
+   applications
+   installation
+   faq
+   abbreviations
diff --git a/docs/guides/onap-user/installation.rst b/docs/guides/onap-user/installation.rst
new file mode 100644 (file)
index 0000000..7fe4daf
--- /dev/null
@@ -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/docs/guides/onap-user/sdnr_Docker_Image_configuration.rst b/docs/guides/onap-user/sdnr_Docker_Image_configuration.rst
new file mode 100644 (file)
index 0000000..cd5f619
--- /dev/null
@@ -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>`__                         |
++------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+
+| SDNRNORTHBOUND   | true\|\ **false**   | Set true to activate sdnr oofpci service.                                                                               |
++------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+
diff --git a/docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst b/docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst
new file mode 100644 (file)
index 0000000..ed68ea5
--- /dev/null
@@ -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>`__.
+
+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   |
++----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+
index 78f6549..1da5c6c 100644 (file)
@@ -10,5 +10,3 @@ Below are the references for SDN-R User Documentation
    :maxdepth: 1
 
    guides/onap-user/home
-   guides/onap-user/faq
-   guides/onap-user/abbreviations
index cf8b192..8885721 100644 (file)
@@ -25,10 +25,7 @@ microwave and millimeter wave radios, eNodeB, RRH, DAS equipment).
 .. toctree::
    :maxdepth: 1
 
-   connect
-   pnfFault
-   pnfMaintenance
-   pnfConfig
-   pnfPerformance
-   pnfInventory
-   pnfMediator
+   applications
+   installation
+   faq
+   abbreviations
index 78f6549..1da5c6c 100644 (file)
@@ -10,5 +10,3 @@ Below are the references for SDN-R User Documentation
    :maxdepth: 1
 
    guides/onap-user/home
-   guides/onap-user/faq
-   guides/onap-user/abbreviations