RIC:1060: Change in PTL

[ric-plt/vespamgr.git] / README.md

diff --git a/README.md b/README.md
index 06b2cca..b891212 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
-# RIC VESPA manager
+RIC VESPA manager
+=================
 
-The VESPA manager uses the VES Agent (https://github.com/nokia/ONAP-VESPA)
-to adapt near-RT RIC internal statistics' collection using Prometheus 
+The VESPA manager uses the VES Agent [https://github.com/nokia/ONAP-VESPA](https://github.com/nokia/ONAP-VESPA)
+to adapt near-RT RIC internal statistics' collection using Prometheus
 (xApps and platform containers) to ONAP's VES (VNF event streaming).
 
 The vesmgr container runs two processes: the VESPA manager and the VES
@@ -9,13 +10,13 @@ Agent (i.s. VESPA).
 
 The VESPA manager starts and configures the VES Agent.
 
-The VES Agent is a service acting as a bridge between Prometheus and 
+The VES Agent is a service acting as a bridge between Prometheus and
 ONAP's VES Collector.
 
 # Application metrics definition
 
 The application metrics are defined in the application descriptor.
-For each counter, the following fields are required in the "metrics" 
+For each counter, the following fields are required in the "metrics"
 section of the descriptor:
 
 * name - Prometheus name of the counter
@@ -23,7 +24,7 @@ section of the descriptor:
 * objectInstance - object instance in VE
 
 The VESPA manager receives the application metrics configuration from the
-application manager. It subscribes the app notification messages from the 
+application manager. It subscribes the app notification messages from the
 application manager, and after having received one, requests the latest
 application configuration, creates the VES Agent configuration based on it,
 and restarts the VES Agent.
@@ -37,8 +38,8 @@ The VES Agent reads the ricComponentName from Prometheus label
 
 # VES Collector event format
 
-The VES Agent transmits events to the VES Collector in the 
-VES Common Event Format v5.4.1. 
+The VES Agent transmits events to the VES Collector in the
+VES Common Event Format v5.4.1.
 The Common Event Format is expressed in JSON schema v28.4.1.
 
 VES Event Listener 5.4.1:
@@ -52,10 +53,11 @@ JSON schema v28.4.1:
 The VESPA manager container requires the following environment variables:
 
 * VESMGR_VNFNAME - VNF name as a string. Default: Vespa.
+* VESMGR_NFNAMINGCODE - NF naming code as a string. Default: ricp.
 * VESMGR_HB_INTERVAL - VES heartbeat interval as a string. For example: 30s.
 * VESMGR_MEAS_INTERVAL - Measurement interval as a string. For example: 60s.
 * VESMGR_PROMETHEUS_ADDR - Prometheus address. For example: http://127.0.0.1:123
-
+* VESMGR_ALERTMANAGER_BIND_ADDR - Bind address to receive alerts from Prometheus AlertManager
 
 * VESMGR_PRICOLLECTOR_ADDR - Primary collector FQDN as a string. For example: ricaux-entry.
 * VESMGR_PRICOLLECTOR_PORT - Primary collector port id as an integer. Default: 8443.
@@ -66,21 +68,29 @@ The VESPA manager container requires the following environment variables:
 * VESMGR_PRICOLLECTOR_PASSWORD - Password as a string.
 * VESMGR_PRICOLLECTOR_PASSPHASE - Passphrase as a string.
 
-
 * VESMGR_APPMGRDOMAIN - Application manager domain. This is for testing purposes, only. Default: service-ricplt-appmgr-http.ricplt.svc.cluster.local.
 
 # Liveness probe
 
 The VESPA manager replies to liveness HTTP GET at path /supervision.
 
+# Errors
+
+The VESPA manager exits in the following error cases:
+
+* The VES Agent exits
+* An unrecoverable system error during the initialization, for example
+  * Creation of the VES Agent configuration file fails
+  * Creation of a HTTP request message fails
+
 # Unit Tests
 
 In order to run the VESPA manager unit tests, give the following command:
 
-```
+```shell
 go test ./... -v
 ```
 
 # License
 
-See [LICENSES.txt](LICENSES.txt) file.
+See [LICENSES.txt](./LICENSES.txt) file.