datafilecollector/README.md

   1 # DFC (DataFile Collector)
   2
   3 Datafile Collector is responsible for collecting PM counter files from traffical functions.
   4 The files are stored in a persistent volume or in an S3 object store.
   5
   6 The origin is from ONAP. This variant uses Kafka and S3 object store and does not use the Dmaap.
   7
   8 ## Introduction
   9
  10 DFC is delivered as one **Docker container** which hosts application server and can be started by `docker-compose`.
  11
  12 ## Compiling DFC
  13
  14 Whole project (top level of DFC directory) and each module (sub module directory) can be compiled using
  15 `mvn clean install` command.
  16
  17 ## Build image
  18 ```
  19 mvn install docker:build
  20 ```
  21
  22 ## Main API Endpoints
  23
  24 Running with dev-mode of DFC
  25
  26 - **Heartbeat**: http://<container_address>:8100/**heartbeat** or https://<container_address>:8443/**heartbeat**
  27
  28 - **Start DFC**: http://<container_address>:8100/**start** or https://<container_address>:8433/**start**
  29
  30 - **Stop DFC**: http://<container_address>:8100/**stopDatafile** or https://<container_address>:8433/**stopDatafile**
  31
  32
  33
  34 ## License
  35
  36 Copyright (C) 2018-2019 NOKIA Intellectual Property, 2018-2023 Nordix Foundation. All rights reserved.
  37 [License](http://www.apache.org/licenses/LICENSE-2.0)