Update PM Mapper documentation

* Switch deployment instructions to DCAE Dashboard
* Add instructions to resolve potential config issue when using
non-recommended deployment mechanism

Issue-ID: DCAEGEN2-1826
Signed-off-by: JoeOLeary <joseph.o.leary@est.tech>
Change-Id: I5f7119e8d47efcc9e849713a47462109e39e3bd6

3 files changed, 26 insertions, 41 deletions

diff --git a/docs/sections/services/pm-mapper/configuration.rst b/docs/sections/services/pm-mapper/configuration.rst
index 1e676c6a..b53c939a 100644
--- a/docs/sections/services/pm-mapper/configuration.rst
+++ b/docs/sections/services/pm-mapper/configuration.rst
@@ -6,7 +6,7 @@ Configuration and Performance
 
 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.
+PM Mapper maps PM XML files to performance VES event by applying the mapper filtering information. Mapper filtering is configured during instantiation through the DCAE Dashboard.
 Mapper filtering is based on the PM dictionary fields.
 PM Mapper expects the filter in the following JSON format:
 
diff --git a/docs/sections/services/pm-mapper/installation.rst b/docs/sections/services/pm-mapper/installation.rst
index ad96e5d2..064e9a92 100644
--- a/docs/sections/services/pm-mapper/installation.rst
+++ b/docs/sections/services/pm-mapper/installation.rst
@@ -10,52 +10,35 @@ interface or the command line tool. During instantiation, the PM Mapper will fet
 Deployment Prerequisite/dependencies

 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

 

-    - DCAE and DMaaP pods should be up and running.

-    - DMaaP Bus Controller post install jobs should have completed successfully (executed as part of an OOM install).

-    - Make sure that cfy is installed and configured to work with the Cloudify deployment.

+    - DCAE Platform, Consul, AAF and DMaaP pods should be up and running.

+    - DCAE Dashboard credentials are known.

 

 Deployment steps

 ^^^^^^^^^^^^^^^^

-

-Enter the Cloudify Manager kuberenetes pod

-

-    - Download the PM Mapper blueprint onto the pod, this can be found in:

-

-        https://git.onap.org/dcaegen2/services/pm-mapper/tree/dpo/blueprints/k8s-pm-mapper.yaml

-

-    - Create inputs.yaml

-

-        Configuration of the service consists of generating an inputs file (YAML) which will be used as part of the

-        Cloudify install. The PM-Mapper blueprints were designed with sane defaults for the majority of the fields.

-        Below you will find some examples of fields which can be configured, and some of the fields

-        which must be configured. The full list of configurable parameters can be seen within the blueprint file under

-        "inputs".

-

-        .. csv-table::

+- Download the PM Mapper blueprint, this can be found in:

+

+        https://git.onap.org/dcaegen2/services/pm-mapper/tree/dpo/blueprints/k8s-pm-mapper.yaml?h=elalto

+

+- Open the DCAE Dashboard.

+    - Navigate to 'Inventory' > 'Blueprints'.

+    - Click the 'Create' button in the top left.

+    - Drag and drop the previously downloaded PM Mapper blueprint into appropriately labeled field.

+    - Fill in the remaining of the required fields and click the create button at the bottom of the screen.

+    - Find the blueprint in the list, select the 'Actions' button then the 'Deploy' option.

+    - Select the targetted tenant.

+    - Configure the parameters

+         The PM Mapper blueprints were designed with sane defaults for the majority of the fields.

+         Below you will find more information about the fields, whether some input is required for them or not and some example values.

+

+         .. csv-table::

             :widths: auto

             :delim: ;

-            :header: Property , Sample Value , Description , Required

+            :header: Property , Sample Value , Description , Input Required

 

-            client_id ; dcae@dcae.onap.org ; In the Dublin release information about the AAF user must be provided to enable publishing to authenticated topics. ; Yes

+            client_id ; dcae@dcae.onap.org ; Information about the AAF user must be provided to enable publishing to authenticated topics. ; Yes

             client_password ; <dcae_password> ; This is the password for the given user e.g.  The <dcae_password> is dcae@dcae.onap.org's password. ; Yes

             enable_http ; true ; By default, the PM-Mapper will only allow inbound queries over HTTPS. However, it is possible to configure it to enable HTTP also. ; No

-            tag_version ; nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-mapper:1.0.1 ; The tag of the Docker image will be used when deploying the PM-Mapper. ; No

+            tag_version ; nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-mapper:1.3.1 ; The tag of the Docker image will be used when deploying the PM-Mapper. ; No

             pm-mapper-filter ; {"filters": [{"pmDefVsn":"targetVersion", "nfType":"targetNodeType", "vendor":"targetVendor","measTypes":["targetMeasType"]}]} ; The default behavior of the PM-Mapper is to map all measType in the received PM XML files, however, it's possible to provide filtering configuration which will reduce the VES event to the counters that the designer has expressed interest in. ; No

 

-        Example inputs.yaml

-

-        .. code-block:: yaml

-

-                client_id: dcae@dcae.onap.org

-                client_password: <dcae_password>

-                enable_http: false

-                tag_version: nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-mapper:latest

-                pm-mapper-filter: {"filters": []}

-

-

-

-    - Create deployment

-

-        .. code-block:: bash

-

-            cfy install --blueprint-id pm-mapper --deployment-id pm-mapper -i inputs.yaml k8s-pm-mapper.yaml

+    - Select the 'Deploy' button at the bottom of the screen.

diff --git a/docs/sections/services/pm-mapper/troubleshooting.rst b/docs/sections/services/pm-mapper/troubleshooting.rst
index c025fb0c..b71c45d7 100644
--- a/docs/sections/services/pm-mapper/troubleshooting.rst
+++ b/docs/sections/services/pm-mapper/troubleshooting.rst
@@ -96,7 +96,7 @@ Make sure Config Binding Service is up and running and the **ip + port** combina
 
 ====
 
-**Missing configuration on Consul**
+**Invalid configuration on Consul**
 
 ::
 
@@ -127,4 +127,6 @@ Make sure Config Binding Service is up and running and the **ip + port** combina
 
 **PM Mapper** logs this information when connected to Consul, but cannot find a valid JSON configuration.
 
+This can occur if the PM Mapper is deployed through Cloudify Manager or CLAMP when the default 'pm-mapper-filter' field is left unchanged as this default is configured to work with the DCAE Dashboard. If this is the cause for the invalid configuration then it can be resolved by removing the surrounding quotes on the object.
+