summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/ves-hv/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/sections/services/ves-hv/index.rst')
-rw-r--r--docs/sections/services/ves-hv/index.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/sections/services/ves-hv/index.rst b/docs/sections/services/ves-hv/index.rst
index 0662660e..483ddbd7 100644
--- a/docs/sections/services/ves-hv/index.rst
+++ b/docs/sections/services/ves-hv/index.rst
@@ -7,5 +7,29 @@ High Volume VNF Event Streaming (HV-VES) Collector
.. Add or remove sections below as appropriate for the platform component.
+
+**HV-VES collector** has been proposed, based on a need to process high-volumes of data generated frequently by a large
+number of NFs. The driving use-case is described and published within presentation during Casablanca Release Developer Forum:
+`Google Protocol Buffers versus JSON - 5G RAN use-case - comparison`_.
+
+.. _`Google Protocol Buffers versus JSON - 5G RAN use-case - comparison`: https://wiki.onap.org/download/attachments/25434845/Casablanca_Dev_Forum_GPB_comparison_20180621.pptx?version=1&modificationDate=1530275050000&api=v2
+
+The goal of the collector is to support high volume data. It uses plain TCP connections.
+Connections are stream-based (as opposed to request-based) and long running.
+Payload is binary-encoded (currently using Google Protocol Buffers).
+HV-VES uses direct connection to DMaaP's Kafka.
+All these decisions were made in order to support high-volume data with minimal latency.
+
+
High Volume VES Collector overview and functions
+------------------------------------------------
+
+.. toctree::
+ :maxdepth: 1
+ ./design.rst
+ ./configuration.rst
+ ./delivery.rst
+ ./installation.rst
+ `Offered APIs`_
+.. _`Offered APIs`: ../../apis/ves-hv.rst \ No newline at end of file