summaryrefslogtreecommitdiffstats
path: root/docs/sections/services
diff options
context:
space:
mode:
Diffstat (limited to 'docs/sections/services')
-rw-r--r--docs/sections/services/bbs-event-processor/index.rst8
-rw-r--r--docs/sections/services/dfc/index.rst4
-rw-r--r--docs/sections/services/heartbeat-ms/index.rst4
-rw-r--r--docs/sections/services/mapper/index.rst9
-rw-r--r--docs/sections/services/restconf/index.rst6
-rw-r--r--docs/sections/services/sdk/architecture.rst68
-rw-r--r--docs/sections/services/sdk/index.rst19
-rw-r--r--docs/sections/services/serviceindex.rst7
-rw-r--r--docs/sections/services/snmptrap/index.rst4
-rw-r--r--docs/sections/services/ves-http/architecture.rst6
10 files changed, 24 insertions, 111 deletions
diff --git a/docs/sections/services/bbs-event-processor/index.rst b/docs/sections/services/bbs-event-processor/index.rst
index 6d54474d..bcaa700b 100644
--- a/docs/sections/services/bbs-event-processor/index.rst
+++ b/docs/sections/services/bbs-event-processor/index.rst
@@ -1,11 +1,11 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-=====================================
-BBS-EP (BBS use case event processor)
-=====================================
+==================
+BBS-EventProcessor
+==================
-:Date: 2019-04-11
+:Date: 2019-06-06
.. contents::
:depth: 3
diff --git a/docs/sections/services/dfc/index.rst b/docs/sections/services/dfc/index.rst
index cad36f56..0979bfe4 100644
--- a/docs/sections/services/dfc/index.rst
+++ b/docs/sections/services/dfc/index.rst
@@ -2,8 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
-DATAFILE COLLECTOR MS (DFC)
-=============================
+DataFile Collector(DFC)
+=======================
.. Add or remove sections below as appropriate for the platform component.
diff --git a/docs/sections/services/heartbeat-ms/index.rst b/docs/sections/services/heartbeat-ms/index.rst
index 148b8da8..d8a77fa5 100644
--- a/docs/sections/services/heartbeat-ms/index.rst
+++ b/docs/sections/services/heartbeat-ms/index.rst
@@ -1,8 +1,8 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-Heartbeat Microservice (version 2.1.0)
-======================================
+Heartbeat Microservice
+======================
The main objective of **Heartbeat Microservice** is to receive the periodic
heartbeat from the configured eventNames and report the loss of heartbeat
diff --git a/docs/sections/services/mapper/index.rst b/docs/sections/services/mapper/index.rst
index f88f4214..de534be2 100644
--- a/docs/sections/services/mapper/index.rst
+++ b/docs/sections/services/mapper/index.rst
@@ -3,11 +3,12 @@
.. Copyright 2018-2019 Tech Mahindra Ltd.
-Mapper
-=====================
+VES-Mapper
+==========
-| **Problem:** Different VNF vendors generate event and telemetry data in different formats. Out of the box, all VNF vendors may not support VES format.
-| **Solution**: A generic adapter which can convert different formats of event and telemetry data to VES format can be of use here.
+Different VNF vendors generate event and telemetry data in different formats. Out of the box, all VNF vendors may not support VES format.
+VES-Mapper provides a generic adapter to convert different formats of event and telemetry data into VES structure that can be consumed by existing DCAE analytics applications.
+
| *Note*: Currently mapping files are available for SNMP collector and RESTConf collector.
**VES-Mapper** converts the telemetry data into the required VES format and publishes to the DMaaP for further action to be taken by the DCAE analytics applications.
diff --git a/docs/sections/services/restconf/index.rst b/docs/sections/services/restconf/index.rst
index ec98c959..4b81b211 100644
--- a/docs/sections/services/restconf/index.rst
+++ b/docs/sections/services/restconf/index.rst
@@ -1,9 +1,9 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-=====================================
-RestConfCollector
-=====================================
+==================
+RestConf Collector
+==================
.. contents::
:depth: 3
diff --git a/docs/sections/services/sdk/architecture.rst b/docs/sections/services/sdk/architecture.rst
deleted file mode 100644
index 3f3cdf55..00000000
--- a/docs/sections/services/sdk/architecture.rst
+++ /dev/null
@@ -1,68 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Architecture
-============
-
-Introduction
-------------
-As most services and collectors deployed on DCAE platform relies on similar microservices a common Software Development Kit has been created. It contains utilities and clients which may be used for getting configuration from CBS, consuming messages from DMaaP, interacting with A&AI, etc. SDK is written in Java.
-
-Some of common function across different services are targeted to build as separate library was created in Dublin release.
-
-Reactive programming
---------------------
-Most of SDK APIs are using Project Reactor, which is one of available implementations of Reactive Streams (as well as Java 9 Flow). Due to this fact SDK supports both high-performance, non-blocking asynchronous clients and old-school, thread-bound, blocking clients. Reactive programming can solve many cloud-specific problems - if used properly.
-
-
-
-Libraries:
-----------
-
-DmaaP-MR Client
-~~~~~~~~~~~~~~~
- * Support for DmaaP MR publish and subscribe
- * Support for DmaaP configuration fetching from Consul
- * Support for authenticated topics pub/sub
- * Standardized logging
-
-
-ConfigBindingService Client
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Thin client wrapper to invoke CBS api to fetch configuration based on exposed properties during deployment. Provides option to periodically query and capture new configuration changes if any should be returned to application.
-
-
-A&AI Client
-~~~~~~~~~~~
- * Standardized logging and error handling
- * Provides a wrapper on AAI api for identifying node-type and support appropriate enrichment queries
- * Standardizes PNF update related queries
-
-
-DCAE Common Libraries (ONAP WIKI)
----------------------------------
-Following link is a reference to an internet site which describes basic features in general.
-DCAE_Common_Libraries_
-
-.. _DCAE_Common_Libraries: https://wiki.onap.org/pages/viewpage.action?pageId=45300259
-
-DCAE SDK
-~~~~~~~~
-Contains some general notes about the project and libraries which were used.
-DCAE_SDK_
-
-.. _DCAE_SDK: https://wiki.onap.org/display/DW/DCAE+SDK
-
-Changelog
-~~~~~~~~~
-Below link is a reference to an internet site which contains information about the changelog.
-Changelog_
-
-.. _Changelog: https://wiki.onap.org/display/DW/DCAE+SDK+Changelog
-
-FAQ
-~~~~
-DCAE SDK Frequently Asked Questions.
-FAQ_
-
-.. _FAQ: https://wiki.onap.org/display/DW/DCAE+SDK+Frequently+Asked+Questions \ No newline at end of file
diff --git a/docs/sections/services/sdk/index.rst b/docs/sections/services/sdk/index.rst
deleted file mode 100644
index 0af47ec5..00000000
--- a/docs/sections/services/sdk/index.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-DCAE SDK
-========
-
-**SDK** is a common software development kit written in Java. It contains various utilities and clients which may be used for getting configuration from CBS, consuming messages from DMaaP, interacting with A&AI, etc.
-
-
-SDK Overview
-------------
-
-.. toctree::
- :maxdepth: 1
-
- ./architecture.rst
-
-
-API reference \ No newline at end of file
diff --git a/docs/sections/services/serviceindex.rst b/docs/sections/services/serviceindex.rst
index 9825fe9a..fdc8aedd 100644
--- a/docs/sections/services/serviceindex.rst
+++ b/docs/sections/services/serviceindex.rst
@@ -2,8 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
-Service components under DCAE
-=============================
+DCAE Service components
+=======================
.. Add or remove sections below as appropriate for the platform component.
@@ -19,6 +19,5 @@ Service components under DCAE
./heartbeat-ms/index.rst
./pm-mapper/index.rst
./bbs-event-processor/index.rst
- ./sdk/index.rst
./son-handler/index.rst
- ./restconf/index.rst
+ ./restconf/index.rst \ No newline at end of file
diff --git a/docs/sections/services/snmptrap/index.rst b/docs/sections/services/snmptrap/index.rst
index 0a27cdd8..bee611c1 100644
--- a/docs/sections/services/snmptrap/index.rst
+++ b/docs/sections/services/snmptrap/index.rst
@@ -2,8 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
-SNMP TRAP COLLECTOR MS (DCAE)
-=============================
+SNMP Trap Collector
+===================
.. Add or remove sections below as appropriate for the platform component.
diff --git a/docs/sections/services/ves-http/architecture.rst b/docs/sections/services/ves-http/architecture.rst
index 5994255b..29077afe 100644
--- a/docs/sections/services/ves-http/architecture.rst
+++ b/docs/sections/services/ves-http/architecture.rst
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
VES Architecture
-===================
+================
.. image:: ./ves-deployarch.png
@@ -32,8 +32,8 @@ Schema definition files are contained within VES collector gerrit repo - https:/
Features Supported
==================
- VES collector deployed as docker containers
-- Acknowledged the sender with appropriate response code (both successful and failure)
-- Authentication of the events posted to collector
+- Acknowledgement to sender with appropriate response code (both successful and failure)
+- Authentication of the events posted to collector (support 4 types of authentication setting)
- Support single or batch JSON events input
- Schema validation (against standard VES definition)
- Multiple schema support and backward compatibility