summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis
diff options
context:
space:
mode:
authorMichal Banka <michal.banka@nokia.com>2021-04-14 09:29:35 +0200
committerMichal Banka <michal.banka@nokia.com>2021-04-14 09:29:42 +0200
commit0e967e28aa53a4288006d3b27f2a8feee1e04d64 (patch)
treedcfb77a8b6f997a46ed13e15fa06025eb33230b4 /docs/sections/apis
parent2a70db2bc63a64b30640f2e278b8c53fe150b3a7 (diff)
Add stndDefined domain docs
Change-Id: If61d0b649907c18e2c82ab5a6fa8617edee11e7d Signed-off-by: Michal Banka <michal.banka@nokia.com> Issue-ID: DCAEGEN2-2702
Diffstat (limited to 'docs/sections/apis')
-rw-r--r--docs/sections/apis/ves-hv/index.rst13
-rw-r--r--docs/sections/apis/ves-hv/supported-domains.rst30
2 files changed, 34 insertions, 9 deletions
diff --git a/docs/sections/apis/ves-hv/index.rst b/docs/sections/apis/ves-hv/index.rst
index c3ccfa0c..c82391d4 100644
--- a/docs/sections/apis/ves-hv/index.rst
+++ b/docs/sections/apis/ves-hv/index.rst
@@ -41,7 +41,7 @@ Payload is binary-encoded, using Google Protocol Buffers (GPB) representation of
.. literalinclude:: VesEvent.proto
:language: protobuf
-HV-VES makes routing decisions based mostly on the content of the **Domain** parameter in the VES Common Event Header.
+HV-VES makes routing decisions based on the content of the **domain** field or **stndDefinedNamespace** field in case of stndDefined events.
The PROTO file, which contains the VES CommonEventHeader, comes with a binary-type Payload (eventFields) parameter, where domain-specific
data should be placed. Domain-specific data are encoded as well with GPB. A domain-specific PROTO file is required to decode the data.
@@ -49,15 +49,15 @@ data should be placed. Domain-specific data are encoded as well with GPB. A doma
API towards DMaaP
=================
-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:
+HV-VES Collector forwards incoming messages to a particular DMaaP Kafka topic based on the domain (or stndDefinedNamespace) and configuration. Every Kafka record is comprised of a key and a value. In case of HV-VES:
- **Kafka record key** is a GPB-encoded `CommonEventHeader`.
- **Kafka record value** is a GPB-encoded `VesEvent` (`CommonEventHeader` and domain-specific `eventFields`).
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.
-By default, **HV-VES** will use routing defined in **k8s-hv-ves.yaml-template** in **dcaegen2/platform/blueprints project**.
-Currently there is one domain->topic mapping defined: perf3gpp->HV_VES_PERF3GPP
+By default, **HV-VES** will use routing defined in **k8s-hv-ves.yaml-template** in **dcaegen2/platform/blueprints project** when deployed using Cloudify.
+In case of Helm deployment routing is defined in values.yaml file in HV-VES Helm Chart.
.. _supported_domains:
@@ -65,7 +65,10 @@ Currently there is one domain->topic mapping defined: perf3gpp->HV_VES_PERF3GPP
Supported domains
=================
-As for now **HV-VES** supports only **perf3gpp** domain
+Domains that are currently supported by HV-VES:
+
+- perf3gpp - basic domain to Kafka topic mapping
+- stndDefined - specific routing, when event has this domain, then stndDefinedNamespace field value is mapped to Kafka topic
For domains descriptions, see :ref:`domains_supported_by_hvves`
diff --git a/docs/sections/apis/ves-hv/supported-domains.rst b/docs/sections/apis/ves-hv/supported-domains.rst
index 68d5d226..3e24f2a9 100644
--- a/docs/sections/apis/ves-hv/supported-domains.rst
+++ b/docs/sections/apis/ves-hv/supported-domains.rst
@@ -84,7 +84,29 @@ Each row of the table corresponds to one field where a choice is to be made. For
.. note:: *MeasResult.p* can be used to reduce the event size when more than half of the values in the event are zero values, and these values are not sent to ONAP. Only non-zero values are sent, together with their *MeasInfo.MeasTypes* index (*MeasResult.p*).
-
-
-
-
+.. _stndDefined_domain:
+
+stndDefined domain
+------------------
+
+The purpose of 'stndDefined' domain was to allow collection of events defined by standard organizations using HV-VES,
+and providing them for consumption by analytics applications running on top of DCAE platform.
+
+All events, except those with 'stndDefined' domain, are routed to DMaaP topics based on domain value. Events with
+'stndDefined' domain are sent to proper topic basing on field 'stndDefinedNamespace'.
+
+This is the only difference from standard event routing, specific for 'stndDefined' domain. As in every other event
+routing value is being mapped for specific Kafka topic. Mappings to Kafka topics are located in HV-VES Helm Chart
+values.yaml file. Four of them are by default available in HV-VES:
+
++-------------+--------------------------------+--------------------------------------+
+| Domain | StndDefinedNamespace | Kafka topic |
++=============+================================+======================================+
+| stndDefined | ves-3gpp-fault-supervision | SEC_3GPP_FAULTSUPERVISION_OUTPUT |
++-------------+--------------------------------+--------------------------------------+
+| stndDefined | ves-3gpp-provisioning | SEC_3GPP_PROVISIONING_OUTPUT |
++-------------+--------------------------------+--------------------------------------+
+| stndDefined | ves-3gpp-heartbeat | SEC_3GPP_HEARTBEAT_OUTPUT |
++-------------+--------------------------------+--------------------------------------+
+| stndDefined | ves-3gpp-performance-assurance | SEC_3GPP_PERFORMANCEASSURANCE_OUTPUT |
++-------------+--------------------------------+--------------------------------------+