diff options
| author |   Michal Banka <michal.banka@nokia.com> | 2021-04-14 09:29:35 +0200 |
|---|---|---|
| committer | Michal Banka <michal.banka@nokia.com> | 2021-04-14 09:29:42 +0200 |
| commit | 0e967e28aa53a4288006d3b27f2a8feee1e04d64 (patch) | |
| tree | dcfb77a8b6f997a46ed13e15fa06025eb33230b4 /docs/sections/services/ves-hv/design.rst | |
| parent | 2a70db2bc63a64b30640f2e278b8c53fe150b3a7 (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/services/ves-hv/design.rst')
| -rw-r--r-- | docs/sections/services/ves-hv/design.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/sections/services/ves-hv/design.rst b/docs/sections/services/ves-hv/design.rst index 579b4acf..899b0c05 100644 --- a/docs/sections/services/ves-hv/design.rst +++ b/docs/sections/services/ves-hv/design.rst @@ -15,8 +15,8 @@ HV-VES follows the VES-JSON schema as much as possible. - HV-VES uses a Google Protocol Buffers (GPB, proto files) representation of the VES Common Header. - The proto files use most encoding-effective types defined by GPB to cover Common Header fields. -- HV-VES makes routing decisions based mostly on the content of the **Domain** parameter. -- HV-VES allows to embed Payload of different types (by default perf3gpp domain is included). +- HV-VES makes routing decisions based on the content of the **domain** field or **stndDefinedNamespace** field in case of stndDefined events. +- HV-VES allows to embed Payload of different types (by default perf3gpp and stndDefined domains are included). Analytics applications impacts @@ -36,6 +36,11 @@ This domain-specific proto has to be shared with analytics applications - HV-VES In order to support the RT-PM use-case, HV-VES uses a **perf3gpp** domain proto file. Within this domain, high volume data are expected to be reported to HV-VES collector. Additional domains can be defined based on existing VES domains (like Fault, Heartbeat) or completely new domains. New domains can be added when needed. +There is also **stndDefined** domain supported by default in HV-VES. Events with this domain are expected to contain +data payload described by OpenAPI schemas. HV-VES doesn't decode payload of stndDefined events thus it does not contain +specific **stndDefined** proto files. The only difference of **stndDefined** domain is its specific routing. More +details of stndDefined routing: :ref:`_stndDefined_domain`. + GPB proto files are backwards compatible, and a new domain can be added without affecting existing systems. Analytics applications have to be equipped with the new domain-specific proto file as well. |