diff options
Diffstat (limited to 'docs/sections/services/ves-hv')
8 files changed, 17 insertions, 16 deletions
diff --git a/docs/sections/services/ves-hv/design.rst b/docs/sections/services/ves-hv/design.rst index 899b0c05..6e3ba858 100644 --- a/docs/sections/services/ves-hv/design.rst +++ b/docs/sections/services/ves-hv/design.rst @@ -29,7 +29,7 @@ Extendability HV-VES is designed to allow extending by adding new domain-specific proto files. -The proto file (with the VES CommonHeader) comes with a binary-type **Payload** parameter, where domain-specific data should be placed. +The proto file (with the VES CommonHeader) comes with a binary-type **Payload** parameter, where domain-specific data should be placed. Domain-specific data are encoded as well with GPB. A domain-specific proto file is required to decode the data. This domain-specific proto has to be shared with analytics applications - HV-VES does not analyze domain-specific data. @@ -39,7 +39,7 @@ Additional domains can be defined based on existing VES domains (like Fault, Hea 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`. +details of stndDefined routing: :ref:`stndDefined_domain`. GPB proto files are backwards compatible, and a new domain can be added without affecting existing systems. @@ -53,5 +53,3 @@ Implementation details - Netty is used by means of reactor-netty library. - Kotlin is used to write concise code with great interoperability with existing Java libraries. - Types defined in Λrrow library are also used when it improves readability or general cleanness of the code. - - diff --git a/docs/sections/services/ves-hv/healthcheck-and-monitoring.rst b/docs/sections/services/ves-hv/healthcheck-and-monitoring.rst index 9d35e1ef..a2b77272 100644 --- a/docs/sections/services/ves-hv/healthcheck-and-monitoring.rst +++ b/docs/sections/services/ves-hv/healthcheck-and-monitoring.rst @@ -17,7 +17,7 @@ and ready for connections. Otherwise it returns a **HTTP 503 Service Unavailable Monitoring ---------- -HV-VES collector allows to collect metrics data at runtime. To serve this purpose HV-VES application exposes an endpoint **GET /monitoring/prometheus** +HV-VES collector allows to collect metrics data at runtime. To serve this purpose HV-VES application exposes an endpoint **GET /monitoring/prometheus** which returns a **HTTP 200 OK** message with a specific data in its body. Returned data is in a format readable by Prometheus service. Prometheus endpoint shares a port with healthchecks. diff --git a/docs/sections/services/ves-hv/index.rst b/docs/sections/services/ves-hv/index.rst index ccd8730e..c8f5f263 100644 --- a/docs/sections/services/ves-hv/index.rst +++ b/docs/sections/services/ves-hv/index.rst @@ -26,7 +26,7 @@ High Volume VES Collector overview and functions .. toctree:: :maxdepth: 1 - + architecture design repositories diff --git a/docs/sections/services/ves-hv/installation-helm.rst b/docs/sections/services/ves-hv/installation-helm.rst index b9bf6da9..87aca24b 100644 --- a/docs/sections/services/ves-hv/installation-helm.rst +++ b/docs/sections/services/ves-hv/installation-helm.rst @@ -4,7 +4,7 @@ HV-VES Helm Installation
========================
-Starting from ONAP/Honolulu release, HV-VES is installed with a DCAEGEN2-Services Helm charts.
+Starting from ONAP/Honolulu release, HV-VES is installed with a DCAEGEN2-Services Helm charts.
HV-VES application is configured by default to use TLS/SSL encryption on TCP connection.
Disable TLS security - Helm based deployment
@@ -22,7 +22,7 @@ For example: helm -n onap upgrade dev-dcaegen2-services --reuse-values --values new-config.yaml oom/kubernetes/dcaegen2-services
Where the contents of ``new-config.yaml`` file is:
- .. code-block:: bash
+ .. code-block:: yaml
dcae-hv-ves-collector:
applicationConfig:
@@ -35,17 +35,20 @@ For small changes like this, it is also possible to inline the new value: After the upgrade, the security.sslDisable property should be changed and visible inside dev-dcae-ves-collector-application-config-configmap Config-Map.
It can be verified by running:
+
.. code-block:: bash
kubectl -n onap get cm <config map name> -o yaml
For HV-VES Collector:
+
.. code-block:: bash
kubectl -n onap get cm dev-dcae-hv-ves-collector-application-config-configmap -o yaml
For apply new configuration by HV-VES Collector the application restart might be necessary. It could be done by HV-VES helm reinstallation:
+
.. code-block:: bash
helm -n onap upgrade dev-dcaegen2-services --reuse-values --set dcae-hv-ves-collector.enabled="false" oom/kubernetes/dcaegen2-services
@@ -57,10 +60,11 @@ Using external TLS certificates obtained using CMP v2 protocol In order to use the X.509 certificates obtained from the CMP v2 server (so called "operator`s certificates"), refer to the following description:
-:ref:`Enabling TLS with external x.509 certificates <external-tls-helm>`
+:ref:`Enabling TLS with external x.509 certificates <tls_enablement>`
Example values for HV-VES Collector:
- .. code-block:: bash
+
+ .. code-block:: yaml
global:
cmpv2Enabled: true
@@ -80,4 +84,3 @@ Example values for HV-VES Collector: name: hv-ves-cmpv2-keystore-password
key: password
create: true
-
diff --git a/docs/sections/services/ves-hv/resources/base-configuration.json b/docs/sections/services/ves-hv/resources/base-configuration.json index 6580287d..10cc39e6 100644 --- a/docs/sections/services/ves-hv/resources/base-configuration.json +++ b/docs/sections/services/ves-hv/resources/base-configuration.json @@ -9,4 +9,4 @@ "security.keys.keyStorePasswordFile": "/etc/ves-hv/ssl/server.pass", "security.keys.trustStoreFile": "/etc/ves-hv/ssl/trust.p12", "security.keys.trustStorePasswordFile": "/etc/ves-hv/ssl/trust.pass" -}
\ No newline at end of file +} diff --git a/docs/sections/services/ves-hv/resources/metrics_sample_response.txt b/docs/sections/services/ves-hv/resources/metrics_sample_response.txt index da54e3ea..813cdc15 100644 --- a/docs/sections/services/ves-hv/resources/metrics_sample_response.txt +++ b/docs/sections/services/ves-hv/resources/metrics_sample_response.txt @@ -64,4 +64,4 @@ hvves_connections_active 1.0 jvm_gc_live_data_size_bytes 7634496.0 hvves_messages_latency_seconds_max 1.5459828692292638E9 hvves_messages_latency_seconds_count 20000.0 -hvves_messages_latency_seconds_sum 2.91400110035487E9
\ No newline at end of file +hvves_messages_latency_seconds_sum 2.91400110035487E9 diff --git a/docs/sections/services/ves-hv/run-time-configuration.rst b/docs/sections/services/ves-hv/run-time-configuration.rst index 4da0b10d..09696d55 100644 --- a/docs/sections/services/ves-hv/run-time-configuration.rst +++ b/docs/sections/services/ves-hv/run-time-configuration.rst @@ -6,7 +6,7 @@ Run-Time configuration ====================== -HV-VES dynamic configuration is primarily meant to provide DMaaP Connection Objects (see :ref:`dmaap-connection-objects`). +HV-VES dynamic configuration is primarily meant to provide DMaaP Connection Objects. .. note:: Kafka config info. In the case of HV-VES, this configuration method is purely used as a generic reference. @@ -48,4 +48,4 @@ For more information, see :ref:`supported_domains`. Providing configuration during OOM deployment --------------------------------------------- -The configuration is created from HV-VES Helm charts defined under **applicationConfig** during ONAP OOM/Kubernetes deployment. +The configuration is created from HV-VES Helm charts defined under **applicationConfig** during ONAP OOM/Kubernetes deployment. diff --git a/docs/sections/services/ves-hv/troubleshooting.rst b/docs/sections/services/ves-hv/troubleshooting.rst index c7b6a291..750a878c 100644 --- a/docs/sections/services/ves-hv/troubleshooting.rst +++ b/docs/sections/services/ves-hv/troubleshooting.rst @@ -163,7 +163,7 @@ To resolve this issue, you can either wait for that Kafka service to be availabl The above log is printed when the message payload size is too big. -**HV-VES** does not handle messages that exceed maximum payload size specified under streams_publishes configuration (see :ref:`dmaap-connection-objects`) +**HV-VES** does not handle messages that exceed maximum payload size. ==== |