Documentation of RAN PM 92/11192/1
authorPatrikBuhr <patrik.buhr@est.tech>
Tue, 23 May 2023 06:44:22 +0000 (08:44 +0200)
committerPatrikBuhr <patrik.buhr@est.tech>
Tue, 23 May 2023 06:44:22 +0000 (08:44 +0200)
Minor changes

Signed-off-by: PatrikBuhr <patrik.buhr@est.tech>
Issue-ID: NONRTRIC-868
Change-Id: Ie2bb54ef26c5c6b409a1f621477f0033fee3110a

docs/overview.rst
influxlogger/docs/overview.rst
pmproducer/docs/overview.rst

index 13c22fe..a262bd2 100644 (file)
@@ -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:
 
index bb8d4fb..679d0c1 100644 (file)
@@ -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>`"
 
 
index 0345e82..c56af74 100644 (file)
@@ -174,9 +174,12 @@ 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>`"