test/usecases/odusliceassurance/goversion/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_ADDRESS         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
  16 ## Development
  17
  18 To make it easy to test during development of the consumer, two stubs are provided in the `stub` folder.
  19
  20 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:
  21 >1. cd stub/producer
  22 >2. go build
  23 >3. ./mrstub
  24
  25 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:
  26 >1. cd stub/sdnr
  27 >2. go build
  28 >3. ./sdnr
  29
  30
  31 ## License
  32
  33 Copyright (C) 2021 Nordix Foundation.
  34 Licensed under the Apache License, Version 2.0 (the "License")
  35 you may not use this file except in compliance with the License.
  36 You may obtain a copy of the License at
  37
  38       http://www.apache.org/licenses/LICENSE-2.0
  39
  40 Unless required by applicable law or agreed to in writing, software
  41 distributed under the License is distributed on an "AS IS" BASIS,
  42 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  43 See the License for the specific language governing permissions and
  44 limitations under the License.
  45
  46 For more information about license please see the [LICENSE](LICENSE.txt) file for details.