X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=test%2Fusecases%2Fodusliceassurance%2Fgoversion%2FREADME.md;h=f28ed4bd30f2a4303d4166029da39e39f05ad6b8;hb=df5eeb6e3fe42f87ac399f624edef20c87d1e475;hp=7fdea74d6a90f49bbc471aa60a7c49aacfd53d9f;hpb=534a1fe8136ed8d72615707008bdd6061d1df2fe;p=nonrtric.git diff --git a/test/usecases/odusliceassurance/goversion/README.md b/test/usecases/odusliceassurance/goversion/README.md index 7fdea74d..f28ed4bd 100644 --- 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 ] [--dmaap-port ] ## License