Documentation of RAN PM

Minor changes

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

diff --git a/docs/conf.py b/docs/conf.py
index 93ba261..ff87b2b 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -42,6 +42,6 @@ intersphinx_mapping['nonrtric'] = ('%s/o-ran-sc-nonrtric/en/%s' %(baseurl, branc
 intersphinx_mapping['influxlogger'] = ('%s/influxlogger' % selfurl, None)
 intersphinx_mapping['datafilecollector'] = ('%s/datafilecollector' % selfurl, None)
 intersphinx_mapping['pmproducer'] = ('%s/pmproducer' % selfurl, None)
-#intersphinx_mapping['pm-file-converter'] = ('%s/pm-file-converter' % selfurl, None)
+intersphinx_mapping['pm-file-converter'] = ('%s/pm-file-converter' % selfurl, None)
 
 intersphinx_disabled_reftypes = ["*"]

diff --git a/docs/overview.rst b/docs/overview.rst
index 526d9c5..13c22fe 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -43,14 +43,12 @@ The third party products used are:
 
 For more detailed documentation of the components:
 
-..  Commented out until the site exists for the first time
-   * :doc:`Non-RT RIC - RAN PM - PM File Converter (Documentation site) <pm-file-converter:index>`.
-
 * :doc:`Non-RT RIC - RAN PM - PM Data File Collector (Documentation site) <datafilecollector:index>`.
+* :doc:`Non-RT RIC - RAN PM - PM File Converter (Documentation site) <pm-file-converter:index>`.
 * :doc:`Non-RT RIC - RAN PM - PM Producer (Documentation site) <pmproducer:index>`.
 * :doc:`Non-RT RIC - RAN PM - Influx Logger (Documentation site) <influxlogger:index>`.
 * `Non-RT RIC - Information Coordinator Service (Documentation site) <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/latest/>`_.
-* HTTPS-SERVER TBD
+*  HTTPS-SERVER TBD
 
 *********
 Data Flow

diff --git a/influxlogger/docs/overview.rst b/influxlogger/docs/overview.rst
index 78b8564..bb8d4fb 100644 (file)
--- a/influxlogger/docs/overview.rst
+++ b/influxlogger/docs/overview.rst
@@ -134,7 +134,7 @@ Here follows an example of the expected input object:
 Configuration
 *************
 
-The DFC is configured via its 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 766d777..5029350 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.
@@ -124,9 +125,15 @@ For each filtered result sent to a Kafka topic, there will the following propert
 * source-name, the name of the source RAN traffic-handling element from which the measurements will originate.
 
 
-******************
-Configuration File
-******************
+*************
+Configuration
+*************
+
+The component is configured by a configuration file and by the normal spring boot configuration file (apoplication.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,13 @@ Below follows an example of a configuration file.
    ]
  }
 
+ ================
+ application.yaml
+ ================
+
+An example application.yaml configuration file: ":download:`link <../config/application.yaml>`"
+
+
 **************************
 Information Job Parameters
 **************************
@@ -359,6 +373,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.