From 91e472c8640d9d6364c311474b15e9c9a95a0e9f Mon Sep 17 00:00:00 2001 From: Pooja03 Date: Fri, 2 Nov 2018 20:20:57 +0530 Subject: Adding Documentation of Mapper Adding documentation of Mapper on readthedocs Change-Id: I80ec21296ec42ef21552a9e93839ca5209a27a58 Issue-ID: DCAEGEN2-936 Signed-off-by: Pooja03 --- docs/sections/services/mapper/index.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/sections/services/mapper/index.rst (limited to 'docs/sections/services/mapper/index.rst') diff --git a/docs/sections/services/mapper/index.rst b/docs/sections/services/mapper/index.rst new file mode 100644 index 00000000..81122932 --- /dev/null +++ b/docs/sections/services/mapper/index.rst @@ -0,0 +1,30 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 Tech Mahindra Ltd. + + +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. +| *Note*: Currently support snmp trap telemetry data + +There are 2 micro services in the mapper functionality. + +**Universal VES Adapter** - It converts the telemetry data into the required ves format and publishes to the dmaap for further action to be taken. + *Note*: Currently it supports conversion of snmp traps generated by SNMP TRAP Collector. With some work, it can support other collectors as well. + + +**SnmpMapper** - It provides web UI to upload mapping files which are then stored into the postgres database. VES adapter refers to these mapping files at the time of converting the events into VES events. + + + +.. toctree:: + :maxdepth: 1 + + ./flow.rst + ./delivery.rst + ./installation.rst + ./MappingFile.rst + ./SampleSnmpTrapConversion -- cgit 1.2.3-korg