docs/sections/apis/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 HV-VES (High Volume VES)
   6 ========================
   7
   8 :Date: 2018-10-05
   9
  10 .. contents::
  11     :depth: 4
  12
  13 ..
  14
  15 Overview
  16 ========
  17
  18 Component description can be found under `HV-VES Collector`_.
  19
  20 .. _HV-VES Collector: ../../services/ves-hv/index.html
  21
  22 .. _tcp_endpoint:
  23
  24 TCP Endpoint
  25 ============
  26
  27 HV-VES is exposed as NodePort service on Kubernetes cluster on port 30222/tcp.
  28 It uses plain, insecure TCP connection without socket data encryption. In Dublin release,
  29 there is an experimental option to enable SSL/TLS (see :ref:`ssl_tls_authorization`).
  30 Without TLS client authentication/authorization is not possible.
  31 Connections are stream-based (as opposed to request-based) and long-running.
  32
  33 Communication is wrapped with thin Wire Transfer Protocol, which mainly provides delimitation.
  34
  35 .. literalinclude:: WTP.asn
  36     :language: asn
  37
  38 Payload is binary-encoded, using Google Protocol Buffers (GPB) representation of the VES Event.
  39
  40 .. literalinclude:: VesEvent.proto
  41     :language: protobuf
  42
  43 HV-VES makes routing decisions based mostly on the content of the **Domain** parameter in the VES Common Event Header.
  44
  45 The PROTO file, which contains the VES CommonEventHeader, comes with a binary-type Payload (eventFields) parameter, where domain-specific
  46 data should be placed. Domain-specific data are encoded as well with GPB. A domain-specific PROTO file is required to decode the data.
  47
  48 API towards DMaaP
  49 =================
  50
  51 HV-VES Collector forwards incoming messages to a particular DMaaP Kafka topic based on the domain and configuration. Every Kafka record is comprised of a key and a value. In case of HV-VES:
  52
  53 - **Kafka record key** is a GPB-encoded `CommonEventHeader`.
  54 - **Kafka record value** is a GPB-encoded `VesEvent` (`CommonEventHeader` and domain-specific `eventFields`).
  55
  56 In both cases raw bytes might be extracted using ``org.apache.kafka.common.serialization.ByteArrayDeserializer``. The resulting bytes might be further passed to ``parseFrom`` methods included in classes generated from GPB definitions. WTP is not used here - it is only used in communication between PNF/VNF and the collector.
  57
  58 By default, **HV-VES** will use routing defined in **k8s-hv-ves.yaml-template** in **dcaegen2/platform/blueprints project**.
  59 Currently there is one domain->topic mapping defined: perf3gpp->HV_VES_PERF3GPP
  60
  61
  62 .. _supported_domains:
  63
  64 Supported domains
  65 =================
  66
  67 As for now **HV-VES** supports only **perf3gpp** domain
  68
  69 For domains descriptions, see :ref:`domains_supported_by_hvves`
  70
  71 .. _hv_ves_behaviors:
  72
  73 HV-VES behaviors
  74 ================
  75
  76 Connections with HV-VES are stream-based (as opposed to request-based) and long-running. In case of interrupted or closed connection, the collector logs such event but does not try to reconnect to client.
  77 Communication is wrapped with thin Wire Transfer Protocol, which mainly provides delimitation. Wire Transfer Protocol Frame:
  78
  79 - is dropped after decoding and validating and only GPB is used in further processing.
  80 - has to start with **MARKER_BYTE**, as defined in protocol specification (see :ref:`tcp_endpoint`). If **MARKER_BYTE** is invalid, HV-VES disconnects from client.
  81
  82 HV-VES decodes only CommonEventHeader from GPB message received. Collector does not decode or validate the rest of the GPB message and publishes it to Kafka topic intact.
  83 Kafka topic for publishing events with specific domain can be configured through Consul service as described in :ref:`run_time_configuration`.
  84 In case of Kafka service unavailability, the collector drops currently handled messages and disconnects the client.
  85
  86 Messages handling:
  87
  88 - HV-VES Collector skips messages with unknown/invalid GPB CommonEventHeader format.
  89 - HV-VES Collector skips messages with unsupported domain. Domain is unsupported if there is no route for it in configuration (see :ref:`run_time_configuration`).
  90 - HV-VES Collector skips messages with invalid Wire Frame format, unsupported WTP version or inconsistencies of data in the frame (other than invalid **MARKER_BYTE**).
  91 - HV-VES Collector interrupts connection when it encounters a message with too big GPB payload. Default maximum size and ways to change it are described in :ref:`deployment`.
  92
  93 .. note:: xNF (VNF/PNF) can split  messages bigger than 1 MiB and set `sequence` field in CommonEventHeader accordingly. It is advised to use smaller than 1 MiB messages for GPBs encoding/decoding efficiency.
  94
  95 - Skipped messages (for any of the above reasons) might not leave any trace in HV-VES logs.
  96