summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/mapper
diff options
context:
space:
mode:
authorVENKATESH KUMAR <vv770d@att.com>2020-11-12 15:00:02 -0500
committerVENKATESH KUMAR <vv770d@att.com>2020-11-12 22:30:51 -0500
commite21c848562599340a99fc216bdaae97686d92a72 (patch)
tree65a3446cccde840220e3e2be2b53ee16d0bad7b4 /docs/sections/services/mapper
parent2cf33d0d1cecad5a309d428aa44f7740ca48032e (diff)
DCAE doc cleanup warnings
Change-Id: I39daca57d4754abe0db56a7f85e7274a5f45ad74 Signed-off-by: VENKATESH KUMAR <vv770d@att.com> Issue-ID: DCAEGEN2-2141 Signed-off-by: VENKATESH KUMAR <vv770d@att.com>
Diffstat (limited to 'docs/sections/services/mapper')
-rw-r--r--docs/sections/services/mapper/SampleSnmpTrapConversion.rst2
-rw-r--r--docs/sections/services/mapper/delivery.rst4
-rw-r--r--docs/sections/services/mapper/flow.rst39
-rw-r--r--docs/sections/services/mapper/installation.rst9
-rw-r--r--docs/sections/services/mapper/mappingfile.rst5
-rw-r--r--docs/sections/services/mapper/troubleshooting.rst4
6 files changed, 28 insertions, 35 deletions
diff --git a/docs/sections/services/mapper/SampleSnmpTrapConversion.rst b/docs/sections/services/mapper/SampleSnmpTrapConversion.rst
index 71f5718b..b6ba41e4 100644
--- a/docs/sections/services/mapper/SampleSnmpTrapConversion.rst
+++ b/docs/sections/services/mapper/SampleSnmpTrapConversion.rst
@@ -3,7 +3,7 @@
.. Copyright 2018 Tech Mahindra Ltd.
Sample Snmp trap Conversion:
-===========================
+============================
Following is the **Sample SNMP Trap** that will be received by the Universal VES Adapter from the Snmp Trap Collector :
diff --git a/docs/sections/services/mapper/delivery.rst b/docs/sections/services/mapper/delivery.rst
index 6cb2cf2f..3f667635 100644
--- a/docs/sections/services/mapper/delivery.rst
+++ b/docs/sections/services/mapper/delivery.rst
@@ -9,7 +9,7 @@ Mapper is delivered with **1 Docker container** having spring boot microservice,
| In current release, the UniversalVesAdapter is integrated with DCAE's config binding service. On start, it fetches the initial configuration from CBS and uses the same. Currently it is not having functionality to refresh the configuration changes made into Consul KV store.
Docker Containers
----------------
+-----------------
Docker images can be pulled from ONAP Nexus repository with below commands:
- ``docker pull nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0-SNAPSHOT``
+ ``docker pull nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:latest``
diff --git a/docs/sections/services/mapper/flow.rst b/docs/sections/services/mapper/flow.rst
index 9fe3bfbb..ed05332c 100644
--- a/docs/sections/services/mapper/flow.rst
+++ b/docs/sections/services/mapper/flow.rst
@@ -2,38 +2,33 @@
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2018-2019 Tech Mahindra Ltd.
-============
-Flow for converting Rest Conf Collector notification
-============
-.. [1] RestConf Collector generates rcc-notication in JSON format and publishes it on DMaaP topic **unathenticated.DCAE_RCC_OUTPUT**
-.. [2] The Universal VES Adapter(UVA) microservice has subscribed to this DMaaP topic.
-.. [3] On receiving an event from DMaaP, the adapter uses the corresponding mapping file and converts received notification into the VES event. It uses the notification-id from the received notification to find the required mapping file.
-.. [4] Those notifications for which no mapping file is identified, a default mapping file is used with generic mappings to create the VES event.
-.. [5] The VES formatted Event will be then published on DMaaP topic **unauthenticated.VES_PNFREG_OUTPUT**.
+
+Flow for converting RestConf Collector notification
+===================================================
+[1] RestConf Collector generates rcc-notication in JSON format and publishes it on DMaaP topic **unathenticated.DCAE_RCC_OUTPUT**
+[2] The Universal VES Adapter(UVA) microservice has subscribed to this DMaaP topic.
+[3] On receiving an event from DMaaP, the adapter uses the corresponding mapping file and converts the received notification into the VES event. It uses the notification-id from the received notification to find the required mapping file.
+[4] Those notifications for which no mapping file is identified, a default mapping file is used with generic mappings to create the VES event.
+[5] The VES formatted Event will be then published on DMaaP topic **unauthenticated.VES_PNFREG_OUTPUT**.
.. image:: ./flow-rest-conf.png
- :height: 200px
- :width: 300 px
- :scale: 50 %
:alt: alternate text
:align: left
- ============
+
Flow for converting SNMP Collector notification
-============
-.. [1] VNF submits SNMP traps to the SNMP collector.
-.. [2] Collector converts the trap into JSON format and publishes it on DMaaP topic **unauthenticated.ONAP-COLLECTOR-SNMPTRAP**
-.. [3] The Universal VES Adapter(UVA) microservice has subscribed to this DMaaP topic.
-.. [4] On receiving an event from DMaaP, the adapter uses the corresponding mapping file and converts received event into the VES event. It uses the enterprise ID from the received event to find the required mapping file.
-.. [5] Those SNMP Traps for which no mapping file is identified, a default mapping file is used with generic mappings to create the VES event.
-.. [6] The VES formatted Event will be then published on DMaaP topic **unauthenticated.SEC_FAULT_OUTPUT**.
+===============================================
+
+[1] VNF submits SNMP traps to the SNMP collector.
+[2] Collector converts the trap into JSON format and publishes it on DMaaP topic **unauthenticated.ONAP-COLLECTOR-SNMPTRAP**
+[3] The Universal VES Adapter(UVA) microservice has subscribed to this DMaaP topic.
+[4] On receiving an event from DMaaP, the adapter uses the corresponding mapping file and converts the received event into the VES event. It uses the enterprise ID from the received event to find the required mapping file.
+[5] Those SNMP Traps for which no mapping file is identified, a default mapping file is used with generic mappings to create the VES event.
+[6] The VES formatted Event will be then published on DMaaP topic **unauthenticated.SEC_FAULT_OUTPUT**.
.. image:: ./flow.png
- :height: 200px
- :width: 300 px
- :scale: 50 %
:alt: alternate text
:align: left \ No newline at end of file
diff --git a/docs/sections/services/mapper/installation.rst b/docs/sections/services/mapper/installation.rst
index 2add9d92..da0bcdc1 100644
--- a/docs/sections/services/mapper/installation.rst
+++ b/docs/sections/services/mapper/installation.rst
@@ -17,7 +17,7 @@ VES-Mapper can be deployed individually though it will throw errors if it can't
VES-Mapper blueprint is available @
https://git.onap.org/dcaegen2/services/mapper/tree/UniversalVesAdapter/dpo/blueprints/k8s-vesmapper.yaml-template.yaml?h=elalto
-VES-Mapper docker image is available in Nexus repo @ `nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1 <nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1>`_
+VES-Mapper docker image is available in Nexus repo @ `nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:latest <nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:latest>`_
@@ -27,11 +27,8 @@ VES-Mapper docker image is available in Nexus repo @ `nexus3.onap.org:10001/onap
*a. Verify DMaaP configurations in the blueprint as per setup*
Dmaap Configuration consists of subscribe url to fetch notifications from the respective collector and publish url to publish ves event.
-
-
-``streams_publishes`` and ``streams_subscribes`` points to the publishing topic and subscribe topic respectively.
-
-update these ``urls`` as per your DMaaP configurations in the blueprint.
+
+``streams_publishes`` and ``streams_subscribes`` point to the publishing topic and subscribe topic respectively. Update these ``urls`` as per your DMaaP configurations in the blueprint.
*b. Verify the Smooks mapping configuration in the blueprint as per the usecase. Blueprint contains default mapping for each supported collector ( SNMP Collector and RESTConf collector currently) which may serve the purpose for the usecase. The ``mapping-files`` in ``collectors`` contains the contents of the mapping file.
diff --git a/docs/sections/services/mapper/mappingfile.rst b/docs/sections/services/mapper/mappingfile.rst
index daf515d3..7333963c 100644
--- a/docs/sections/services/mapper/mappingfile.rst
+++ b/docs/sections/services/mapper/mappingfile.rst
@@ -12,7 +12,7 @@ The Adapter uses Smooks Framework to do the data format conversion by using the
| http://www.smooks.org/guide
SNMP Collector Default Mapping File
-============
+===================================
Following is the default snmp mapping file which is used when no mapping file is found while processing event from SNMP Trap Collector.
.. code-block:: xml
@@ -60,7 +60,8 @@ Following is the default snmp mapping file which is used when no mapping file is
</jb:bean></smooks-resource-list>
RestConf Collector Default Mapping File
-============
+=======================================
+
Following is the default RestConf collector mapping file which is used when no mapping file is found while processing notification from RestConf Collector.
.. code-block:: xml
diff --git a/docs/sections/services/mapper/troubleshooting.rst b/docs/sections/services/mapper/troubleshooting.rst
index 5d524e5c..859bf6e4 100644
--- a/docs/sections/services/mapper/troubleshooting.rst
+++ b/docs/sections/services/mapper/troubleshooting.rst
@@ -34,7 +34,7 @@ Error and warning logs contain also:
**Do not rely on exact log messages or their presence, as they are often subject to change.**
Deployment/Installation errors
---------------------
+------------------------------
**Missing Default Config File in case of using local config instead of Consul**
@@ -45,10 +45,10 @@ Deployment/Installation errors
|13:04:37.537 [main] ERROR errorLogger - Application stoped due to missing default Config file
|13:04:37.538 [main] INFO o.s.s.c.ThreadPoolTaskExecutor - Shutting down ExecutorService 'applicationTaskExecutor'
|15:40:43.982 [main] WARN debugLogger - All Smooks objects closed
+
**These log messages are printed when the default configuration file "kv.json", was not present.**
-
**Invalid Default Config File in case of using local config instead of Consul**
If Default Config File is an invalid json file, we will get below exception