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 as a string. For example: 30s.
  14 * VESMGR_MEAS_INTERVAL - Measurement interval as a string. For example: 60s.
  15 * VESMGR_PROMETHEUS_ADDR - Prometheus address. For example: http://127.0.0.1:123
  16
  17 * VESMGR_PRICOLLECTOR_ADDR - Primary collector FQDN as a string. For example: ricaux-entry.
  18 * VESMGR_PRICOLLECTOR_PORT - Primary collector port id as an integer. Default: 8443.
  19 * VESMGR_PRICOLLECTOR_SERVERROOT - Path before the /eventListener part of the POST URL as a string.
  20 * VESMGR_PRICOLLECTOR_TOPIC - Primary collector topic as a string.
  21 * VESMGR_PRICOLLECTOR_SECURE - Use HTTPS for VES collector. Possible string values: true or false.
  22 * VESMGR_PRICOLLECTOR_USER - User name as a string.
  23 * VESMGR_PRICOLLECTOR_PASSWORD - Password as a string.
  24 * VESMGR_PRICOLLECTOR_PASSPHASE - Passphrase as a string.
  25
  26 # Unit Tests
  27
  28 In order to run the VESPA manager unit tests, give the following command:
  29
  30 ```
  31 go test ./... -v
  32 ```
  33
  34 # License
  35
  36 See [LICENSES.txt](LICENSES.txt) file.