.. 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 <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric%2Frapp%2Fhealthcheck.git;a=summary>`_.
.. image:: ./images/healthcheck.png
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 <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric%2Frapp%2Forufhrecovery.git;a=summary>`_
+
Standalone Script Solution
++++++++++++++++++++++++++
All parts are Dockerized and can be started as individual containers, in the same network, in Docker.
-The script based solution can be found here:
-`Script version <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=test/usecases/oruclosedlooprecovery/scriptversion;b=HEAD>`_.
-
ONAP Policy Solution
++++++++++++++++++++
There 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>`_.
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. The policy based solution can be found here:
-`Policy version <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=test/usecases/oruclosedlooprecovery/apexpolicyversion;b=HEAD>`_.
+REST call to the OAM controller.
-There is a `docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=docker-compose/docker-compose-policy-framework;b=HEAD>`_ available
+There 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
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 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.
-The Go implementation of the solution can be found here:
-`Go version <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=test/usecases/oruclosedlooprecovery/goversion;b=HEAD>`_.
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 <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=test/usecases/odusliceassurance/goversion;b=HEAD>`_.
+this `link <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric/rapp/ransliceassurance.git;a=tree;f=smoversion>`__.