Merge "Updated installation and components"

diff --git a/docs/overview.rst b/docs/overview.rst
index 13c22fe..a262bd2 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -30,7 +30,7 @@ The picture illustrates the components involved.
   is the same as the XML format.
 * The PM Producer handles filtering and distribution of PM data to subscribers. These subscribers can be rApps.
 * The Influx Logger stores selected PM mesurements into a time series database.
-* HTTPS-SERVER is for testing and implements functionality to simulate file transfer from thye RAN nodes.
+* HTTPS-SERVER is for testing and implements functionality to simulate file transfer from RAN nodes.
 
 The third party products used are:
 

diff --git a/influxlogger/docs/overview.rst b/influxlogger/docs/overview.rst
index bb8d4fb..679d0c1 100644 (file)
--- a/influxlogger/docs/overview.rst
+++ b/influxlogger/docs/overview.rst
@@ -38,19 +38,6 @@ Here follows an example of one Influx table which contains aggregated values for
    :width: 1000pt
 
 
-******************************************
-Setting up the PM measurement subscription
-******************************************
-
-The influx logger will create its data subscription automatically. This is done by reading a file that
-defines the data to log and which Kafka topic to use (1). The contents of this file is used to create
-the information job for subscribing of PM measurement (2). ICS will make sure that all PM Measurement producers
-are ordered to start producing data (3).
-
-.. image:: ./Subscription.png
-   :width: 1000pt
-
-An example jobDefinition.json file: ":download:`link <../config/jobDefinition.json>`"
 
 ********************
 Input PM Measurement
@@ -134,9 +121,28 @@ Here follows an example of the expected input object:
 Configuration
 *************
 
-The component is configured via its application.yaml
 
 
+==========================================
+Setting up the PM measurement subscription
+==========================================
+
+The influx logger will create its data subscription automatically. This is done by reading a configuration file that
+defines the data to log and which Kafka topic to use (1). The contents of this file is used to create
+the information job for subscribing of PM measurement (2). ICS will make sure that all PM Measurement producers
+are ordered to start producing data (3).
+
+.. image:: ./Subscription.png
+   :width: 1000pt
+
+An example jobDefinition.json file: ":download:`link <../config/jobDefinition.json>`"
+
+================
+application.yaml
+================
+
+The component is configured via its application.yaml
+
 An example application.yaml configuration file: ":download:`link <../config/application.yaml>`"
 
 

diff --git a/pmproducer/docs/overview.rst b/pmproducer/docs/overview.rst
index 5029350..c56af74 100644 (file)
--- a/pmproducer/docs/overview.rst
+++ b/pmproducer/docs/overview.rst
@@ -122,7 +122,7 @@ 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.
 
 
 *************
@@ -174,9 +174,12 @@ Below follows an example of a configuration file.
    ]
  }
 
- ================
- application.yaml
- ================
+
+
+================
+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>`"
 
@@ -300,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.