smoversion/README.md

   1 # O-RAN-SC Non-RealTime RIC O-DU Closed Loop Usecase Slice Assurance
   2
   3 ## Configuration
   4
   5 The consumer takes a number of environment variables, described below, as configuration.
   6
   7 >- MR_HOST              **Required**. The host for Dmaap Message Router.                           Example: `http://mrproducer`
   8 >- MR_PORT              **Required**. The port for the Dmaap Message Router.                       Example: `8095`
   9 >- SDNR_ADDR            Optional. The address for SDNR.                                            Defaults to `http://localhost:3904`.
  10 >- SDNR_USER            Optional. The user for the SDNR.                                           Defaults to `admin`.
  11 >- SDNR_PASSWORD        Optional. The password for the SDNR user.                                  Defaults to `Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U`.
  12 >- LOG_LEVEL            Optional. The log level, which can be `Error`, `Warn`, `Info` or `Debug`.  Defaults to `Info`.
  13 >- POLLTIME             Optional. Waiting time between one pull request to Dmaap and another.      Defaults to 10 sec
  14
  15 ## Functionality
  16
  17 There is a status call provided in a REST API on port 40936.
  18 >- /status  OK
  19
  20 ## Development
  21
  22 To make it easy to test during development of the consumer, there is a stub provided in the `stub` folder.
  23
  24 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.
  25
  26 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.
  27
  28 To build and start the stub, do the following:
  29
  30 >1. cd stub
  31 >2. go build
  32 >3. ./stub [--sdnr-port <portNo>] [--dmaap-port <portNo>]
  33
  34 ## License
  35
  36 Copyright (C) 2021 Nordix Foundation.
  37 Licensed under the Apache License, Version 2.0 (the "License")
  38 you may not use this file except in compliance with the License.
  39 You may obtain a copy of the License at
  40
  41       http://www.apache.org/licenses/LICENSE-2.0
  42
  43 Unless required by applicable law or agreed to in writing, software
  44 distributed under the License is distributed on an "AS IS" BASIS,
  45 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  46 See the License for the specific language governing permissions and
  47 limitations under the License.
  48
  49 For more information about license please see the [LICENSE](LICENSE.txt) file for details.