update link to upper-constraints.txt

[dcaegen2.git] / docs / sections / services / pm-mapper / configuration.rst

diff --git a/docs/sections/services/pm-mapper/configuration.rst b/docs/sections/services/pm-mapper/configuration.rst
index a9f4f5b..fbac01c 100644 (file)
--- a/docs/sections/services/pm-mapper/configuration.rst
+++ b/docs/sections/services/pm-mapper/configuration.rst
@@ -1,11 +1,75 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2022 Nokia. All rights reserved.
+.. Copyright (c) 2023 AT&T Intellectual Property. All rights reserved.
+
 
 Configuration and Performance
 =============================
 
+Files Processing Configuration
+""""""""""""""""""""""""""""""
+The PM Mapper consumes the 3GPP XML files from DMaaP-DR, and processes them. It is possible to process it in parallel.
+In order to parallel processing, new configuration env has been introduced:
+
+- PROCESSING_LIMIT_RATE (optional, default value: 1) - allows to limit the rate of processing files through channel.
+
+- THREADS_MULTIPLIER (optional, default value: 1) - allows to specify multiplier to calculate the amount of threads.
+
+- PROCESSING_THREADS_COUNT (optional, default value: number of threads available to JVM) - allows to specify number of threads that will be used for files processing.
+
+.. _pm_mapper_disable_tls:
+
+Disable TLS
+"""""""""""
+Pm-mapper by default uses communication over TLS, but it is also possible to use plain http request. To disable TLS, set configuration flag 'enable_http' to true, and set the certificate paths to empty strings or remove them from the configuration. See the config.yaml examples below.
+
+.. code-block:: yaml
+
+  applicationConfig:
+    enable_http: true
+    key_store_path: ""
+    key_store_pass_path: ""
+    trust_store_path: ""
+    trust_store_pass_path: ""
+
+
+
+Or
+
+.. code-block:: yaml
+
+  applicationConfig:
+    enable_http: true
+    #key_store_path:
+    #key_store_pass_path:
+    #trust_store_path:
+    #trust_store_pass_path:
+
+
+Unauthenticated topic
+"""""""""""""""""""""
+To use unauthenticated topics :ref:`disable TLS <pm_mapper_disable_tls>`, and edit AAF credentials in configuration, it should be removed or set to empty string. See the examples below.
+
+.. code-block:: yaml
+
+  applicationConfig:
+    aaf_identity: ""
+    aaf_password: ""
+
+
+Or
+
+.. code-block:: yaml
+
+  applicationConfig:
+    #aaf_identity:
+    #aaf_password:
+
+
+
 PM Mapper Filtering
-"""""""""
+"""""""""""""""""""
 The PM Mapper performs data reduction, by filtering the PM telemetry data it receives.
 This filtering information is provided to the service as part of its configuration, and is used to identify desired PM measurements (measType) contained within the data.
 The service can accept an exact match to the measType or regex(java.util.regex) identifying multiple measTypes (it is possible to use both types simultaneously).