X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fsections%2Fapis%2Fves-hv%2Findex.rst;fp=docs%2Fsections%2Fapis%2Fves-hv%2Findex.rst;h=b1871b180845842f16dc2562e0a0857aab853f3b;hb=663df2c1b8d9176094a62b00b7e80de096180621;hp=88a240e6c2ccefa636a6793d52db0800f301d619;hpb=bcd436a1be4fbe2c8ad7ce074d86b94b8ff44f4e;p=dcaegen2.git diff --git a/docs/sections/apis/ves-hv/index.rst b/docs/sections/apis/ves-hv/index.rst index 88a240e6..b1871b18 100644 --- a/docs/sections/apis/ves-hv/index.rst +++ b/docs/sections/apis/ves-hv/index.rst @@ -9,6 +9,11 @@ HV-VES (High Volume VES) .. contents:: :depth: 4 +.. toctree:: + :maxdepth: 1 + + ./supported-domains.rst + .. Overview @@ -16,7 +21,8 @@ Overview Component description can be found under `HV-VES Collector`_. -.. _HV-VES Collector: ../../services/ves-hv/index.html +.. _HV-VES Collector: ../../services/ves-hv/index.rst +.. _Domains supported by HV-VES: ./supported-domains.rst .. _tcp_endpoint: @@ -26,15 +32,15 @@ TCP Endpoint HV-VES is exposed as NodePort service on Kubernetes cluster on port 30222/tcp. By default, as of the Frankfurt release, all TCP communications are secured using SSL/TLS. Plain, insecure TCP connections without socket data encryption can be enabled if needed. - (see ref:`ssl_tls_authorization`). - -Without TLS, client authentication/authorization is not possible. +(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. Communication is wrapped with thin Wire Transfer Protocol, which mainly provides delimitation. .. literalinclude:: WTP.asn - :language: asn + :language: text Payload is binary-encoded, using Google Protocol Buffers (GPB) representation of the VES Event. @@ -96,4 +102,3 @@ Messages handling: .. 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. - Skipped messages (for any of the above reasons) might not leave any trace in HV-VES logs. -