Merge "Documentation for generalised DFC"
diff --git a/docs/sections/services/pm-mapper/configuration.rst b/docs/sections/services/pm-mapper/configuration.rst
index d7a13aa..1e676c6 100644
--- a/docs/sections/services/pm-mapper/configuration.rst
+++ b/docs/sections/services/pm-mapper/configuration.rst
@@ -43,7 +43,7 @@
::
- org.onap.dmaap.mr.PM_MAPPER
+ org.onap.dmaap.mr.PERFORMANCE_MEASUREMENTS
Performance
^^^^^^^^^^^
diff --git a/docs/sections/services/pm-mapper/delivery.rst b/docs/sections/services/pm-mapper/delivery.rst
index 30a886c..207d4c9 100644
--- a/docs/sections/services/pm-mapper/delivery.rst
+++ b/docs/sections/services/pm-mapper/delivery.rst
@@ -11,4 +11,4 @@
::
- ``docker run -d --name pmmapper -e CONFIG_BINDING_SERVICE_SERVICE_HOST=<IP Required> -e CONFIG_BINDING_SERVICE_SERVICE_PORT=<Port Required> -e HOSTNAME=<HOSTNAME> nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-mapper:1.0.1``
+ ``docker run -d --name pmmapper -e CONFIG_BINDING_SERVICE_SERVICE_HOST=<IP Required> -e CONFIG_BINDING_SERVICE_SERVICE_PORT=<Port Required> -e HOSTNAME=<HOSTNAME> nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-mapper``
diff --git a/docs/sections/services/pm-mapper/installation.rst b/docs/sections/services/pm-mapper/installation.rst
index 51ae5a4..ad96e5d 100644
--- a/docs/sections/services/pm-mapper/installation.rst
+++ b/docs/sections/services/pm-mapper/installation.rst
@@ -21,7 +21,7 @@
- Download the PM Mapper blueprint onto the pod, this can be found in:
- https://gerrit.onap.org/r/gitweb?p=dcaegen2/services/pm-mapper.git;a=blob_plain;f=dpo/blueprints/k8s-pm-mapper.yaml;h=b331e41222377b8fbf7b68b4f5fff5ba5998da16;hb=refs/heads/dublin
+ https://git.onap.org/dcaegen2/services/pm-mapper/tree/dpo/blueprints/k8s-pm-mapper.yaml
- Create inputs.yaml
@@ -36,8 +36,8 @@
:delim: ;
:header: Property , Sample Value , Description , Required
- aaf_username ; dcae@dcae.onap.org ; In the Dublin release information about the AAF user must be provided to enable publishing to authenticated topics. ; Yes
- aaf_password ; <dcae_password> ; This is the password for the given user e.g. The <dcae_password> is dcae@dcae.onap.org's password. ; Yes
+ 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_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
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
@@ -46,10 +46,10 @@
.. code-block:: yaml
- aaf_username: dcae@dcae.onap.org
- aaf_password: <dcae_password>
+ 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:1.0.1
+ tag_version: nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-mapper:latest
pm-mapper-filter: {"filters": []}
@@ -59,4 +59,3 @@
.. code-block:: bash
cfy install --blueprint-id pm-mapper --deployment-id pm-mapper -i inputs.yaml k8s-pm-mapper.yaml
-
diff --git a/docs/sections/services/pm-mapper/logging.rst b/docs/sections/services/pm-mapper/logging.rst
index cc56f41..b5769f8 100644
--- a/docs/sections/services/pm-mapper/logging.rst
+++ b/docs/sections/services/pm-mapper/logging.rst
@@ -4,4 +4,13 @@
Logging
=======
-The log file is located under /var/log/ONAP/dcaegen2/services/pm-mapper/pm-mapper_output.log.
+There are two separate log files in the PM Mapper container.
+
+The main log file is located under /var/log/ONAP/dcaegen2/services/pm-mapper/pm-mapper_output.log.
+
+The human readable log file which contains less information is located under /var/log/ONAP/dcaegen2/services/pm-mapper/pm-mapper_output_readable.log.
+
+Log Level
+"""""""""
+
+The PM Mapper log level is set to INFO by default. This can be changed in the running container by editing the logLevel variable in the logback.xml file located under /opt/app/pm-mapper/etc/logback.xml. Changes to this file will be picked up every 30 seconds.