mod/runtimeapi/README.md

   1 # Runtime API
   2
   3 HTTP API to support runtime environment for DCAE-MOD. It has two major functionalities:
   4 1)  accepts changes on the flow-graph via fbp protocol
   5 2) generate and distribute blueprints based on the change made on the flow-graph
   6
   7
   8 ## Prerequisite
   9
  10 If the docker image is not built then
  11
  12 - Build current project
  13 ```
  14 mvn clean install
  15
  16 ```
  17
  18 - Dockerize the  web module of the current project
  19 ```
  20 cd runtime-web
  21 docker build -t runtime-api:latest .
  22 ```
  23
  24 ## Run Docker container
  25 Note that DASHBOARD related variables should be set in the container
  26 ```
  27 docker run --name runtime-api -d -p 9090:9090 \
  28  -e DASHBOARD_URL=<url> -e DASHBOARD_USERNAME=<username> -e DASHBOARD_PASSWORD=<password> \
  29  runtime-api:latest
  30 ```
  31
  32
  33 docker run --name runtime-api -d -p 9090:9090 \
  34  -e DASHBOARD_URL=https://dcae-inventory/dcae-service-types \
  35  runtime-api:latest