{
oneof MeasInfoId { // measurement group identifier
uint32 iMeasInfoId = 1; // identifier as integer (%%: more compact)
- string measInfoId = 2; // identifier as string (more generic)
+ string sMeasInfoId = 2; // identifier as string (more generic)
}
oneof MeasTypes { // measurement identifiers associated with the measurement results
IMeasTypes iMeasTypes = 3; // identifiers as integers (%%: more compact)
- SMeasTypes measTypes = 4; // identifiers as strings (more generic)
+ SMeasTypes sMeasTypes = 4; // identifiers as strings (more generic)
}
// Needed only because GPB does not support repeated fields directly inside 'oneof'
message IMeasTypes { repeated uint32 iMeasType = 1; }
- message SMeasTypes { repeated string measType = 1; }
+ message SMeasTypes { repeated string sMeasType = 1; }
string jobId = 5;
repeated MeasValue measValues = 6; // performance measurements grouped by measurement object
message MeasValue
{
oneof MeasObjInstId { // monitored object LDN as per 3GPP TS 32.300 and 3GPP TS 32.432
- string measObjInstId = 1; // LDN itself
+ string sMeasObjInstId = 1; // LDN itself
uint32 measObjInstIdListIdx = 2; // %%: index into measObjInstIdList (zero-based)
}
repeated MeasResult measResults = 3;
}
// VES CommonEventHeader adapted to GPB (Google Protocol Buffers)
-// Aligned with VES 7.0.1 schema, and extending to Performance Domain.
message CommonEventHeader
{
bytes sourceId = 15; // "UUID identifying the entity experiencing the event issue; must be populated by the ATT enrichment process"
string sourceName = 16; // required, "name of the entity experiencing the event issued use A&AI entry"
string timeZoneOffset = 17; // "Offset to GMT to indicate local time zone for the device"
- string vesEventListenerVersion = 18; // required, "Version of the VesEvent Listener", current value "7.0.2"
+ string vesEventListenerVersion = 18; // required, "Version of the VesEvent Listener", current value "7.2"
reserved "InternalHeaderFields"; // "enrichment fields for internal VES Event Listener service use only, not supplied by event sources"
reserved 100;
============
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:`authorization`).
+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`).
Without TLS client authentication/authorization is not possible.
Connections are stream-based (as opposed to request-based) and long-running.
The event structure is changed in comparison to the one presented in 3GPP technical specifications. The 3GPP structure is enhanced to provide support for efficient transport.
+Definitions for the **perf3gpp** domain are stored in Perf3gppFields.proto and MeasDataCollection.proto, listed below:
+
+.. literalinclude:: Perf3gppFields.proto
+ :language: protobuf
+
+.. literalinclude:: MeasDataCollection.proto
+ :language: protobuf
+
Selecting Complimentary fields for population of **perf3gpp** event
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**WARNING: SSL/TLS authorization is a part of an experimental feature for ONAP Casablanca release and thus should be treated as unstable and subject to change in future releases.**
-.. _authorization:
+.. _ssl_tls_authorization:
SSL/TLS authorization
=====================
+++ /dev/null
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Configuration
-=============
-
-HV-VES expects to be able to fetch configuration directly from consul service in following JSON format:
-
-.. code-block:: json
-
- {
- "dmaap.kafkaBootstrapServers": "kafka-host:9093",
- "collector.routing": [
- {
- "fromDomain": "PERF3GPP",
- "toTopic": "topic-1"
- },
- {
- "fromDomain": "HEARTBEAT",
- "toTopic": "topic-2"
- },
- ...
- ]
- }
-
-
-During ONAP OOM/Kubernetes deployment this configuration is created from HV-VES cloudify blueprint.
-
-Endpoint on which HV-VES seeks configuration can be configured during deployment as described in installation_.
-
-.. _installation: ./installation.html
\ No newline at end of file
+++ /dev/null
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Delivery
-========
-
-**HV-VES** is delivered as a docker container and published in ONAP Nexus repository following image naming convention.
-
-Full image name is `onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main`.
\ No newline at end of file
.. toctree::
:maxdepth: 1
- ./architecture
- ./design
- ./run-time-configuration
- ./repositories
- ./deployment
- ./troubleshooting
- `Offered APIs`_
- ./authorization
- ./example-event
-
-.. _`Offered APIs`: ../../apis/ves-hv
+ architecture
+ design
+ run-time-configuration
+ repositories
+ deployment
+ troubleshooting
+ HV-VES Offered APIs <../../apis/ves-hv/index>
+ authorization
+ example-event
+++ /dev/null
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Installation
-============
-
-To run HV-VES Collector container you need to specify required parameters:
-
-- listen-port - the port on which HV-VES will listen internally
-- config-url - URL of HV-VES configuration on consul
-
-There are also optional configuration parameters:
-
-- health-check-api-port - Health check rest api listen port
-- first-request-delay - Delay of first request to consul in seconds
-- request-interval - Interval of consul configuration requests in seconds
-- ssl-disable - Disable SSL encryption
-- key-store - Key store in PKCS12 format path
-- key-store-password - Key store password
-- trust-store - File with trusted certificate bundle in PKCS12 format path
-- trust-store-password - Trust store password
-- idle-timeout-sec - Idle timeout for remote hosts. After given time without any data exchange the connection might be closed
-
-
-These parameters can be configured either by passing command line option during `docker run` call or
-by specifying environment variables named after command line option name
-rewritten using `UPPER_SNAKE_CASE` and prepended with `VESHV_` prefix e.g. `VESHV_LISTEN_PORT`.
\ No newline at end of file
----------------------------
**WARNING: SSL/TLS authorization is a part of an experimental feature for ONAP Casablanca release and should be treated as unstable and subject to change in future releases.**
-**For more information, see** :ref:`authorization`.
+**For more information, see** :ref:`ssl_tls_authorization`.
**Key or trust store missing**
Code Review / dcaegen2.git / commitdiff