Documentation of RAN PM

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

diff --git a/docs/overview.rst b/docs/overview.rst
index a107728..f6ea5ce 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -26,7 +26,7 @@ Components
 The picture illustrates the components involved.
 
 * The PM Data File Collector fetches the XML files from the RAN.
-* The PM Data Converter converts these to a Json format. The structure and the contents
+* The PM File Converter converts these to a Json format. The structure and the contents
   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.
@@ -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>`.
-* :doc:`Non-RT RIC - RAN PM - PM Data Data Converter (Documentation site) <kafka-pm-producer: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/>`_.
@@ -65,7 +65,7 @@ The figure below gives an overview of the data flow through the components.
 2. The VES event is put on a Kafka topic and picked up by the Data File Collector.
 3. A PM report file is fetched from the RAN node by a file transfer protocol. Which protocol to use is defined in the VES event.
 4. The collected file is stored
-5. A File collected object is put on a Kafka topic and is picked up by the PM Data Converter.
+5. A File collected object is put on a Kafka topic and is picked up by the PM File Converter.
 6. The file data is read from the file store.
 7. A PM report in json format is stored (compressed with gzip).
 8. A message (a Json object) indicating that a new PM report (in Json format) is available is put on a Kafka topic and is picked up by the PM Data Producer.
@@ -108,4 +108,4 @@ An application retrieving logged PM data from the Influx database needs to consi
 defined in :doc:`Non-RT RIC - RAN PM - Influx Logger (Documentation site) <influxlogger:index>`.
 
 .. image:: ./DesignTimeDependencies.png
-   :width: 500pt
\ No newline at end of file
+   :width: 500pt