X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fuse-cases.rst;h=c9f4d39de74babc17dbc9cce04ebf4525a4aa6cc;hb=10367fe2265369ef635d12a9aa19b80fe656fcbd;hp=dabcf62602e5de00f9d0b2ec30c6809ac853cd51;hpb=01ea4be5a7b6db523676a766fc4eef72385cb01a;p=nonrtric.git diff --git a/docs/use-cases.rst b/docs/use-cases.rst index dabcf626..c9f4d39d 100644 --- a/docs/use-cases.rst +++ b/docs/use-cases.rst @@ -3,33 +3,36 @@ .. Copyright (C) 2021 Nordix Use Cases -========= +######### -To support the use cases defined for the Non-RT RIC, there are implementations provided in the nonrtric repo, see: - nonrtric/test/usecases +To support the use cases defined for the Non-RT RIC, there are implementations provided in the Non RT-RIC project. Health Check ------------ + The Health Check use case for the Non-RT RIC is a python script that regularly creates, reads, updates, and deletes a policy in all Near-RT RICs that support the type used by the script. A self refreshing web page provides a view of statistics for these regular checks. -For more information about it, see the README file in the use case's folder. +For more information about it, see the README file in `repo `_. .. image:: ./images/healthcheck.png -O-RU closed loop recovery -------------------------- +O-RU Front-Haul Recovery +------------------------ + +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 `_. -This use case is a non-real-world closed-loop use case to demonstrate automated recovery when the front-haul connection between and O-DU and O-RU is reset. -An application in the NONRTRIC sense 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). -Non-RT RIC provides two implementation versions of the recovery part of the use case. One in the form of a python -script, and one utilizing the ONAP Policy Framework. +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. @@ -39,4 +42,25 @@ All parts are Dockerized and can be started as individual containers, in the sam ONAP Policy Solution ++++++++++++++++++++ -**** \ No newline at end of file +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 `__.