Release notes & Roll version after i-release 1.1.0 -> 1.2.0

[nonrtric/plt/ranpm.git] / pmproducer / docs / overview.rst

diff --git a/pmproducer/docs/overview.rst b/pmproducer/docs/overview.rst
index 766d777..7852177 100644 (file)
--- a/pmproducer/docs/overview.rst
+++ b/pmproducer/docs/overview.rst
@@ -39,6 +39,7 @@ After filtering, the data will be delivered to the output topic.
 
 The format of the delivered PM measurement is the same as the input format (which in turn is a Json mapping done from
 3GPP TS 32.432/3GPP TS 32.435).
+The data can be delivered in gzipped format or in cleartext (indicated by an element in the Kafka header).
 
 The result of the PM filtering preserves the structure of a 3GPP PM report.
 Here follows an example of a resulting delivered PM report.
@@ -121,12 +122,18 @@ For each filtered result sent to a Kafka topic, there will the following propert
 
 * type-id, this property is used to indicate the ID of the information type. The value is a string.
 * gzip, if this property exists the object is gzip'ed (otherwise not). The property has no value.
-* source-name, the name of the source RAN traffic-handling element from which the measurements will originate.
+* source-name, the name of the source RAN traffic-handling element from which the measurements originate.
 
 
-******************
-Configuration File
-******************
+*************
+Configuration
+*************
+
+The component is configured by a configuration file and by the normal spring boot configuration file (application.yaml).
+
+==================
+Configuration file
+==================
 
 The configuration file defines Kafka topics that should be listened to and registered as information types which can be subscribed to.
 There is an example configuration file in config/application_configuration.json
@@ -167,6 +174,16 @@ Below follows an example of a configuration file.
    ]
  }
 
+
+
+================
+application.yaml
+================
+As any springboot application, this is component configured via an application.yaml file.
+
+An example application.yaml configuration file: ":download:`link <../config/application.yaml>`"
+
+
 **************************
 Information Job Parameters
 **************************
@@ -286,10 +303,12 @@ The following properties are defined:
    * measuredEntityDns, selection of DNs for the RAN traffic-handling elements.
 
    * pmRopStartTime, if this parameter is specified already collected PM measurements files will be scanned to retrieve historical data.
-     The start file is the time from when the information shall be returned.
+     This is the time from when the information shall be returned.
      In this case, the query is only done for files from the given "sourceNames".
      If this parameter is excluded, only "new" reports will be delivered as they are collected from the RAN traffic-handling nodes.
      How old information that can be retrieved depends on the retention time for the storage (if minio it used, it is a S3 bucket).
+     A best effort is done, so that the stored files that are in time range are scanned even if the
+     specified time is too long back in time.
 
    * pmRopEndTime, for querying already collected PM measurements. Only relevant if pmRopStartTime.
      If this parameters is given, no reports will be sent as new files are collected.
@@ -359,6 +378,10 @@ and the result is sent to the Kafka topic specified by the Job (by the data cons
 .. image:: ./dedicatedTopics.png
    :width: 500pt
 
+=========================================
+Several Jobs sharing the same Kafka topic
+=========================================
+
 If several jobs publish to the same Kafka topic (shared topic), the resulting filtered output will be an aggregate of all matching filters.
 So, each consumer will then get more data than requested.