X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Foverview.rst;fp=docs%2Foverview.rst;h=9f7f4a8431ecdb4eeef8ac5e7fd59e0616e792a6;hb=dbe5b8aae33876581a8b681610ed5f3395805da9;hp=0000000000000000000000000000000000000000;hpb=2ec55ebc0dc5821ccaab354ea31b6a1ace1d41c7;p=nonrtric%2Frapp%2Forufhrecovery.git diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..9f7f4a8 --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,57 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2021 Nordix + +.. |archpic| image:: ./images/nonrtric-architecture-E.png + :alt: Image: O-RAN SC - NONRTRIC Overall Architecture + +DMaaP Adapter +~~~~~~~~~~~~~ + +************ +Introduction +************ + +This 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. +An 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. +More details about the use case can be found on the O-RAN SC wiki: `RSAC `_ and `OAM `_. + +Non-RT RIC provides multiple implementation versions of the recovery part of the use case. One in the form of a python +script, one utilizing the ONAP Policy Framework, and one Go version that utilizes Information Coordination Service (ICS). + +The code is available in the `use case repo `_ + +Standalone Script Solution +++++++++++++++++++++++++++ + +The script version consists of a python script that performs the tasks needed for the use case. There are also two +simulators. One message generator that generates alarm messages, and one SDN-R simulator that receives the config +change messages sent from the script and responds with alarm cleared messages to MR. + +All parts are Dockerized and can be started as individual containers, in the same network, in Docker. + +ONAP Policy Solution +++++++++++++++++++++ + +There is also another solution for performing the front-haul recovery that is based on `ONAP Policy Framework `_. +A 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 +REST call to the OAM controller. + +There is a `docker-compose `_ available +in the nonrtric repo for bringing up the complete standalone version of ONAP Policy Framework. + +The detailed instructions for deploying and running this policy are provided in +the `wiki `_. + +ICS Consumer Solution ++++++++++++++++++++++ + +The 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. + +O-DU Slice Assurance +-------------------- + +A 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'. + +The Go implementation of the solution can be found in +this `link `__.