From e284409662fd311bd78fa88b92a5ca8945481ac1 Mon Sep 17 00:00:00 2001 From: kjaniak Date: Wed, 14 Nov 2018 15:42:03 +0100 Subject: Restore proto schemas in docs Change-Id: I1f95122cf8ddd510873bf0d7d3e77231c91a400d Issue-ID: DCAEGEN2-972 Signed-off-by: kjaniak --- docs/sections/apis/ves-hv/MeasDataCollection.proto | 8 +++--- docs/sections/apis/ves-hv/VesEvent.proto | 3 +-- docs/sections/apis/ves-hv/index.rst | 2 +- docs/sections/apis/ves-hv/supported-domains.rst | 8 ++++++ docs/sections/services/ves-hv/authorization.rst | 2 +- docs/sections/services/ves-hv/configuration.rst | 31 ---------------------- docs/sections/services/ves-hv/delivery.rst | 9 ------- docs/sections/services/ves-hv/index.rst | 20 +++++++------- docs/sections/services/ves-hv/installation.rst | 27 ------------------- docs/sections/services/ves-hv/troubleshooting.rst | 2 +- 10 files changed, 25 insertions(+), 87 deletions(-) delete mode 100644 docs/sections/services/ves-hv/configuration.rst delete mode 100644 docs/sections/services/ves-hv/delivery.rst delete mode 100644 docs/sections/services/ves-hv/installation.rst diff --git a/docs/sections/apis/ves-hv/MeasDataCollection.proto b/docs/sections/apis/ves-hv/MeasDataCollection.proto index 978cb28a..cd2adabb 100644 --- a/docs/sections/apis/ves-hv/MeasDataCollection.proto +++ b/docs/sections/apis/ves-hv/MeasDataCollection.proto @@ -41,16 +41,16 @@ message MeasInfo { 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 @@ -59,7 +59,7 @@ message MeasInfo 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; diff --git a/docs/sections/apis/ves-hv/VesEvent.proto b/docs/sections/apis/ves-hv/VesEvent.proto index dbe0aa3f..2db6b64e 100644 --- a/docs/sections/apis/ves-hv/VesEvent.proto +++ b/docs/sections/apis/ves-hv/VesEvent.proto @@ -32,7 +32,6 @@ message VesEvent // top-level message, currently the } // VES CommonEventHeader adapted to GPB (Google Protocol Buffers) -// Aligned with VES 7.0.1 schema, and extending to Performance Domain. message CommonEventHeader { @@ -69,7 +68,7 @@ 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; diff --git a/docs/sections/apis/ves-hv/index.rst b/docs/sections/apis/ves-hv/index.rst index b477ba14..d87d1aa0 100644 --- a/docs/sections/apis/ves-hv/index.rst +++ b/docs/sections/apis/ves-hv/index.rst @@ -25,7 +25,7 @@ TCP Endpoint ============ 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. diff --git a/docs/sections/apis/ves-hv/supported-domains.rst b/docs/sections/apis/ves-hv/supported-domains.rst index 980b9f22..d1badaa6 100644 --- a/docs/sections/apis/ves-hv/supported-domains.rst +++ b/docs/sections/apis/ves-hv/supported-domains.rst @@ -33,6 +33,14 @@ The **perf3gpp** domain is based on 3GPP specifications: 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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/sections/services/ves-hv/authorization.rst b/docs/sections/services/ves-hv/authorization.rst index 27efdf49..054f7b33 100644 --- a/docs/sections/services/ves-hv/authorization.rst +++ b/docs/sections/services/ves-hv/authorization.rst @@ -1,6 +1,6 @@ **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 ===================== diff --git a/docs/sections/services/ves-hv/configuration.rst b/docs/sections/services/ves-hv/configuration.rst deleted file mode 100644 index f2b726f4..00000000 --- a/docs/sections/services/ves-hv/configuration.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. 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 diff --git a/docs/sections/services/ves-hv/delivery.rst b/docs/sections/services/ves-hv/delivery.rst deleted file mode 100644 index 74db3c05..00000000 --- a/docs/sections/services/ves-hv/delivery.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. 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 diff --git a/docs/sections/services/ves-hv/index.rst b/docs/sections/services/ves-hv/index.rst index 8dec5693..5cfaed3f 100644 --- a/docs/sections/services/ves-hv/index.rst +++ b/docs/sections/services/ves-hv/index.rst @@ -27,14 +27,12 @@ High Volume VES Collector overview and functions .. 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 diff --git a/docs/sections/services/ves-hv/installation.rst b/docs/sections/services/ves-hv/installation.rst deleted file mode 100644 index 7dafeaed..00000000 --- a/docs/sections/services/ves-hv/installation.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. 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 diff --git a/docs/sections/services/ves-hv/troubleshooting.rst b/docs/sections/services/ves-hv/troubleshooting.rst index 49037738..722e64c3 100644 --- a/docs/sections/services/ves-hv/troubleshooting.rst +++ b/docs/sections/services/ves-hv/troubleshooting.rst @@ -388,7 +388,7 @@ Authorization related errors ---------------------------- **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** -- cgit 1.2.3-korg