From b511dbcfa89872fc3b7f5e2c163d5a93af678c56 Mon Sep 17 00:00:00 2001 From: elinuxhenrik Date: Thu, 20 Sep 2018 13:05:18 +0200 Subject: Add documentation for Datafile Collector Change-Id: I247e1b2583e470e75156fc0449e85c0b86a1c8e8 Issue-ID: DCAEGEN2-642 Signed-off-by: elinuxhenrik --- docs/sections/apis/DFC.rst | 97 +++++++++++++++++++++++++++++++++++++++++++ docs/sections/images/DFC.png | Bin 0 -> 43468 bytes 2 files changed, 97 insertions(+) create mode 100644 docs/sections/apis/DFC.rst create mode 100644 docs/sections/images/DFC.png diff --git a/docs/sections/apis/DFC.rst b/docs/sections/apis/DFC.rst new file mode 100644 index 00000000..0605f3fa --- /dev/null +++ b/docs/sections/apis/DFC.rst @@ -0,0 +1,97 @@ +============================== +DFC (DataFile Collector) +============================== + +:Date: 2018-09-21 + +.. contents:: + :depth: 3 +.. + +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. + +Introduction +============ + +DFC is delivered as one **Docker container** which hosts application server and can be started by `docker-compose`. + +Functionality +============= +../images/DFC.png + + +Paths +===== + +GET /events/unauthenticated.VES_NOTIFICATION_OUTPUT +----------------------------------------------- + +Description +~~~~~~~~~~~ + +Reads fileReady events from DMaaP (Data Movement as a Platform) + + +Responses +~~~~~~~~~ + ++-----------+-------------------------------------------+ +| HTTP Code | Description | ++===========+===========================================+ +| **200** | successful response | ++-----------+-------------------------------------------+ + + + +POST /publish +-------------------------------------- + +Description +~~~~~~~~~~~ + +Publish the collected file/s as a stream to DataRouter + - file as stream + - compression + - fileFormatType + - fileFormatVersion + + +Responses +~~~~~~~~~ + ++-----------+-------------------------------------------+ +| HTTP Code | Description | ++===========+===========================================+ +| **200** | successful response | ++-----------+-------------------------------------------+ + +Compiling DFC +============= + +Whole project (top level of DFC directory) and each module (sub module directory) can be compiled using +`mvn clean install` command. + +Maven GroupId: +============== + +org.onap.dcaegen2.collectors + +Maven Parent ArtifactId: +======================== + +dcae-collectors + +Maven Children Artifacts: +========================= + +1. datafile-app-server: DFC server +2. datafile-dmaap-client: Contains implementation of DmaaP client +3. datafile-commons: Common code for whole DFC modules + + diff --git a/docs/sections/images/DFC.png b/docs/sections/images/DFC.png new file mode 100644 index 00000000..216f5947 Binary files /dev/null and b/docs/sections/images/DFC.png differ -- cgit 1.2.3-korg