diff options
| author |   Chengkai Yan <martin.c.yan@est.tech> | 2018-11-06 16:32:03 +0100 |
|---|---|---|
| committer | Chengkai Yan <martin.c.yan@est.tech> | 2018-11-06 17:45:54 +0100 |
| commit | 7f278e30bef4a7a7cc7a4744d4bd3b3beb4ea5c1 (patch) | |
| tree | bce49c2fa73c96a30dab6c3a56b0006d096b59a4 /docs/sections/apis | |
| parent | 91e472c8640d9d6364c311474b15e9c9a95a0e9f (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/apis')
| -rw-r--r-- | docs/sections/apis/DFC.rst | 24 |
1 files changed, 2 insertions, 22 deletions
diff --git a/docs/sections/apis/DFC.rst b/docs/sections/apis/DFC.rst index 68326b5d..d7892a14 100644 --- a/docs/sections/apis/DFC.rst +++ b/docs/sections/apis/DFC.rst @@ -11,19 +11,9 @@ DFC (DataFile Collector) Overview ======== -DFC will orchestrate 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. +Component description can be found under `DFC`_. -Introduction -============ - -DFC is delivered as one **Docker container** which hosts application server and can be started by `docker-compose`. - -Functionality -============= -.. image:: ../images/DFC.png +.. _DFC: ../../services/dfc/index.html Paths @@ -79,16 +69,6 @@ Whole project (top level of DFC directory) and each module (sub module directory Configuration file: Config/datafile_endpoints.json -Main API Endpoints -================== - -Running with dev-mode of DFC - - Heartbeat: **http://<container_address>:8100/heartbeat** or **https://<container_address>:8433/heartbeat** - - Start DFC: **http://<container_address>:8100/start** or **https://<container_address>:8433/start** - - Stop DFC: **http://<container_address>:8100/stopDatafile** or **https://<container_address>:8433/stopDatafile** - -The external port allocated for 8100 (http) is 30245. - Maven GroupId: ============== |