summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis
diff options
context:
space:
mode:
authorJakub Dudycz <jakub.dudycz@nokia.com>2019-05-09 13:17:34 +0200
committerJakub Dudycz <jakub.dudycz@nokia.com>2019-05-10 13:54:43 +0200
commit0c99792d581e9bd829b0ce61698dd20cd310f544 (patch)
treed102ab63978aa67fd436619e7ee485dc10caedd5 /docs/sections/apis
parent776b61f244ed17723672b99b3610eefd6d8fb3c0 (diff)
Enhance HV-VES documentation
Change-Id: Iba32c9a19ea3d11c4e541f90ee1afa57176fe7f7 Signed-off-by: Jakub Dudycz <jakub.dudycz@nokia.com> Issue-ID: DCAEGEN2-1493
Diffstat (limited to 'docs/sections/apis')
-rw-r--r--docs/sections/apis/ves-hv/index.rst12
1 files changed, 5 insertions, 7 deletions
diff --git a/docs/sections/apis/ves-hv/index.rst b/docs/sections/apis/ves-hv/index.rst
index c61c1e16..df91681c 100644
--- a/docs/sections/apis/ves-hv/index.rst
+++ b/docs/sections/apis/ves-hv/index.rst
@@ -25,7 +25,8 @@ TCP Endpoint
============
HV-VES is exposed as NodePort service on Kubernetes cluster on port 30222/tcp.
-It uses plain, insecure TCP connection without socket data encryption. In Casablanca release, there is an experimental option to enable SSL/TLS (see :ref:`ssl_tls_authorization`).
+It uses plain, insecure TCP connection without socket data encryption. In Dublin release,
+there is an experimental option to enable SSL/TLS (see :ref:`ssl_tls_authorization`).
Without TLS client authentication/authorization is not possible.
Connections are stream-based (as opposed to request-based) and long-running.
@@ -54,9 +55,8 @@ HV-VES Collector forwards incoming messages to a particular DMaaP Kafka topic ba
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 defined domain->topic mapping looks as follows:
-
-- perf3gpp -> HV_VES_PERF3GPP
+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
.. _supported_domains:
@@ -64,9 +64,7 @@ By default, **HV-VES** will use routing defined in **k8s-hv-ves.yaml-template**
Supported domains
=================
-Domains supported by **HV-VES**:
-
-- perf3gpp
+As for now **HV-VES** supports only **perf3gpp** domain
For domains descriptions, see :ref:`domains_supported_by_hvves`