summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/dfc/architecture.rst
diff options
context:
space:
mode:
authormaximesson <maxime.bonneau@est.tech>2019-05-09 14:27:34 +0000
committermaximesson <maxime.bonneau@est.tech>2019-05-09 14:27:34 +0000
commite707b220b6f21433970157ed3eb91854e8c6e7f0 (patch)
treee61b373cee93beb33eb793bb9116ae0d06b529df /docs/sections/services/dfc/architecture.rst
parent776b61f244ed17723672b99b3610eefd6d8fb3c0 (diff)
Update DFC documentation w/ troubleshooting guide
Change-Id: Ia4c3a48fce99ee409c6f012d3ab5e3fca84f1ffc Issue-ID: DCAEGEN2-1443 Signed-off-by: maximesson <maxime.bonneau@est.tech>
Diffstat (limited to 'docs/sections/services/dfc/architecture.rst')
-rw-r--r--docs/sections/services/dfc/architecture.rst29
1 files changed, 7 insertions, 22 deletions
diff --git a/docs/sections/services/dfc/architecture.rst b/docs/sections/services/dfc/architecture.rst
index ac0c8d14..eec07a9b 100644
--- a/docs/sections/services/dfc/architecture.rst
+++ b/docs/sections/services/dfc/architecture.rst
@@ -14,10 +14,10 @@ found here: `5G bulk PM wiki page`_.
DFC will handle the collection of bulk PM data flow:
1. Subscribes to fileReady DMaaP topic
2. Collects the file from the xNF
- 3. Sends new event to DataRouter with file.
+ 3. Sends new file data to DataRouter.
-DFC is delivered as one **Docker container** which hosts application server and can be started by `docker-compose`.
+DFC is delivered as one **Docker container** which hosts application server.
See `Delivery`_ for more information about the docker container.
.. _Delivery: ./delivery.html
@@ -28,31 +28,16 @@ Functionality
Interaction
"""""""""""
-DFC will interact with the DMaaP Message Router and with the Data Router via secured protocol, using json files.
-So far, the implemented protocols are sftp and ftp(e)s.
+DFC will interact with the DMaaP Message Router, using json, and with the Data Router, using metadata in the header and
+file in the body, via secured protocol.
+So far, the implemented protocols to communicate with xNFs are sftp and ftp(e)s.
Retry mechanism
"""""""""""""""
DFC is designed to retry downloading and publishing of files in order to recover from temporary faults.
-Each time an event is received, DFC will try to download and and publish each previously unpublished file in the event.
+Each time an event is received, DFC will try to download it and publish each previously unpublished file in the event.
The event is received from the Message Router (MR), the files are fetched from a PNF and are published to Data Router
(DR).
Both fetching of a file and publishing is retried a number of times with an increasing delay between each attempt.
After a number of attempts, the DFC will log an error message and give up. Failing of processing of one file does not
-affect the handling of others.
-
-Maven GroupId:
-==============
-
-org.onap.dcaegen2.collectors
-
-Maven Parent ArtifactId:
-========================
-
-dcae-collectors
-
-Maven Children Artifacts:
-=========================
-
-1. datafile-app-server: DFC server
-
+affect the handling of others. \ No newline at end of file