summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/dfc/architecture.rst
diff options
context:
space:
mode:
authorChengkai Yan <martin.c.yan@est.tech>2018-11-06 16:32:03 +0100
committerChengkai Yan <martin.c.yan@est.tech>2018-11-06 17:45:54 +0100
commit7f278e30bef4a7a7cc7a4744d4bd3b3beb4ea5c1 (patch)
treebce49c2fa73c96a30dab6c3a56b0006d096b59a4 /docs/sections/services/dfc/architecture.rst
parent91e472c8640d9d6364c311474b15e9c9a95a0e9f (diff)
Update DFC documentation
Change-Id: I95befc4a6b597f67672797d44561de41af9c480d Signed-off-by: Chengkai Yan <martin.c.yan@est.tech> Issue-ID: DCAEGEN2-876
Diffstat (limited to 'docs/sections/services/dfc/architecture.rst')
-rw-r--r--docs/sections/services/dfc/architecture.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/sections/services/dfc/architecture.rst b/docs/sections/services/dfc/architecture.rst
new file mode 100644
index 00000000..1ee922af
--- /dev/null
+++ b/docs/sections/services/dfc/architecture.rst
@@ -0,0 +1,31 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Architecture
+============
+
+Introduction
+""""""""""""
+DataFile Collector (DFC) is a part of DCAEGEN2. Some information about DFC and the reasons of its implementation can be found here: `5G bulk PM wiki page`_.
+
+.. _5G bulk PM wiki page: https://wiki.onap.org/display/DW/5G+-+Bulk+PM
+
+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.
+
+
+DFC is delivered as one **Docker container** which hosts application server and can be started by `docker-compose`.
+See `Delivery`_ for more information about the docker container.
+
+.. _Delivery: ./delivery.html
+
+Functionality
+"""""""""""""
+.. image:: ../../images/DFC.png
+
+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.