Add docs build support

[ric-plt/vespamgr.git] / docs / overview.rst

diff --git a/docs/overview.rst b/docs/overview.rst
new file mode 100644 (file)
index 0000000..aaa7d48
--- /dev/null
+++ b/docs/overview.rst
@@ -0,0 +1,38 @@
+..\r
+.. Copyright (c) 2019 AT&T Intellectual Property.\r
+..\r
+.. Copyright (c) 2019 Nokia.\r
+..\r
+..\r
+.. Licensed under the Creative Commons Attribution 4.0 International\r
+..\r
+.. Public License (the "License"); you may not use this file except\r
+..\r
+.. in compliance with the License. You may obtain a copy of the License at\r
+..\r
+..\r
+..     https://creativecommons.org/licenses/by/4.0/\r
+..\r
+..\r
+.. Unless required by applicable law or agreed to in writing, documentation\r
+..\r
+.. distributed under the License is distributed on an "AS IS" BASIS,\r
+..\r
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+..\r
+.. See the License for the specific language governing permissions and\r
+..\r
+.. limitations under the License.\r
+..\r
+\r
+\r
+vespamgr Overview\r
+=================\r
+\r
+The VESPA manager uses the VES Agent (https://github.com/nokia/ONAP-VESPA)\r
+to adapt near-RT RIC internal statistics' collection using Prometheus\r
+(xApps and platform containers) to ONAP's VES (VNF event streaming).\r
+\r
+The vesmgr container runs two processes: the VESPA manager and the VES Agent (i.s. VESPA).\r
+The VESPA manager starts and configures the VES Agent.\r
+The VES Agent is a service acting as a bridge between Prometheus and ONAP's VES Collector.
\ No newline at end of file