From: demx8as6 Date: Sun, 14 Jun 2020 08:22:57 +0000 (+0200) Subject: Update documentation X-Git-Tag: 2.2.0~42 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=53c4f5781ea22dca2e149c86f9bacd4210027475;p=oam.git Update documentation Add more documentation for the Web application. Issue-ID: OAM-18 Signed-off-by: demx8as6 Change-Id: I928ab076b3144c6b01647fedaaf8b23a551173f5 --- diff --git a/docs/_static/o-ran-architecture.png b/docs/_static/o-ran-architecture.png new file mode 100644 index 0000000..9642d0d Binary files /dev/null and b/docs/_static/o-ran-architecture.png differ diff --git a/docs/abbreviations.rst b/docs/abbreviations.rst new file mode 100644 index 0000000..0f59b36 --- /dev/null +++ b/docs/abbreviations.rst @@ -0,0 +1,352 @@ +.. contents:: + :depth: 3 +.. + +Abbreviations +============= + ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Abbreviation** | **Description** | ++==================+==============================================================================================================================================================================+ +| AAF | `Application Authorization Framework `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| A&AI | `Active & Available Inventory `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| AAA | `Authentication,Authorization and Accounting `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| AID | Architecture Integration Document | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| APPC | `ApplicationController `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| BPEL | Business Process Execution Language | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| BPMN | `Business Process Model and Notation or Business Process Management Notation `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| BRMS | Business Rules Management System | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| BSS | Business Support System | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| CCSDK | Common Controller SDK project | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| CDAP | `Cask Data Application Platform `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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) `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| CMA | Change Management Application (within ONAP) | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| CNF | Cloud Native network Function. | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| COE | Container Orchestration Engine | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| CPE | Customer Premise Equipment | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| CSAR | `Cloud Service ARchive (link) `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DAO | `Data Access Object `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DCAE | `Data Collection Analytics & Events `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DDoS | Distributed Denial-of-Service attack | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DG | Directed Graph | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DG Builder | Directed Graph Builder | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DMaaP | `Data Movement as a Platform `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DME | `Direct Messaging Engine (common service within ONAP) `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DNS | Domain Name System | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DPDK | Data Plane Development Kit | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| EELF | `Event and Error-Logging Framework `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| EMS | `Element Management System `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ESR | `External System Register `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ETSI | `European Telecommunications Standards Institute `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| EUAG | `ONAP End User Advisory Group `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| FCAPS | Fault Configuration Accounting Performance Security | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| GBP | `Group-Based Policy `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| GNFC | `Genric Network Function Controller `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| GUI | `Graphical User Interface `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| HAS | `Homing and Allocation Service `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| HDFS | Hadoop Distributed File System | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| HPA | Hardware Platform Awareness | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| HTTP | HyperText Transfer Protococol | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| HV VES | `High Volume Virtual function Event Stream `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| IAM/IDAM | Identity and Access Management | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ICE | Incubation and Certification Environment | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| IDS | `Intrusion Detection System `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| IETF | `Internet Engineering Task Force `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| IKE | `Internet Key Exchange `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| IPS | `Intrusion Prevention System `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| IPSEC | `Internet Protocol Security `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| JAR | `Java Archive `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| JSC | `Java Service Container `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| JSON | JavaScript Object Notation | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| LCM | Life Cycle Management | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| LFN CVC | `Linux Foundation Networking Compliance/Verification Committee `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| LFN CVP | `Linux Foundation Networking Compliance/Verification Program `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| MVP | `Minimum Viable Product `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| NAI | Network Artificial Intelligence | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| NANCSP | Network Cloud Service Provider | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| NBI | North Bound Interface | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| NEP | Network Equipment Provider | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| NETCONF | `Network Configuration Protocol `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| NFV | `Network Function Virtualization `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| NFVI | Network Functions Virtualization Infrastructure | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| NOD | Network On Demand | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| NS | Network Services | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| NS | (Vendor Specific) New Start | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| O-CU | O-RAN Centralized Unit | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| O-DU | O-RAN Distributed Unit | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| O-RAN | `O-RAN Alliance, Operator Defined Next Generation Radio Access Networks Alliance `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| O-RAN-SC | `O-RAN Software Community `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| O-RU | O-RAN Radio Unit | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| OAM | Operation and Maintenance | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| OA&M | Operations, Administration and Management | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| OMF | Operational Management Framework (of ONAP) | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| OMSA | ONAP Microservice Architecture | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ONAP | `Open Network Automation Platform `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| OOF | ONAP Optimization Framework | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ODL | `OpenDaylight `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| OOM | `ONAP Operations Manager `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| OPNFV | `Open Platform for NFV Project `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| OSAM | `Open Source Access Manager `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| OSC | O-RAN Software Community or Optical Supervisory Channel | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| PNDA | `Open source Platform for Network Data Analytics `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| PNF | Physical Network Function | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| RCA | Root Cause Analysis | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| RCT | Reference Connection Tool | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| REST | `Representational State Transfer `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| RESTCONF | A protocol based on HTTP for configuring data defined in YANG | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| RO | Resource Orchestrator | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| RPC | Remote Procedure Call | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| S3P | `Stability, Security, Scalability, Performance `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| SDC | Service Design and Creation (component of ONAP for visual modeling and design) | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| SDN | `Software-defined networking `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| SDN-C | `SDN-Controller `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| SDN-R | `SDN-Radio ` __ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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) `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| SOT | Source Of Truth | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| SR-IOV | `Single-Root Input/Output Virtualization `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| SSL | `Secure Sockets Layer `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| TOSCA | `Topology and Orchestration Specification for Cloud Applications `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| TPS | Transactions Per Second | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| TSC | Technical Steering Committee | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| U-UI | `Usecase User Interface `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| UI | `User Interface `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| UX | `User Experience `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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 `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VES | `Virtual function Event Stream `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| vF | Virtual Firewall (an example VNF) | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VF | Virtual Function | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VFC | `Virtual Function Controller `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VFC | Virtual Function Component (Resource Onboarding) | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| vfModule | Virtual Function Module | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VID | Virtual Instantiation Deployment | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VID | `Virtual Infrastructure Deployment (Project) `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VIM | Virtualized Infrastructure Manager | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VLAN | Virtual Local Area Network | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VM | Virtual Machine | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VNF | `Virtual Network Function `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VNFC | Virtual Network Function Component | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VNFD | `VNF Descriptor `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VNFM | VNF Manager | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VNO | Virtual Network Operator | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| vPE | virtual PE (Provider Edge) router (an example of a VNF) | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VPP | `Vector Packet Processing `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VSP | Vendor Software Product (from SDC Demo Guide) | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VTP | `VNF Test Platform `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| VVP | `VNF Validation Program `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| WAR | `Web application Archive `__ | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| xNF | The combination of PNF and VNF; Network Function | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| YANG | Yet Another Next Generation - a Data Modeling Language for the Network Configuration Protocol (NETCONF) | ++------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/applications.rst b/docs/applications.rst new file mode 100644 index 0000000..c9d97e8 --- /dev/null +++ b/docs/applications.rst @@ -0,0 +1,18 @@ +UX Applications +=============== + +This page shortly describes the different web applications integrated into the +ODLUX framework. + + +.. toctree:: + :maxdepth: 1 + + connect + fault + maintenance + config + performance + inventory + mediator + diff --git a/docs/config.rst b/docs/config.rst new file mode 100644 index 0000000..2baa58f --- /dev/null +++ b/docs/config.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 divided 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 application is implemented as ODLUX web application using the +RestConf northbound interface of the SDN controller. The key frameworks +are: Typescript, React and material-ui. + +Connection status information is updated automatically using a web +socket for notifications from OpenDaylight to the browser. diff --git a/docs/connect.rst b/docs/connect.rst new file mode 100644 index 0000000..c93c1f9 --- /dev/null +++ b/docs/connect.rst @@ -0,0 +1,45 @@ +.. 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. +Usually, the Network Elements mount themselves. If necessary, they can +be mounted manually by right-clicking on the element and selecting the +'mount' action. For better understanding of alarms and status, a +connection status log lists all the connection status changes of +OpenDaylight mount points. + +Views +----- + +The graphical user interface is divided into two sections. + +Network Elements +~~~~~~~~~~~~~~~~ + +Network Elements are physical network functions (PNFs). A table view +shows all configured and connected NetConf Servers of the SDN-R cluster. +This view also allows to manually configure/mount a device via the '+' +button. The SDN controller will start connecting to the NetConf server. + +Network Elements can be marked as 'required'. If an element is required, +it will stay available even if disconnected. If an element is not +required, it will be deleted once disconnected. + +By right-clicking on an element, an action menu opens. The menu allows +to mount, unmount, view the details, edit and remove the element. +Additionally, it links to several applications like +`Fault <../pnfFault/README.md>`__ and +`Configure <../pnfConfig/README.md>`__, which will be filtered to +display information relevant to the selected element. + +Connection Status Log +~~~~~~~~~~~~~~~~~~~~~ + +The log lists the connection status changes between SDN Controller and +NetConf servers (devices). diff --git a/docs/faq.rst b/docs/faq.rst new file mode 100644 index 0000000..973eef6 --- /dev/null +++ b/docs/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 `__ +or `Google +Chrome `__ +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.onap.ccsdk.features.sdnr + 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.onap.ccsdk.features.sdnr + 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/fault.rst b/docs/fault.rst new file mode 100644 index 0000000..4e3c9f5 --- /dev/null +++ b/docs/fault.rst @@ -0,0 +1,58 @@ +.. 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 into three views. + +Current Problem List +~~~~~~~~~~~~~~~~~~~~ + +Lists all current active faults in the network. In addition, it also +lists alarms sent by the SDN controller itself, which detects connection +losses to the NetConf server (connectionLossOAM) or to a device via a +mediator to a device (connectionLossNeOAM). + +Alarm Notifications +~~~~~~~~~~~~~~~~~~~ + +As long as the view is open, all alarm notifications received by the SDN +Controller are listed. 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 table. + +The server synchronizes with the current alarm lists of the devices. +Based on raised and cleared notifications, the current alarm status of +the network is calculated. 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 side. + +An alarm status bar in the header of the web application informs the +operator about the health status of the network. + +The ODLUX web application uses web sockets to update the graphical user +interface of the Alarm Notifications (devices) and Connection Status +Notifications in real-time. diff --git a/docs/general.rst b/docs/general.rst new file mode 100644 index 0000000..85814d5 --- /dev/null +++ b/docs/general.rst @@ -0,0 +1,59 @@ +.. contents:: + :depth: 3 +.. + +General functionality +===================== + +The following functionality is common to all applications. + +Table data export +----------------- + +Every table can export its data via the '︙' button. The data, which +gets exported is the currently viewed data in the table. As the default +pagination is set to 10, only the first 10 rows or filtered rows will be +exported. To increase the number of exported rows, change the +pagination. + +The behavior of the export can vary based on the browser: + +a) Some browsers allow you to save the file with the predefined name + export.csv. In case your browser does not offer this function please + use the 'Save as...' option and define the filename with extension + csv. + +b) Some browsers save the file automatically with the alphanumeric name + but without an extension. In such a case navigate to the downloaded + file location and rename the file. The extension (csv) must be + appended to the name. The result should look like 'export\_file.csv'. + +Table filters +------------- + +The following filters are supported by all tables based on the data type +of the column. + ++------------+------------------+------------+ +| Data type | Possible Filter | Example | ++============+==================+============+ +| Text | Any characters | Test, | +| | or numbers, | Tes\ \*, | +| | matches exactly | \*\ t | +| | unless a \* is | | +| | used. The \* | | +| | acts as a | | +| | wildcard and can | | +| | be used for | | +| | contains, ends | | +| | with and begins | | +| | with queries. | | ++------------+------------------+------------+ +| Numeric | < or <= or > or | >5000, 20, | +| | >= or exact | <=82 | +| | number | | ++------------+------------------+------------+ +| Boolean | None (no filter | true, | +| | set), true or | false | +| | false | | ++------------+------------------+------------+ diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..7fe4daf --- /dev/null +++ b/docs/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/docs/inventory.rst b/docs/inventory.rst new file mode 100644 index 0000000..1acee6d --- /dev/null +++ b/docs/inventory.rst @@ -0,0 +1,36 @@ +.. contents:: + :depth: 3 +.. + +Inventory +========= + +The application offers basic inventory management of devices supporting +ONF-TR-512 and ietf-hardware. + +The view displays the inventory data of the network element – for +example, serial-numbers and part-numbers according to the containment of +the equipment. + +Inventory Export: +----------------- + +The '︙' button in the upper right corner of the table allows exporting +the inventory data as a CSV file. + +Only the currently viewed table data is exported. As the default +pagination is set to 10, only the first 10 rows or filtered rows would +be exported. To increase the number of exported rows change the +pagination. + +The behavior of the export can vary based on different browsers: + +a) Some browsers allow you to save the file with the predefined name + export.csv. In case your browser does not offer this function please + use the 'Save as...' option and define the filename with extension + csv. + +b) Some browsers save the file automatically with the alphanumeric name + but without an extension. In such a case navigate to the downloaded + file location and rename the file. The extension (csv) must be + appended to the name. The result should look like export\_file.csv. diff --git a/docs/maintenance.rst b/docs/maintenance.rst new file mode 100644 index 0000000..592cb49 --- /dev/null +++ b/docs/maintenance.rst @@ -0,0 +1,22 @@ +.. contents:: + :depth: 3 +.. + +Maintenance +=========== + +The 'Maintenance' application on OpenDaylight provides information about +planned maintenances of Network Elements, currently or in the future. +Users can manage devices to set the maintenance mode so that no +unnecessary alarms are created. When the device is in maintenance mode, +alarms are not forwarded to DCAE. As soon as the maintenance is +finished, the alarms will start flowing again. + +The 'active' field in the table shows if the Network Element is +currently in maintenance mode 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 a future date or is already +completed. + +Users can disable the maintenance mode or change its start and end dates +by using the available options in the actions column. diff --git a/docs/mediator.rst b/docs/mediator.rst new file mode 100644 index 0000000..1dad777 --- /dev/null +++ b/docs/mediator.rst @@ -0,0 +1,19 @@ +.. contents:: + :depth: 3 +.. + +Mediator +======== + +Some device vendors (Altiostar, CommScope, Dragonwave-X) use the +`generic mediator +framework `__. Such mediators +offer an API to create, delete, start and stop mediator instances. + +New mediator servers can be added via the '+' button. Afterward, a +server can be selected to view all available mediator instances. + +A mediator instance can be started, stopped and deleted using the +available actions. Additionally, its details can be viewed. The '+' +button allows the user to add a new instance. During the creation, at +least one 'ODL auto connect' configuration must be added. diff --git a/docs/overview.rst b/docs/overview.rst index d01358d..d0bb5b3 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -5,13 +5,22 @@ OAM Operation and Maintenance Overview ====================================== -The O-RAN SC OAM provides administrative and operator +The O-RAN SC OAM project provides administrative and operator functions for O-RAN components, such as Near-Realtime-RAN-Inelegent-Controller, O-RAN Centralized Unit, O-RAN Distributed Unit and O-RAN Radio Unit. The project follows the specifications for the O1 interface as provided by O-RAN Working Group1. +The O-RAN-SC OAM project adds features and functions to the OpenDaylight-based ONAP +controller 'CCSDK/SDNC'. It is built on the Common Controller Framework +to control and manage O-RAN managed elements and O-RAN managed functions. + +.. figure:: ./_static/o-ran-architecture.png + :alt: SDN-R in ONAP + + SDN-R in ONAP + Project Resources ----------------- diff --git a/docs/performance.rst b/docs/performance.rst new file mode 100644 index 0000000..17e4a51 --- /dev/null +++ b/docs/performance.rst @@ -0,0 +1,26 @@ +.. 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 retrieves the values +from the database and displays them in a graphical user interface. + +Performance history values +-------------------------- + +After selecting a connected PNF supporting ONF-TR-532 and a physical +interface, the application collects the received and centralized stored +performance values for this interface. + +The values are visualized using two views: a line chart and a table, +with the chart always shown first. To switch between them, toggle +buttons can be used. The chart view offers a filter to quickly limit the +shown values. To keep both views in sync, the filters of the chart and +the table are connected. If one view is filtered, the other one gets +updated in the background. diff --git a/docs/sdnr_Docker_Image_configuration.rst b/docs/sdnr_Docker_Image_configuration.rst new file mode 100644 index 0000000..5297a09 --- /dev/null +++ b/docs/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 `__. + +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 `__ | ++------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+ +| SDNRNORTHBOUND | true\|\ **false** | Set true to activate sdnr oofpci service. | ++------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/sdnr_WT_Service_Configuration_parameters.rst b/docs/sdnr_WT_Service_Configuration_parameters.rst new file mode 100644 index 0000000..a27e511 --- /dev/null +++ b/docs/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 `__. + +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 `__ - 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 | ++----------------------------------+-----------------------------------------------+---------------+------------+--------------------------------------------------------------+ diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 5e11de1..717674a 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -5,6 +5,13 @@ OAM User Guide ============== -This document provides a quickstart for users of the O-RAN SC O1 web application. +This document provides a quickstart for users of the O-RAN SC OAM web application. -Please see documentation of ODLUX Applications in ONAP: docs.onap.org/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/applications.html \ No newline at end of file +.. toctree:: + :maxdepth: 1 + + general + applications + installation + faq + abbreviations \ No newline at end of file