diff options
Diffstat (limited to 'docs/sections/apis/ves-hv.rst')
| -rw-r--r-- | docs/sections/apis/ves-hv.rst | 38 |
1 files changed, 37 insertions, 1 deletions
diff --git a/docs/sections/apis/ves-hv.rst b/docs/sections/apis/ves-hv.rst index d2071077..2045b6ba 100644 --- a/docs/sections/apis/ves-hv.rst +++ b/docs/sections/apis/ves-hv.rst @@ -14,5 +14,41 @@ HV-VES (High Volume VES) Overview ======== -TODO +Component description can be found under `HV-VES Collector`_. + +.. _HV-VES Collector: ../services/ves-hv/index.html + + +TCP Endpoint +============ + +HV-VES is exposed as NodePort service on Kubernetes cluster on port 30222/tcp. +It uses plain TCP connections tunneled in SSL/TLS or can be run in insecure manner without data encryption on the socket. +Without TLS client authentication/authorization is not possible. +Connections are stream-based (as opposed to request-based) and long running. + +Payload is binary-encoded, currently using Google Protocol Buffers representation of the VES Common Header. + +.. literalinclude:: VesEvent.proto + :language: protobuf + +The PROTO file, which contains the VES CommonHeader, comes with a binary-type Payload parameter, where domain-specific +data shall be placed. Domain-specific data are encoded as well with GPB, and they do require a domain-specific +PROTO file to decode the data. + +HV-VES makes routing decisions based mostly on the content of the **Domain** parameter in VES Common Header. + + +Healthcheck +=========== + +Inside HV-VES docker container runs small http service for healthcheck - exact port for this service can be configured +at deployment using `--health-check-api-port` command line option. + +This service exposes single endpoint **GET /health/ready** which returns **HTTP 200 OK** in case HV-VES is healthy +and ready for connections. Otherwise it returns **HTTP 503 Service Unavailable** with short reason of unhealthiness. + + + + |