blob: ccd8730edacbf40f5365dc9b103c8117a6fb9393 [file] [log] [blame]
Piotr Jaszczyk19736a92018-09-24 11:27:58 +02001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4
5High Volume VNF Event Streaming (HV-VES) Collector
6==================================================
7
8.. Add or remove sections below as appropriate for the platform component.
9
Piotr Jaszczyk19736a92018-09-24 11:27:58 +020010
Filip Krzywka4bb79b72018-09-25 10:57:17 +020011**HV-VES collector** has been proposed, based on a need to process high-volumes of data generated frequently by a large
12number of NFs. The driving use-case is described and published within presentation during Casablanca Release Developer Forum:
13`Google Protocol Buffers versus JSON - 5G RAN use-case - comparison`_.
14
15.. _`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
16
17The goal of the collector is to support high volume data. It uses plain TCP connections.
18Connections are stream-based (as opposed to request-based) and long running.
19Payload is binary-encoded (currently using Google Protocol Buffers).
efiacor9c1961e2022-12-12 12:07:42 +000020HV-VES uses direct connection to Kafka.
Filip Krzywka4bb79b72018-09-25 10:57:17 +020021All these decisions were made in order to support high-volume data with minimal latency.
22
23
24High Volume VES Collector overview and functions
25------------------------------------------------
26
27.. toctree::
28 :maxdepth: 1
VENKATESH KUMARe21c8482020-11-12 15:00:02 -050029
kjaniake2844092018-11-14 15:42:03 +010030 architecture
31 design
kjaniake2844092018-11-14 15:42:03 +010032 repositories
33 deployment
Tomasz Wrobel4c94b382021-10-18 14:16:14 +020034 installation-helm
Filip Krzywka12acf3e2019-03-19 15:53:15 +010035 run-time-configuration
kjaniake2844092018-11-14 15:42:03 +010036 HV-VES Offered APIs <../../apis/ves-hv/index>
37 authorization
38 example-event
kjaniak8b1223d2018-12-19 22:41:40 +010039 healthcheck-and-monitoring
Filip Krzywka12acf3e2019-03-19 15:53:15 +010040 troubleshooting