| elinuxhenrik | b511dbc | 2018-09-20 13:05:18 +0200 | [diff] [blame^] | 1 | ============================== |
| 2 | DFC (DataFile Collector) |
| 3 | ============================== |
| 4 | |
| 5 | :Date: 2018-09-21 |
| 6 | |
| 7 | .. contents:: |
| 8 | :depth: 3 |
| 9 | .. |
| 10 | |
| 11 | Overview |
| 12 | ======== |
| 13 | |
| 14 | DFC will orchestrate the collection of bulk PM data flow: |
| 15 | 1. Subscribes to fileReady DMaaP topic |
| 16 | 2. Collects the file from the xNF |
| 17 | 3. Sends new event to DataRouter with file. |
| 18 | |
| 19 | Introduction |
| 20 | ============ |
| 21 | |
| 22 | DFC is delivered as one **Docker container** which hosts application server and can be started by `docker-compose`. |
| 23 | |
| 24 | Functionality |
| 25 | ============= |
| 26 | ../images/DFC.png |
| 27 | |
| 28 | |
| 29 | Paths |
| 30 | ===== |
| 31 | |
| 32 | GET /events/unauthenticated.VES_NOTIFICATION_OUTPUT |
| 33 | ----------------------------------------------- |
| 34 | |
| 35 | Description |
| 36 | ~~~~~~~~~~~ |
| 37 | |
| 38 | Reads fileReady events from DMaaP (Data Movement as a Platform) |
| 39 | |
| 40 | |
| 41 | Responses |
| 42 | ~~~~~~~~~ |
| 43 | |
| 44 | +-----------+-------------------------------------------+ |
| 45 | | HTTP Code | Description | |
| 46 | +===========+===========================================+ |
| 47 | | **200** | successful response | |
| 48 | +-----------+-------------------------------------------+ |
| 49 | |
| 50 | |
| 51 | |
| 52 | POST /publish |
| 53 | -------------------------------------- |
| 54 | |
| 55 | Description |
| 56 | ~~~~~~~~~~~ |
| 57 | |
| 58 | Publish the collected file/s as a stream to DataRouter |
| 59 | - file as stream |
| 60 | - compression |
| 61 | - fileFormatType |
| 62 | - fileFormatVersion |
| 63 | |
| 64 | |
| 65 | Responses |
| 66 | ~~~~~~~~~ |
| 67 | |
| 68 | +-----------+-------------------------------------------+ |
| 69 | | HTTP Code | Description | |
| 70 | +===========+===========================================+ |
| 71 | | **200** | successful response | |
| 72 | +-----------+-------------------------------------------+ |
| 73 | |
| 74 | Compiling DFC |
| 75 | ============= |
| 76 | |
| 77 | Whole project (top level of DFC directory) and each module (sub module directory) can be compiled using |
| 78 | `mvn clean install` command. |
| 79 | |
| 80 | Maven GroupId: |
| 81 | ============== |
| 82 | |
| 83 | org.onap.dcaegen2.collectors |
| 84 | |
| 85 | Maven Parent ArtifactId: |
| 86 | ======================== |
| 87 | |
| 88 | dcae-collectors |
| 89 | |
| 90 | Maven Children Artifacts: |
| 91 | ========================= |
| 92 | |
| 93 | 1. datafile-app-server: DFC server |
| 94 | 2. datafile-dmaap-client: Contains implementation of DmaaP client |
| 95 | 3. datafile-commons: Common code for whole DFC modules |
| 96 | |
| 97 | |