X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=scriptversion%2FREADME.md;h=6efe0809da8725166b2f2bc4273124a47e50533d;hb=02ba4a3689e89ae0bbceabc66249f126b82d080e;hp=6b59388d5521b6b8a99f990d5a27e18197c2dea4;hpb=4712571d72f5c7d58f5d8820a97fa7673e0b1325;p=nonrtric%2Frapp%2Forufhrecovery.git diff --git a/scriptversion/README.md b/scriptversion/README.md index 6b59388..6efe080 100644 --- a/scriptversion/README.md +++ b/scriptversion/README.md @@ -1,8 +1,8 @@ -# Use case Link Failure +# Non-RealTime RIC O-RU Fronthaul Recovery ## General -The Link Failure use case test provides a python script that regularly polls DMaaP Message Router (MR) for "CUS Link Failure" +The script version of the O-RU Fronthaul Recovery use case provides a python script that regularly polls DMaaP Message Router (MR) for "CUS Link Failure" messages. When such a message appears with the "eventSeverity" set to anything but "NORMAL", a configuration change message with the @@ -11,7 +11,7 @@ When such a message appears with the "eventSeverity" set to anything but "NORMAL When such a message appears with the "eventSeverity" set to "NORMAL" a printout will be made to signal that the alarm has been cleared, provided that the verbose option has been used when the test was started. -## Prerequisits +## Prerequisites To run this script Python3 needs to be installed. To install the script's dependencies, run the following command from the `app` folder: `pip install -r requirements.txt` @@ -58,7 +58,7 @@ using the command, with available params listed: ## Use docker-compose -Go to the `docker-compose/` folder and run `bash start.sh`. +Go to the `docker-compose/` folder and run `bash start.sh`, see [control loop version](docker-compose-controlloop/README.md). This scripts will start up four components: dmaap-mr