summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/dfc/installation.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/installation.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/installation.rst')
-rw-r--r--docs/sections/services/dfc/installation.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/sections/services/dfc/installation.rst b/docs/sections/services/dfc/installation.rst
new file mode 100644
index 00000000..ffaa580e
--- /dev/null
+++ b/docs/sections/services/dfc/installation.rst
@@ -0,0 +1,25 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Installation
+============
+
+An environment suitable for running docker containers is recommended.
+
+As a docker container
+---------------------
+
+**datafile** is delivered as a docker container based on openjdk:8-jre-alpine. The
+host or VM that will run this container must have the docker application
+loaded and available to the userID that will be running the DFC container.
+
+Also required is a working DMAAP/MR and DMAAP/DR environment. datafile
+subscribes to DMAAP/MR fileReady event as JSON messages and publishes the downloaded files to the DMAAP/DR.
+
+Installation
+^^^^^^^^^^^^
+
+The following command will download the latest datafile container from
+nexus and launch it in the container named "datafile":
+
+ ``docker run -d -p 8100:8100 -p 8433:8433 nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile``