blob: dd34e45ffb7295c43f60a84ea1d5fcb53cf1c6a0 [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
elinuxhenrik196cb832022-06-23 13:24:21 +02005O-RU Fronthaul Recovery Use Case
6~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
elinuxhenrikdbe5b8a2022-06-10 14:23:46 +02007
8************
9Introduction
10************
11
12This 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.
13An 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.
14More 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>`_.
15
16Non-RT RIC provides multiple implementation versions of the recovery part of the use case. One in the form of a python
17script, one utilizing the ONAP Policy Framework, and one Go version that utilizes Information Coordination Service (ICS).
18
19The code is available in the `use case repo <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric%2Frapp%2Forufhrecovery.git;a=summary>`_
20
elinuxhenrik196cb832022-06-23 13:24:21 +020021This product is a part of :doc:`NONRTRIC <nonrtric:index>`.
22
elinuxhenrikdbe5b8a2022-06-10 14:23:46 +020023Standalone Script Solution
24++++++++++++++++++++++++++
25
26The script version consists of a python script that performs the tasks needed for the use case. There are also two
27simulators. One message generator that generates alarm messages, and one SDN-R simulator that receives the config
28change messages sent from the script and responds with alarm cleared messages to MR.
29
30All parts are Dockerized and can be started as individual containers, in the same network, in Docker.
31
32ONAP Policy Solution
33++++++++++++++++++++
34
35There 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>`_.
36A 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
37REST call to the OAM controller.
38
39There 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
40in the nonrtric repo for bringing up the complete standalone version of ONAP Policy Framework.
41
42The detailed instructions for deploying and running this policy are provided in
43the `wiki <https://wiki.o-ran-sc.org/display/RICNR/O-RU+Fronthaul+Recovery+usecase>`_.
44
45ICS Consumer Solution
46+++++++++++++++++++++
47
48The 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.
49
50O-DU Slice Assurance
51--------------------
52
53A 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'.
54
55The Go implementation of the solution can be found in
56this `link <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric/rapp/ransliceassurance.git;a=tree;f=smoversion>`__.