README.md

   1 # RIC VESPA manager
   2
   3 The VESPA manager uses the VES Agent (https://github.com/nokia/ONAP-VESPA)
   4 to adapt near-RT RIC internal statistics' collection using Prometheus
   5 (xApps and platform containers) to ONAP's VES (VNF event streaming).
   6
   7 The VESPA manager starts and configures the VES Agent.
   8
   9 # Environment variables
  10
  11 The VESPA manager container requires the following environment variables:
  12
  13 * VESMGR_HB_INTERVAL - VES heartbeat interval. For example: 30s.
  14 * VESMGR_MEAS_INTERVAL - Measurement interval. For example: 60s.
  15 * VESMGR_PRICOLLECTOR_ADDR - Primary collector IP address. For example: 127.0.0.1.
  16 * VESMGR_PRICOLLECTOR_PORT - Primary collector port id as an integer. For example: 1234.
  17 * VESMGR_PROMETHEUS_ADDR - Prometheus address. For example: http://127.0.0.1:123
  18
  19 # Unit Tests
  20
  21 In order to run the VESPA manager unit tests, give the following command:
  22
  23 ```
  24 go test ./... -v
  25 ```
  26
  27 # License
  28
  29 See [LICENSES.txt](LICENSES.txt) file.