Documentation for PM Mapper and API

Change-Id: I86ed34def6308fa4c16937256a3b8918b407efe2
Issue-ID: DCAEGEN2-567
Signed-off-by: rajendrajaiswal <rajendra.jaiswal@ericsson.com>

diff --git a/docs/sections/apis/pmmapper.rst b/docs/sections/apis/pmmapper.rst
index 1e9333a..6b736e3 100644 (file)
--- a/docs/sections/apis/pmmapper.rst
+++ b/docs/sections/apis/pmmapper.rst
@@ -44,7 +44,26 @@ GET ``/healthcheck``
 
 Description
 ~~~~~~~~~~~
-This is the  health check endpoint. If this returns a 200, the server is alive. If anything other than a 200, either dead, or no connection to pm mapper.
+This is the health check endpoint. If this returns a 200, the server is alive. If anything other than a 200, the server is either dead or no connection to pm mapper.
+
+Responses
+~~~~~~~~~
+
++-----------+---------------------+
+| HTTP Code | Description         |
++===========+=====================+
+| **200**   | successful response |
++-----------+---------------------+
+
+
+GET ``/reconfigure``
+--------------------
+
+
+
+Description
+~~~~~~~~~~~
+This is the reconfigure endpoint to fetch updated config information using config binding service.
 
 Responses
 ~~~~~~~~~

diff --git a/docs/sections/services/pm-mapper/configuration.rst b/docs/sections/services/pm-mapper/configuration.rst
index b014f6f..88d2ccc 100644 (file)
--- a/docs/sections/services/pm-mapper/configuration.rst
+++ b/docs/sections/services/pm-mapper/configuration.rst
@@ -4,4 +4,39 @@
 Configuration\r
 =============\r
 \r
-< To-Do >
\ No newline at end of file
+Filtering\r
+"""""""""\r
+PM mapper maps PM XML files to performance VES event by applying the mapper filtering information. Mapper filtering is configured during instantiation through cloudify manager.\r
+Mapper filtering is based on the PM dictionary fields.\r
+PM mapper expects the filter in the following JSON format:\r
+\r
+::\r
+\r
+\r
+         "filters":[{\r
+            "pmDefVsn": "1.3",\r
+            "nfType": "gnb",\r
+            "vendor": "Ericsson",\r
+            "measTypes": [ "attTCHSeizures", "succTCHSeizures" ]\r
+        }]\r
+\r
+\r
+\r
+====================   ============================      ================================\r
+Field                  Description                       Type\r
+====================   ============================      ================================\r
+pmDefVsn               PM Dictionary version.            String\r
+vendor                 Vendor of the xNF type.           String\r
+nfType                 nfType is vendor                  String\r
+                       defined and should match the\r
+                       string used in file ready\r
+                       eventName.\r
+measTypes              Measurement name used in PM       Array of String\r
+                       file in 3GPP format where\r
+                       specified, else vendor\r
+                       defined.\r
+====================   ============================      ================================\r
+\r
+Feed Name\r
+"""""""""\r
+A default feed name "bulk_pm_feed" is configured in PM Mapper blueprint but the feed name can be changed to a user defined value through cloudify manager.
\ No newline at end of file

diff --git a/docs/sections/services/pm-mapper/installation.rst b/docs/sections/services/pm-mapper/installation.rst
index 5672e4d..dd80bdc 100644 (file)
--- a/docs/sections/services/pm-mapper/installation.rst
+++ b/docs/sections/services/pm-mapper/installation.rst
@@ -4,4 +4,6 @@
 Installation\r
 ============\r
 \r
-< To - Do >\r
+PM mapper is a microservice that will be instantiated by Cloudify Manager. PM Mapper blueprint is uploaded into Cloudify Manager where the user can configure the PM Mapper.\r
+Cloudify Manager will then proceed to instantiate the pm mapper service within DCAE Services. During instantiation, the PM mapper will query configuration information using the Config Binding Service.\r
+\r