summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis/ves-hv/index.rst
diff options
context:
space:
mode:
authorHansen, Tony (th1395) <th1395@att.com>2023-05-23 21:27:17 +0000
committerHansen, Tony (th1395) <th1395@att.com>2023-05-31 21:01:29 +0000
commit663df2c1b8d9176094a62b00b7e80de096180621 (patch)
tree849841dc428fcfba07d9c39494f95ccd1f25da8a /docs/sections/apis/ves-hv/index.rst
parentbcd436a1be4fbe2c8ad7ce074d86b94b8ff44f4e (diff)
clean up some sphinx warnings
Change-Id: I8c2d925e8b27b4740227af0be3ab5d6f7153ec38 Signed-off-by: Hansen, Tony (th1395) <th1395@att.com> Issue-ID: DCAEGEN2-3399 Signed-off-by: Hansen, Tony (th1395) <th1395@att.com> Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com> Signed-off-by: Hansen, Tony (th1395) <th1395@att.com>
Diffstat (limited to 'docs/sections/apis/ves-hv/index.rst')
-rw-r--r--docs/sections/apis/ves-hv/index.rst17
1 files changed, 11 insertions, 6 deletions
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.
-