diff options
Diffstat (limited to 'docs/guides')
| -rw-r--r-- | docs/guides/onap-user/abbreviations.rst | 36 | ||||
| -rw-r--r-- | docs/guides/onap-user/connect.rst | 46 | ||||
| -rw-r--r-- | docs/guides/onap-user/general.rst | 59 | ||||
| -rw-r--r-- | docs/guides/onap-user/mwtnLog.rst | 4 | ||||
| -rw-r--r-- | docs/guides/onap-user/pnfConfig.rst | 12 | ||||
| -rw-r--r-- | docs/guides/onap-user/pnfEventLog.rst | 11 | ||||
| -rw-r--r-- | docs/guides/onap-user/pnfFault.rst | 41 | ||||
| -rw-r--r-- | docs/guides/onap-user/pnfInventory.rst | 37 | ||||
| -rw-r--r-- | docs/guides/onap-user/pnfMaintenance.rst | 27 | ||||
| -rw-r--r-- | docs/guides/onap-user/pnfMediator.rst | 14 | ||||
| -rw-r--r-- | docs/guides/onap-user/pnfPerformance.rst | 11 | ||||
| -rw-r--r-- | docs/guides/onap-user/sdnr.rst | 9 | ||||
| -rw-r--r-- | docs/guides/onap-user/sdnr_Docker_Image_configuration.rst | 2 | ||||
| -rw-r--r-- | docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst | 2 |
14 files changed, 209 insertions, 102 deletions
diff --git a/docs/guides/onap-user/abbreviations.rst b/docs/guides/onap-user/abbreviations.rst index 65e79bf39..50ee3c26f 100644 --- a/docs/guides/onap-user/abbreviations.rst +++ b/docs/guides/onap-user/abbreviations.rst @@ -449,6 +449,23 @@ Abbreviations | NS | (Vendor Specific) | | | New Start | +-------------------+-------------------+ +| O-RAN | `O-RAN Alliance, | +| | Operator Defined | +| | Next Generation | +| | Radio Access | +| | Networks | +| | Alliance <https:/ | +| | /www.o-ran.org>`_ | +| | _ | ++-------------------+-------------------+ +| O-RAN-SC | `O-RAN Software | +| | Community <https: | +| | //o-ran-sc.org>`_ | +| | _ | ++-------------------+-------------------+ +| OAM | Operation and | +| | Maintenance | ++-------------------+-------------------+ | OA&M | Operations, | | | Administration | | | and Management | @@ -498,6 +515,12 @@ Abbreviations | | %28OSAM%29+Use+Ca | | | se>`__ | +-------------------+-------------------+ +| OSC | O-RAN Software | +| | Community or | +| | Optical | +| | Supervisory | +| | Channel | ++-------------------+-------------------+ | OSS | Operations | | | Support System | +-------------------+-------------------+ @@ -559,7 +582,10 @@ Abbreviations | | ional_state_trans | | | fer>`__ | +-------------------+-------------------+ -| RESTCONF | REST + NETCONF | +| RESTCONF | A protocol based | +| | on HTTP for | +| | configuring data | +| | defined in YANG | +-------------------+-------------------+ | RO | Resource | | | Orchestrator | @@ -843,7 +869,13 @@ Abbreviations | | wiki/WAR_(file_fo | | | rmat)>`__ | +-------------------+-------------------+ -| YANG | A Data Modeling | +| xNF | The combination | +| | of PNF and VNF; | +| | Network Function | ++-------------------+-------------------+ +| YANG | Yet Another Next | +| | Generation - a | +| | Data Modeling | | | Language for the | | | Network | | | Configuration | diff --git a/docs/guides/onap-user/connect.rst b/docs/guides/onap-user/connect.rst index 9678dd6ff..6da746953 100644 --- a/docs/guides/onap-user/connect.rst +++ b/docs/guides/onap-user/connect.rst @@ -7,39 +7,35 @@ Connect The 'Connect' application on OpenDaylight provides up-to-date connectivity information about the wireless devices in the network. It -automatically displays new network elements and their connection status. -Despite the network elements usually automatically mount themselves, an -additional small window allows manually mounting devices/mediators. For -better understanding alarms and status, a connection status log lists -all the connection status changes of OpenDaylight mount points. +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. 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 interfaces is divided in three sections. +The graphical user interface is divided into two sections. -Required Network Elements -~~~~~~~~~~~~~~~~~~~~~~~~~ +Network Elements +~~~~~~~~~~~~~~~~ -Required Network Elements are physical network functions, which are -planned or expected in the network. This means the identifier, IP -addresses and its required configuration is well-known and available in -a planning database or in ONAP A&AI. +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. -This view also offer to manually configure/mount the device with the '+' -icon. The SDN controller will then start connecting 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. -Unknown Network Elements -~~~~~~~~~~~~~~~~~~~~~~~~ - -Most of the physical network function support an automatic registration -procedure to the SDN controller. It may happen, that devices are -connected to the SDN Controller but not available in planning data. - -It might be a normal occurrence for very cheap devices, where an entire -planning process to too expensive. But is may also happen that the -identifier used in planning process differ from the identifier currently -configured in the device. +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 ~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/guides/onap-user/general.rst b/docs/guides/onap-user/general.rst new file mode 100644 index 000000000..570930ec4 --- /dev/null +++ b/docs/guides/onap-user/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/guides/onap-user/mwtnLog.rst b/docs/guides/onap-user/mwtnLog.rst index dce9539bb..3cfd61bd1 100644 --- a/docs/guides/onap-user/mwtnLog.rst +++ b/docs/guides/onap-user/mwtnLog.rst @@ -6,5 +6,5 @@ Log === The application displays (UX) application logs. SDN-R offer a common log -server, so that PNFs or other ONAP/ECOMP components could log there data -in a common way. +server, so that PNFs or other ONAP components could log there data in a +common way. diff --git a/docs/guides/onap-user/pnfConfig.rst b/docs/guides/onap-user/pnfConfig.rst index f751255d4..29e2296c7 100644 --- a/docs/guides/onap-user/pnfConfig.rst +++ b/docs/guides/onap-user/pnfConfig.rst @@ -7,9 +7,9 @@ Configuration The application shows the actual values of all attributes of the ONF-TR-532 for a selected physical network function (PNF). Each view of -a functional element is divide into capabilities, configuration, status, -current problem, current performance and history performance information -according to TR-532. +a 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. @@ -18,9 +18,9 @@ The operator is notified about successfully configuring the device. Implementation -------------- -The applications are implemented as OpenDaylight-DLUX web application +The application is implemented as OpenDaylight-DLUX web application using the RestConf northbound interface of the SDN controller. The key -frameworks are: Maven, Angular.js, Bootstrap and UI-Grid. +frameworks are: Typescript, React and material-ui. -Connections status information are updated automatically due to a web +Connection status information is updated automatically using a web socket for notifications from OpenDaylight to the browser. diff --git a/docs/guides/onap-user/pnfEventLog.rst b/docs/guides/onap-user/pnfEventLog.rst new file mode 100644 index 000000000..036c1f94b --- /dev/null +++ b/docs/guides/onap-user/pnfEventLog.rst @@ -0,0 +1,11 @@ +.. contents:: + :depth: 3 +.. + +Event Log +========= + +The 'EventLog' application displays application logs and messages +automatically created by the different active applications. SDN-R offers +a common log service so that PNFs or other ONAP components can log their +data and users can analyze and export the data in a common way. diff --git a/docs/guides/onap-user/pnfFault.rst b/docs/guides/onap-user/pnfFault.rst index ff3a1ac47..5e54547a9 100644 --- a/docs/guides/onap-user/pnfFault.rst +++ b/docs/guides/onap-user/pnfFault.rst @@ -13,24 +13,23 @@ the severity level (warning, minor, major, critical). Views ----- -The graphical user interface is separated in three views. +The graphical user interface is separated into three views. Current Alarms ~~~~~~~~~~~~~~ -It list all current active faults in the network. In addition it also -list alarms sent by the SDN controller itself, which detects connections -losses to the NetConf server (connectionLossOAM) or which detects -connection loss to a devices via a mediator to a device -(connectionLossNeOAM). +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, it lists all alarm notification reached by -the SDN Controller. Please note that refreshing the view will start the -collection again. Previous alarm notification can be viewed in the alarm -log. +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 ~~~~~~~~~ @@ -42,18 +41,18 @@ Implementation -------------- The application has two parts. While the server is listening for NetConf -notifications to store them in the database the client retrieves the -information from the database and displays them in a grid view. +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 and -calculates based on raise and clear notifications the current alarm -status of the network. The current alarms are stored in a database. In -addition all Problem Notifications received by the SDN controller are -stored. There is no logic implemented on the client. +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 on top of each graphical user interface informs the +An alarm status bar in the header of the web application informs the operator about the health status of the network. -The OpenDaylight DLUX web application uses web sockets for updating the -graphical user interface in case of Problem Notification (devices) and -Connection Status Notifications (ODL). +The OpenDaylight-DLUX web application uses web sockets to update the +graphical user interface of the Problem Notifications (devices) and +Connection Status Notifications (ODL) in real-time. diff --git a/docs/guides/onap-user/pnfInventory.rst b/docs/guides/onap-user/pnfInventory.rst index 0a9bf16c7..1acee6d80 100644 --- a/docs/guides/onap-user/pnfInventory.rst +++ b/docs/guides/onap-user/pnfInventory.rst @@ -6,30 +6,31 @@ Inventory ========= The application offers basic inventory management of devices supporting -ONF-TR-512. +ONF-TR-512 and ietf-hardware. -The view displays the inventory data of the network element - basically -serial-numbers and part-numbers are displaced according to the -containment of the equipment. +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: ----------------- -As the default pagination size is set to 10, when you export the data -only first 10 rows or the first 10 filtered rows shown on the page will -be exported to a file. The inventory export allows the export of up to -1000 entries, when the pagination size is increased to 1000. So, It is -recommended to change the pagination size 'Rows per page' to 1000 if you -want to export the complete Inventory data. +The '︙' button in the upper right corner of the table allows exporting +the inventory data as a CSV file. -To export the Inventory data: The behaviour is different depending on -the browser: +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. -a) Some browsers allows you to save the file with the predefined name +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 'Save as..' option and define the filename with extension csv. + use the 'Save as...' option and define the filename with extension + csv. -b) Some browsers saves the file automatically with the alphanumeric name - without an extension. In such case please go to the downloaded file - location and rename the file with the extension after the download. - (eg: export\_file.csv) +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/guides/onap-user/pnfMaintenance.rst b/docs/guides/onap-user/pnfMaintenance.rst index 9a0be0b00..592cb4947 100644 --- a/docs/guides/onap-user/pnfMaintenance.rst +++ b/docs/guides/onap-user/pnfMaintenance.rst @@ -5,19 +5,18 @@ Maintenance =========== -The 'Maintenance' application on the OpenDaylight provides the -information of the Network Elements which are set for Maintenance, -currently or in the future. User can manage devices to set the -maintenance mode so that no unnecessary alarms are created. When the -device is in Maintenace alarms are not forwarded to DCAE and when the -device maintenance is turned off the alarms will start flowing again. +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. -'Active' field in this application shows if the Network Element is in -maintenance mode currently or not. If it is 'active' it means the -Network Element is currently undergoing maintenance, If 'not active' it -means maintenance might have been set for future or maintenance is -already completed. +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 have access to disable the Maintenance mode or change the -maintenance start and end dates at any point of time by using the -available options in actions column. +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/guides/onap-user/pnfMediator.rst b/docs/guides/onap-user/pnfMediator.rst index 43aefb9c0..1dad77790 100644 --- a/docs/guides/onap-user/pnfMediator.rst +++ b/docs/guides/onap-user/pnfMediator.rst @@ -5,7 +5,15 @@ Mediator ======== -Some device vendors (Altiostar, CommScope, Dragonwave-X) uses the +Some device vendors (Altiostar, CommScope, Dragonwave-X) use the `generic mediator -framework <https://github.com/Melacon/NetConf2SNMP>`__. Such mediator -offers an API to create, delete, start and stop mediator instances. +framework <https://github.com/Melacon/NetConf2SNMP>`__. 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/guides/onap-user/pnfPerformance.rst b/docs/guides/onap-user/pnfPerformance.rst index 9a1a8fcb5..2f37ac7f2 100644 --- a/docs/guides/onap-user/pnfPerformance.rst +++ b/docs/guides/onap-user/pnfPerformance.rst @@ -8,13 +8,14 @@ Performance Performance Monitoring values measured by the devices are necessary to analyze and optimize the network. Therefore the application automatically retrieves all historical performance values from the -devices and stores them in a database. The client part just retrieves -the values from the database and displays them in graphical user -interface. +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 selection of a connected PNF supporting ONF-TR-532 and an physical +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 and displays them in table views. +performance values for this interface. The data gets displayed as a line +chart to visualize the data in a given time period and a corresponding +table. If the table gets filtered, the chart updates itself. diff --git a/docs/guides/onap-user/sdnr.rst b/docs/guides/onap-user/sdnr.rst index 804556b16..e60eda851 100644 --- a/docs/guides/onap-user/sdnr.rst +++ b/docs/guides/onap-user/sdnr.rst @@ -6,13 +6,14 @@ SDN controller for 'Radio' (SDN-R) ================================== SDN-R adds features and functionality to the OpenDaylight-based ONAP -controller 'SDN-C'. It is built on the Common Controller Framework to -control and manage wireless resources. Wireless resources are virtual +controller 'CCSDK/SDNC'. It is built on the Common Controller Framework +to control and manage wireless resources. Wireless resources are virtual network functions (e.g. vBBU, vEPC) or physical network functions (e.g. microwave and millimeter wave radios, eNodeB, RRH, DAS equipment). -| SDN-R is integrated into ONAP. Therefore it is interfacing with PNFs - and VNFs and with other ONAP components, such as A&AI, DCAE and SO. +| SDN-R is integrated into ONAP using DMaaP APIs. It is interfacing with + PNFs and VNFs and with other ONAP components, such as A&AI, DCAE and + SO. | `See abbreviations <abbreviations.md>`__ .. figure:: ./ONAP-SDN-R.png diff --git a/docs/guides/onap-user/sdnr_Docker_Image_configuration.rst b/docs/guides/onap-user/sdnr_Docker_Image_configuration.rst index cd5f619a6..5297a0944 100644 --- a/docs/guides/onap-user/sdnr_Docker_Image_configuration.rst +++ b/docs/guides/onap-user/sdnr_Docker_Image_configuration.rst @@ -46,7 +46,7 @@ Different SDN-R services are using different parameter to be installed. | | | | | | | Devicemanager configuration is provided via *$ODL\_HOME/etc/devicemanager.properties* | | | | | -| | | See `SDN-R WT Service Configuration parameters <sdnr_WT_Service_Configuration_parameters>`__ | +| | | See `SDN-R WT Service Configuration parameters <sdnr_WT_Service_Configuration_parameters.html>`__ | +------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+ | SDNRNORTHBOUND | true\|\ **false** | Set true to activate sdnr oofpci service. | +------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst b/docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst index ed68ea517..a27e5113f 100644 --- a/docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst +++ b/docs/guides/onap-user/sdnr_WT_Service_Configuration_parameters.rst @@ -14,7 +14,7 @@ same for each cluster node. - `devicemonitor <#SDN-RWTServiceConfigurationparameters-d>`__ Backgrounds regarding the container inter structure is described -in \ `SDN-R Docker Image configuration <sdnr_Docker_Image_configuration>`__. +in \ `SDN-R Docker Image configuration <sdnr_Docker_Image_configuration.html>`__. The configuration information of sdnr wireless transport parameters are in a single file. |