X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=datafilecollector%2Fdocs%2Foverview.rst;h=00d9ea421d62f632a77178d854f3c1dce559b62f;hb=refs%2Fchanges%2F08%2F12708%2F1;hp=74e8e9bc369e29527b4fb8182b544dfb3f26d361;hpb=ff7ea9da4f2c0f11c8441a16782e5f96bfea135d;p=nonrtric%2Fplt%2Franpm.git diff --git a/datafilecollector/docs/overview.rst b/datafilecollector/docs/overview.rst index 74e8e9b..00d9ea4 100644 --- a/datafilecollector/docs/overview.rst +++ b/datafilecollector/docs/overview.rst @@ -11,12 +11,16 @@ Introduction ************ The task of the Data File Collector is to collect OAM data files from RAN traffic-handling nodes. -The main use case is: +The main use case is (see also the picture below)): -* The DFC receives a "File Ready" VES event from a Kafka topic. This contains a list of all available files. -* The DFC fetches files that are not already fetched from the relevant RAN traffic-handling nodes. This is done using one of the supported file transfer protocols. -* Each file is stored in an S3 Object Store bucket or in the file system (in a persistent volume). -* For each stored file, a "File Publish" message is sent to a Kafka topic for further processing. +* (1) The DFC receives a "File Ready" VES event from a Kafka topic. This contains a list of all available files. +* (2) The DFC fetches files that are not already fetched from the relevant RAN traffic-handling nodes. This is done using one of the supported file transfer protocols. +* (3) Each file is stored in an S3 Object Store bucket or in the file system (in a persistent volume). +* (4) For each stored file, a "File Publish" message is sent to a Kafka topic for further processing. +* (5) The "File Publish" message can be subscribed by other components, which can then read the fetched file and process it further. + +.. image:: ./Architecture.png + :width: 1000pt Supported file transfer protocols are: @@ -25,12 +29,8 @@ Supported file transfer protocols are: * HTTP * HTTPS - The service is implemented in Java Spring Boot. -.. image:: ./Architecture.png - :width: 1000pt - This product is a part of :doc:`NONRTRIC `. ************************** @@ -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