Documentation of RAN PM

Added link to PM Data Converter.

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

diff --git a/datafilecollector/docs/overview.rst b/datafilecollector/docs/overview.rst
index ef28bd4..00d9ea4 100644 (file)
--- a/datafilecollector/docs/overview.rst
+++ b/datafilecollector/docs/overview.rst
@@ -77,7 +77,7 @@ Output File Publish Message
 ***************************
 
 
-Below follows an example of an output File Publish Message. .
+Below follows an example of an output File Publish Message.
 
 .. code-block:: javascript
 

diff --git a/docs/conf.py b/docs/conf.py
index f0e4e4c..8f9044f 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,7 +15,7 @@
 #  ============LICENSE_END=================================================
 #
 
-# NB: This is the only conf.yaml file used by the upstream readthedocs job  (ref '.readthedocs.yaml') 
+# NB: This is the only conf.yaml file used by the upstream readthedocs job  (ref '.readthedocs.yaml')
 #     Where possible include contents of the sub-folders' 'conf.yaml' files here if appropriate
 
 from docs_conf.conf import *
@@ -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['kafka-pm-producer'] = ('%s/kafka-pm-producer' % selfurl, None)
 
 intersphinx_disabled_reftypes = ["*"]

diff --git a/docs/overview.rst b/docs/overview.rst
index 2964761..a107728 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -5,7 +5,7 @@
 Non-RT RIC RAN PM Measurement
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Parent repository for components implementing Non-RT RIC RAN PM Use-case.
+Parent repository for components implementing Non-RT RIC RAN PM Use-cases.
 
 
 ********
@@ -44,7 +44,7 @@ The third party products used are:
 For more detailed documentation of the components:
 
 * :doc:`Non-RT RIC - RAN PM - PM Data File Collector (Documentation site) <datafilecollector:index>`.
-* PM Data Converter TBD
+* :doc:`Non-RT RIC - RAN PM - PM Data Data Converter (Documentation site) <kafka-pm-producer: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/>`_.
@@ -97,13 +97,14 @@ to json. So these does not use any subscriptions.
 PM Subscriber design time dependencies
 **************************************
 
-An rApp uses the ICS API, which is avaiable in `Non-RT RIC - Information Coordinator Service (Documentation site) <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/latest/>`_.
+An rApp uses the ICS API to create and manage the subscription of PM Measurements.
+The API documentation is avaiable in `Non-RT RIC - Information Coordinator Service (Documentation site) <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-informationcoordinatorservice/en/latest/>`_.
 
 The schema for the PM Mesaurement information jobs is defined in :doc:`Non-RT RIC - RAN PM - PM Producer (Documentation site) <pmproducer:index>`.
 This schema defines parameters used in the subscription (info job) and defines which measurements to subscribe for and on which
 kafka topic the information shall be delivered to.
 
-An application retrieving logged PM data from the Influx database needs to know how the data is stored. That is
+An application retrieving logged PM data from the Influx database needs to consider how the data is stored (the schema). That is
 defined in :doc:`Non-RT RIC - RAN PM - Influx Logger (Documentation site) <influxlogger:index>`.
 
 .. image:: ./DesignTimeDependencies.png

diff --git a/kafka-pm-producer/docs/overview.rst b/kafka-pm-producer/docs/overview.rst
index b2469ef..906881a 100644 (file)
--- a/kafka-pm-producer/docs/overview.rst
+++ b/kafka-pm-producer/docs/overview.rst
@@ -110,9 +110,9 @@ Here follows an example:
    }
 
 
-**************************
+*************************
 Output File Ready Message
-**************************
+*************************
 
 Here follows an example of the sent object indicating that a new Json file is available.
 It only contains the name of the stored file. The name of the bucket and the minio endpoint
@@ -125,5 +125,30 @@ must be known by the event receiver.
    }
 
 
+************************
+Input File Ready Message
+************************
+
+Below follows an example of an input File Ready Message. The
+message is sent by the Data File Collector. The only elemts used by this component are sourceName, name and
+objectStoreBucket.
+
+.. code-block:: javascript
+
+   {
+     "productName":"RnNode",
+     "vendorName":"Ericsson",
+     "lastEpochMicrosec":151983,
+     "sourceName":"5GRAN_DU",
+     "startEpochMicrosec":15198378,
+     "timeZoneOffset":"UTC+05:00",
+     "compression":"gzip",
+     "fileFormatType":"org.3GPP.32.435#measCollec",
+     "fileFormatVersion":"V10",
+     "name":"5GRAN_DU/A20220418.1900-1915_seliitdus00487.xml",
+     "changeIdentifier":"PM_MEAS_FILES",
+     "objectStoreBucket":"ropfiles"
+  }
+
 
 

diff --git a/pmproducer/docs/overview.rst b/pmproducer/docs/overview.rst
index 3196d66..766d777 100644 (file)
--- a/pmproducer/docs/overview.rst
+++ b/pmproducer/docs/overview.rst
@@ -289,6 +289,7 @@ The following properties are defined:
      The start file 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).
 
    * 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.