From 408ef23df4e1ddcf62ae81d792b4daa9b21e2861 Mon Sep 17 00:00:00 2001 From: JohnKeeney Date: Mon, 13 Dec 2021 17:52:29 +0000 Subject: [PATCH] More documentation updates Issue-ID: NONRTRIC-643 Change-Id: I423913abbaa3f55b33e2879d3c9756dc36608cf0 Signed-off-by: JohnKeeney --- docs/installation-guide.rst | 8 ++++---- docs/use-cases.rst | 13 ++++++++----- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 31317c06..0d0b3a9d 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -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 `" folder for more information. +See the README file in the "`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 `" folder, and on the `wiki page ` +For more information on running and configuring the functions can be found in the Readme file in the "`docker-compose `__" folder, and on the `wiki page `_ Install with Helm +++++++++++++++++ -Helm charts and an example recipe are provided in the `it/dep repo `__, +Helm charts and an example recipe are provided in the `it/dep repo `_, 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 diff --git a/docs/use-cases.rst b/docs/use-cases.rst index 4cbbed94..d45a4a08 100644 --- a/docs/use-cases.rst +++ b/docs/use-cases.rst @@ -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) `_ and `(OAM) `_. -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 `_. +this `link `_. + +The Go implementation of the solution can also be found in +this `link `_. 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 `_. +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 `_. @@ -51,4 +54,4 @@ There is a `docker-compose `_. \ No newline at end of file +the `wiki `_. \ No newline at end of file -- 2.16.6