More documentation updates 31/7331/1
authorJohnKeeney <john.keeney@est.tech>
Mon, 13 Dec 2021 17:52:29 +0000 (17:52 +0000)
committerJohnKeeney <john.keeney@est.tech>
Mon, 13 Dec 2021 17:52:40 +0000 (17:52 +0000)
Issue-ID: NONRTRIC-643
Change-Id: I423913abbaa3f55b33e2879d3c9756dc36608cf0
Signed-off-by: JohnKeeney <john.keeney@est.tech>
docs/installation-guide.rst
docs/use-cases.rst

index 31317c0..0d0b3a9 100644 (file)
@@ -13,7 +13,7 @@ This document describes how to install the Non-RT RIC components, their dependen
 Preface
 -------
 
-See the README file in the "`docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=docker-compose>`" folder for more information.
+See the README file in the "`docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=docker-compose>`_" folder for more information.
 
 Software Installation and Deployment
 ------------------------------------
@@ -31,15 +31,15 @@ command to start the components:
            -f ics/docker-compose.yaml
 
 The example above is just an example to start some of the components. 
-For more information on running and configuring the functions can be found in the Readme file in the "`docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=docker-compose>`" folder, and on the `wiki page <https://wiki.o-ran-sc.org/display/RICNR/Release+E+-+Run>`
+For more information on running and configuring the functions can be found in the Readme file in the "`docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=docker-compose>`__" folder, and on the `wiki page <https://wiki.o-ran-sc.org/display/RICNR/Release+E+-+Run>`_
 
 Install with Helm
 +++++++++++++++++
 
-Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`__,
+Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_,
 under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which
 components that will be installed can be controlled. Then the components can be installed and started by running the
-following comand:
+following command:
 
       .. code-block:: bash
 
index 4cbbed9..d45a4a0 100644 (file)
@@ -25,7 +25,7 @@ This use case is a non-real-world closed-loop use case to demonstrate automated
 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) <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>`_.
 
-Non-RT RIC provides two implementation versions of the recovery part of the use case. One in the form of a python
+Non-RT RIC provides multiple 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.
 
 Standalone Script Solution
@@ -37,13 +37,16 @@ change messages sent from the script and responds with alarm cleared messages to
 All parts are Dockerized and can be started as individual containers, in the same network, in Docker.
 
 The script based solution can be found in
-this `link <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=test/usecases/oruclosedlooprecovery/scriptversion;b=HEAD>`_.
+this `link <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=test/usecases/oruclosedlooprecovery;b=HEAD>`_.
+
+The Go implementation of the solution can also be found in
+this `link <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=test/usecases/oruclosedlooprecovery;b=HEAD>`_.
 
 ONAP Policy Solution
 ++++++++++++++++++++
 
-There is also another solution for performing the fronthaul recovery that is based on ONAP Policy Framework.
-A TOSCA Policy has been created that listens to DMaaP Message Router and sends a configuration change message via
+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 <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=test/usecases/oruclosedlooprecovery/apexpolicyversion;b=HEAD>`_.
 
@@ -51,4 +54,4 @@ There is a `docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;
 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 <https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=35881325>`_.
\ No newline at end of file
+the `wiki <https://wiki.o-ran-sc.org/display/RICNR/Run+O-RU+O-DU+Fronthaul++Recovery+usecase>`_.
\ No newline at end of file