Merge "Remove rApp Catalogue"

[nonrtric.git] / test / usecases / odusliceassurance / goversion / README.md

diff --git a/test/usecases/odusliceassurance/goversion/README.md b/test/usecases/odusliceassurance/goversion/README.md
index 7fdea74..f28ed4b 100644 (file)
--- a/test/usecases/odusliceassurance/goversion/README.md
+++ b/test/usecases/odusliceassurance/goversion/README.md
@@ -1,4 +1,4 @@
-# O-RAN-SC Non-RealTime RIC O-DU Closed Loop Usecase Slice Assurance 
+# O-RAN-SC Non-RealTime RIC O-DU Closed Loop Usecase Slice Assurance
 
 ## Configuration
 
@@ -6,27 +6,30 @@ The consumer takes a number of environment variables, described below, as config
 
 >- MR_HOST              **Required**. The host for Dmaap Message Router.                           Example: `http://mrproducer`
 >- MR_PORT              **Required**. The port for the Dmaap Message Router.                       Example: `8095`
->- SDNR_ADDRESS         Optional. The address for SDNR.                                            Defaults to `http://localhost:3904`.
+>- SDNR_ADDR            Optional. The address for SDNR.                                            Defaults to `http://localhost:3904`.
 >- SDNR_USER            Optional. The user for the SDNR.                                           Defaults to `admin`.
 >- SDNR_PASSWORD        Optional. The password for the SDNR user.                                  Defaults to `Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U`.
 >- LOG_LEVEL            Optional. The log level, which can be `Error`, `Warn`, `Info` or `Debug`.  Defaults to `Info`.
 >- POLLTIME             Optional. Waiting time between one pull request to Dmaap and another.      Defaults to 10 sec
 
+## Functionality
+
+There is a status call provided in a REST API on port 40936.
+>- /status  OK
 
 ## Development
 
-To make it easy to test during development of the consumer, two stubs are provided in the `stub` folder.
+To make it easy to test during development of the consumer, there is a stub provided in the `stub` folder.
 
-One, under the `mrstub` folder, called `mrstub` that stubs the VES message received from Dmaap and pushes messages with information about performance measurements for the slices in a determinated DU. To build and start the stub, do the following:
->1. cd stub/producer
->2. go build
->3. ./mrstub
+This stub is used to simulate both received VES messages from Dmaap MR with information about performance measurements for the slices in a determinated DU and also SDNR, that sends information about Radio Resource Management Policy Ratio and allows to modify value for RRM Policy Dedicated Ratio from default to higher value.
 
-One, under the `sdnr` folder, called `sdnr` that at startup will listen for REST calls and print the body of them. By default, it listens to the port `3904`, but his can be overridden by passing a `-port [PORT]` flag when starting the stub. To build and start the stub, do the following:
->1. cd stub/sdnr
->2. go build
->3. ./sdnr
+By default, SDNR stub listens to the port `3904`, but his can be overridden by passing a `--sdnr-port [PORT]` flag when starting the stub. For Dmaap MR stub default port is `3905` but it can be overriden by passing a `--dmaap-port [PORT]` flag when starting the stub.
 
+To build and start the stub, do the following:
+
+>1. cd stub
+>2. go build
+>3. ./stub [--sdnr-port <portNo>] [--dmaap-port <portNo>]
 
 ## License