blob: 9f7f4a8431ecdb4eeef8ac5e7fd59e0616e792a6 [file] [log] [blame]
elinuxhenrikdbe5b8a2022-06-10 14:23:46 +02001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. SPDX-License-Identifier: CC-BY-4.0
3.. Copyright (C) 2021 Nordix
4
5.. |archpic| image:: ./images/nonrtric-architecture-E.png
6 :alt: Image: O-RAN SC - NONRTRIC Overall Architecture
7
8DMaaP Adapter
9~~~~~~~~~~~~~
10
11************
12Introduction
13************
14
15This use case is a non-real-world closed-loop use case to demonstrate automated recovery when the front-haul connection between an O-DU and O-RU is reset.
16An application in the NONRTRIC senses the fault from the O-RU (O1-FM) and initiates a NETCONF reset operation (O1-CM) using the OAM controller.
17More details about the use case can be found on the O-RAN SC wiki: `RSAC <https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=20878423>`_ and `OAM <https://wiki.o-ran-sc.org/display/OAM/Closed+loop+use+case>`_.
18
19Non-RT RIC provides multiple implementation versions of the recovery part of the use case. One in the form of a python
20script, one utilizing the ONAP Policy Framework, and one Go version that utilizes Information Coordination Service (ICS).
21
22The code is available in the `use case repo <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric%2Frapp%2Forufhrecovery.git;a=summary>`_
23
24Standalone Script Solution
25++++++++++++++++++++++++++
26
27The script version consists of a python script that performs the tasks needed for the use case. There are also two
28simulators. One message generator that generates alarm messages, and one SDN-R simulator that receives the config
29change messages sent from the script and responds with alarm cleared messages to MR.
30
31All parts are Dockerized and can be started as individual containers, in the same network, in Docker.
32
33ONAP Policy Solution
34++++++++++++++++++++
35
36There is also another solution for performing the front-haul recovery that is based on `ONAP Policy Framework <https://wiki.onap.org/display/DW/Policy+Framework+Project>`_.
37A TOSCA Policy has been created that listens to DMaaP Message Router, makes a decision on an appropriate remedy and then signals the decision as a configuration change message via
38REST call to the OAM controller.
39
40There is a `docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=docker-compose/docker-compose-policy-framework>`_ available
41in the nonrtric repo for bringing up the complete standalone version of ONAP Policy Framework.
42
43The detailed instructions for deploying and running this policy are provided in
44the `wiki <https://wiki.o-ran-sc.org/display/RICNR/O-RU+Fronthaul+Recovery+usecase>`_.
45
46ICS Consumer Solution
47+++++++++++++++++++++
48
49The ICS Consumer solution is implemented in Go and instead of polling MR itself, it registers as a consumer of the "STD_Fault_Messages" job in ICS.
50
51O-DU Slice Assurance
52--------------------
53
54A very simplified closed-loop rApp use case to re-prioritize a RAN slice's radio resource allocation priority if sufficient throughput cannot be maintained. Not intended to to be 'real-world'.
55
56The Go implementation of the solution can be found in
57this `link <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric/rapp/ransliceassurance.git;a=tree;f=smoversion>`__.