diff options
| author |   rajendrajaiswal <rajendra.jaiswal@ericsson.com> | 2019-03-12 14:09:23 +0000 |
|---|---|---|
| committer | rajendrajaiswal <rajendra.jaiswal@ericsson.com> | 2019-03-14 09:44:36 +0000 |
| commit | 3a715095c50917f955ea2ea495febe08481e2c16 (patch) | |
| tree | 0d583ccd4fc9aba8c286c11421a9a4b9b29a3127 | |
| parent | fdd14ecf4856426b95499d8a523dbb0b640e9768 (diff) | |
Documentation for PM Mapper and API
Change-Id: I86ed34def6308fa4c16937256a3b8918b407efe2
Issue-ID: DCAEGEN2-567
Signed-off-by: rajendrajaiswal <rajendra.jaiswal@ericsson.com>
| -rw-r--r-- | docs/sections/apis/pmmapper.rst | 21 | ||||
| -rw-r--r-- | docs/sections/services/pm-mapper/configuration.rst | 37 | ||||
| -rw-r--r-- | docs/sections/services/pm-mapper/installation.rst | 4 |
3 files changed, 59 insertions, 3 deletions
diff --git a/docs/sections/apis/pmmapper.rst b/docs/sections/apis/pmmapper.rst index 1e9333a8..6b736e36 100644 --- 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 b014f6f5..88d2ccc5 100644 --- a/docs/sections/services/pm-mapper/configuration.rst +++ b/docs/sections/services/pm-mapper/configuration.rst @@ -4,4 +4,39 @@ Configuration
=============
-< To-Do >
\ No newline at end of file +Filtering
+"""""""""
+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.
+Mapper filtering is based on the PM dictionary fields.
+PM mapper expects the filter in the following JSON format:
+
+::
+
+
+ "filters":[{
+ "pmDefVsn": "1.3",
+ "nfType": "gnb",
+ "vendor": "Ericsson",
+ "measTypes": [ "attTCHSeizures", "succTCHSeizures" ]
+ }]
+
+
+
+==================== ============================ ================================
+Field Description Type
+==================== ============================ ================================
+pmDefVsn PM Dictionary version. String
+vendor Vendor of the xNF type. String
+nfType nfType is vendor String
+ defined and should match the
+ string used in file ready
+ eventName.
+measTypes Measurement name used in PM Array of String
+ file in 3GPP format where
+ specified, else vendor
+ defined.
+==================== ============================ ================================
+
+Feed Name
+"""""""""
+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 5672e4de..dd80bdc7 100644 --- a/docs/sections/services/pm-mapper/installation.rst +++ b/docs/sections/services/pm-mapper/installation.rst @@ -4,4 +4,6 @@ Installation
============
-< To - Do >
+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.
+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.
+
|