X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Foverview.rst;h=a262bd2cb65d5e972e0578b780d7ed06a7d29def;hb=refs%2Fchanges%2F92%2F11192%2F1;hp=a107728bef1875f16c2f75c616270af772ed4624;hpb=28bb3daceee9d6108da813f0b44c5cc459ef3fde;p=nonrtric%2Fplt%2Franpm.git diff --git a/docs/overview.rst b/docs/overview.rst index a107728..a262bd2 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -26,11 +26,11 @@ 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. -* 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: @@ -44,13 +44,11 @@ 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) `. -* :doc:`Non-RT RIC - RAN PM - PM Data Data Converter (Documentation site) `. +* :doc:`Non-RT RIC - RAN PM - PM File Converter (Documentation site) `. * :doc:`Non-RT RIC - RAN PM - PM Producer (Documentation site) `. * :doc:`Non-RT RIC - RAN PM - Influx Logger (Documentation site) `. * `Non-RT RIC - Information Coordinator Service (Documentation site) `_. -* HTTPS-SERVER TBD - - +* HTTPS-SERVER TBD ********* Data Flow @@ -65,7 +63,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 +106,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) `. .. image:: ./DesignTimeDependencies.png - :width: 500pt \ No newline at end of file + :width: 500pt