blob: eec07a9ba564cde6b676402302b4eab395ee163a [file] [log] [blame]
Chengkai Yan7f278e32018-11-06 16:32:03 +01001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4Architecture
5============
6
7Introduction
8""""""""""""
maximessonc762eb12019-04-04 14:43:43 +00009DataFile Collector (DFC) is a part of DCAEGEN2. Some information about DFC and the reasons of its implementation can be
10found here: `5G bulk PM wiki page`_.
Chengkai Yan7f278e32018-11-06 16:32:03 +010011
12.. _5G bulk PM wiki page: https://wiki.onap.org/display/DW/5G+-+Bulk+PM
13
14DFC will handle the collection of bulk PM data flow:
15 1. Subscribes to fileReady DMaaP topic
16 2. Collects the file from the xNF
maximessone707b222019-05-09 14:27:34 +000017 3. Sends new file data to DataRouter.
Chengkai Yan7f278e32018-11-06 16:32:03 +010018
19
maximessone707b222019-05-09 14:27:34 +000020DFC is delivered as one **Docker container** which hosts application server.
Chengkai Yan7f278e32018-11-06 16:32:03 +010021See `Delivery`_ for more information about the docker container.
22
23.. _Delivery: ./delivery.html
24
25Functionality
26"""""""""""""
27.. image:: ../../images/DFC.png
28
29Interaction
30"""""""""""
maximessone707b222019-05-09 14:27:34 +000031DFC will interact with the DMaaP Message Router, using json, and with the Data Router, using metadata in the header and
32file in the body, via secured protocol.
33So far, the implemented protocols to communicate with xNFs are sftp and ftp(e)s.
maximessonc762eb12019-04-04 14:43:43 +000034
35Retry mechanism
36"""""""""""""""
37DFC is designed to retry downloading and publishing of files in order to recover from temporary faults.
maximessone707b222019-05-09 14:27:34 +000038Each time an event is received, DFC will try to download it and publish each previously unpublished file in the event.
maximessonc762eb12019-04-04 14:43:43 +000039The event is received from the Message Router (MR), the files are fetched from a PNF and are published to Data Router
40(DR).
41Both fetching of a file and publishing is retried a number of times with an increasing delay between each attempt.
42After a number of attempts, the DFC will log an error message and give up. Failing of processing of one file does not
maximessone707b222019-05-09 14:27:34 +000043affect the handling of others.