clean up some sphinx warnings
[dcaegen2.git] / docs / sections / services / ves-hv / index.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4
5 High Volume VNF Event Streaming (HV-VES) Collector
6 ==================================================
7
8 .. Add or remove sections below as appropriate for the platform component.
9
10
11 **HV-VES collector** has been proposed, based on a need to process high-volumes of data generated frequently by a large
12 number 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
17 The goal of the collector is to support high volume data. It uses plain TCP connections.
18 Connections are stream-based (as opposed to request-based) and long running.
19 Payload is binary-encoded (currently using Google Protocol Buffers).
20 HV-VES uses direct connection to Kafka.
21 All these decisions were made in order to support high-volume data with minimal latency.
22
23
24 High Volume VES Collector overview and functions
25 ------------------------------------------------
26
27 .. toctree::
28     :maxdepth: 1
29
30     architecture
31     design
32     repositories
33     deployment
34     installation-helm
35     run-time-configuration
36     HV-VES Offered APIs <../../apis/ves-hv/index>
37     authorization
38     example-event
39     healthcheck-and-monitoring
40     troubleshooting