summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/mapper
diff options
context:
space:
mode:
authorHansen, Tony (th1395) <th1395@att.com>2023-05-23 21:27:17 +0000
committerHansen, Tony (th1395) <th1395@att.com>2023-05-31 21:01:29 +0000
commit663df2c1b8d9176094a62b00b7e80de096180621 (patch)
tree849841dc428fcfba07d9c39494f95ccd1f25da8a /docs/sections/services/mapper
parentbcd436a1be4fbe2c8ad7ce074d86b94b8ff44f4e (diff)
clean up some sphinx warnings
Change-Id: I8c2d925e8b27b4740227af0be3ab5d6f7153ec38 Signed-off-by: Hansen, Tony (th1395) <th1395@att.com> Issue-ID: DCAEGEN2-3399 Signed-off-by: Hansen, Tony (th1395) <th1395@att.com> Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com> Signed-off-by: Hansen, Tony (th1395) <th1395@att.com>
Diffstat (limited to 'docs/sections/services/mapper')
-rw-r--r--docs/sections/services/mapper/SampleSnmpTrapConversion.rst56
-rw-r--r--docs/sections/services/mapper/delivery.rst4
-rw-r--r--docs/sections/services/mapper/flow.rst8
-rw-r--r--docs/sections/services/mapper/index.rst10
-rw-r--r--docs/sections/services/mapper/mappingfile.rst4
-rw-r--r--docs/sections/services/mapper/troubleshooting.rst4
6 files changed, 43 insertions, 43 deletions
diff --git a/docs/sections/services/mapper/SampleSnmpTrapConversion.rst b/docs/sections/services/mapper/SampleSnmpTrapConversion.rst
index b6ba41e4..26431bdd 100644
--- a/docs/sections/services/mapper/SampleSnmpTrapConversion.rst
+++ b/docs/sections/services/mapper/SampleSnmpTrapConversion.rst
@@ -9,58 +9,58 @@ Following is the **Sample SNMP Trap** that will be received by the Universal VES
.. code-block:: json
- {
+ {
"cambria.partition":"10.53.172.132",
"trap category":"ONAP-COLLECTOR-SNMPTRAP",
"community len":0,
"protocol version":"v2c",
- "varbinds":[
- {
+ "varbinds":[
+ {
"varbind_value":"CLEARED and CRITICAL severities have the same name",
"varbind_oid":"1.3.6.1.4.1.19444.12.2.0.2.0",
"varbind_type":"OctetString"
},
- {
+ {
"varbind_value":"1.3",
"varbind_oid":"1.3.6.1.4.1.19444.12.2.0.3.0",
"varbind_type":"ObjectIdentifier"
},
- {
+ {
"varbind_value":"1.3",
"varbind_oid":"1.3.6.1.4.1.19444.12.2.0.4.0",
"varbind_type":"ObjectIdentifier"
},
- {
+ {
"varbind_value":"CLEARED",
"varbind_oid":"1.3.6.1.4.1.19444.12.2.0.5.0",
"varbind_type":"OctetString"
},
- {
+ {
"varbind_value":"Queue manager: Process failure cleared",
"varbind_oid":"1.3.6.1.4.1.19444.12.2.0.6.0",
"varbind_type":"OctetString"
},
- {
+ {
"varbind_value":"The queue manager process has been restored to normal operation",
"varbind_oid":"1.3.6.1.4.1.19444.12.2.0.7.0",
"varbind_type":"OctetString"
},
- {
+ {
"varbind_value":"The queue manager process has been restored to normal operation. The previously issued alarm has been cleared",
"varbind_oid":"1.3.6.1.4.1.19444.12.2.0.8.0",
"varbind_type":"OctetString"
},
- {
+ {
"varbind_value":"Changes to shared config will be synchronized across the cluster",
"varbind_oid":"1.3.6.1.4.1.19444.12.2.0.9.0",
"varbind_type":"OctetString"
},
- {
+ {
"varbind_value":"No action",
"varbind_oid":"1.3.6.1.4.1.19444.12.2.0.10.0",
"varbind_type":"OctetString"
},
- {
+ {
"varbind_value":"sprout-1.example.com",
"varbind_oid":"1.3.6.1.4.1.19444.12.2.0.12.0",
"varbind_type":"OctetString"
@@ -82,9 +82,9 @@ Following is the converted VES Format of the above SNMP Sample Trap by using the
.. code-block:: json
- {
- "event":{
- "commonEventHeader":{
+ {
+ "event":{
+ "commonEventHeader":{
"startEpochMicrosec":1.5350269902625413E9,
"eventId":"XXXX",
"sequence":0,
@@ -96,49 +96,49 @@ Following is the converted VES Format of the above SNMP Sample Trap by using the
"version":3,
"reportingEntityName":"VesAdapter"
},
- "faultFields":{
+ "faultFields":{
"eventSeverity":"MINOR",
"alarmCondition":"ONAP-COLLECTOR-SNMPTRAP",
"faultFieldsVersion":2,
"specificProblem":"SNMP Fault",
- "alarmAdditionalInformation":[
- {
+ "alarmAdditionalInformation":[
+ {
"name":"1.3.6.1.4.1.19444.12.2.0.2.0",
"value":"CLEARED and CRITICAL severities have the same name"
},
- {
+ {
"name":"1.3.6.1.4.1.19444.12.2.0.3.0",
"value":"1.3"
},
- {
+ {
"name":"1.3.6.1.4.1.19444.12.2.0.4.0",
"value":"1.3"
},
- {
+ {
"name":"1.3.6.1.4.1.19444.12.2.0.5.0",
"value":"CLEARED"
},
- {
+ {
"name":"1.3.6.1.4.1.19444.12.2.0.6.0",
"value":"Queue manager: Process failure cleared"
},
- {
+ {
"name":"1.3.6.1.4.1.19444.12.2.0.7.0",
"value":"The queue manager process has been restored to normal operation"
},
- {
+ {
"name":"1.3.6.1.4.1.19444.12.2.0.8.0",
"value":"The queue manager process has been restored to normal operation. The previously issued alarm has been cleared"
},
- {
+ {
"name":"1.3.6.1.4.1.19444.12.2.0.9.0",
"value":"Changes to shared config will be synchronized across the cluster"
},
- {
+ {
"name":"1.3.6.1.4.1.19444.12.2.0.10.0",
"value":"No action"
},
- {
+ {
"name":"1.3.6.1.4.1.19444.12.2.0.12.0",
"value":"sprout-1.example.com"
}
@@ -147,4 +147,4 @@ Following is the converted VES Format of the above SNMP Sample Trap by using the
"vfStatus":"Active"
}
}
- } \ No newline at end of file
+ }
diff --git a/docs/sections/services/mapper/delivery.rst b/docs/sections/services/mapper/delivery.rst
index 3f667635..e9d24984 100644
--- a/docs/sections/services/mapper/delivery.rst
+++ b/docs/sections/services/mapper/delivery.rst
@@ -4,12 +4,12 @@
Delivery
========
-Mapper is delivered with **1 Docker container** having spring boot microservice, **UniversalVesAdapter**. UniversalVesAdapter converts telementary data to VES.
+Mapper is delivered with **1 Docker container** having spring boot microservice, **UniversalVesAdapter**. UniversalVesAdapter converts telementary data to VES.
| 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 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:latest``
diff --git a/docs/sections/services/mapper/flow.rst b/docs/sections/services/mapper/flow.rst
index 71cebfca..56eded56 100644
--- a/docs/sections/services/mapper/flow.rst
+++ b/docs/sections/services/mapper/flow.rst
@@ -7,24 +7,24 @@ 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.
+[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
:alt: RestConf flow
-
+
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 the received event into the VES event. It uses the enterprise ID from the received event to find the required mapping file.
+[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
- :alt: SNMP flow \ No newline at end of file
+ :alt: SNMP flow
diff --git a/docs/sections/services/mapper/index.rst b/docs/sections/services/mapper/index.rst
index de534be2..9ff3ff4a 100644
--- a/docs/sections/services/mapper/index.rst
+++ b/docs/sections/services/mapper/index.rst
@@ -6,12 +6,12 @@
VES-Mapper
==========
-Different VNF vendors generate event and telemetry data in different formats. Out of the box, all VNF vendors may not support VES format.
+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.
+**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.
.. toctree::
@@ -19,7 +19,7 @@ VES-Mapper provides a generic adapter to convert different formats of event and
./flow.rst
./delivery.rst
- ./installation.rst
+ ./installation-helm.rst
./mappingfile.rst
./SampleSnmpTrapConversion
- ./troubleshooting.rst \ No newline at end of file
+ ./troubleshooting.rst
diff --git a/docs/sections/services/mapper/mappingfile.rst b/docs/sections/services/mapper/mappingfile.rst
index 7333963c..642b84ab 100644
--- a/docs/sections/services/mapper/mappingfile.rst
+++ b/docs/sections/services/mapper/mappingfile.rst
@@ -13,7 +13,7 @@ The Adapter uses Smooks Framework to do the data format conversion by using the
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.
+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
@@ -62,7 +62,7 @@ Following is the default snmp mapping file which is used when no mapping file is
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.
+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 859bf6e4..7ac4f9c2 100644
--- a/docs/sections/services/mapper/troubleshooting.rst
+++ b/docs/sections/services/mapper/troubleshooting.rst
@@ -45,7 +45,7 @@ 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.**
@@ -78,4 +78,4 @@ If Default Config File is an invalid json file, we will get below exception
**Invalid Smooks mapping file**
-If VES-Mapper blueprint or local config file contains invalid Smooks mapping file, then we will get below SAXException / JsonProcessingException / JsonSyntaxException / JsonParseException while processing the incoming notifications and the notification will be dropped without converting into required VES event. All such dropped notifications will be logged in error log file. \ No newline at end of file
+If VES-Mapper blueprint or local config file contains invalid Smooks mapping file, then we will get below SAXException / JsonProcessingException / JsonSyntaxException / JsonParseException while processing the incoming notifications and the notification will be dropped without converting into required VES event. All such dropped notifications will be logged in error log file.