summaryrefslogtreecommitdiffstats
path: root/mod/runtimeapi/README.md
diff options
context:
space:
mode:
authorMichael Hwang <mhwang@research.att.com>2019-11-20 12:32:48 -0500
committerMichael Hwang <mhwang@research.att.com>2019-12-11 14:28:38 -0500
commitcc9d389bf197c1a365e669b407ea781f2bc87fd4 (patch)
tree9c4c8fdc265a4119d42dc8851aeead16a7767ce3 /mod/runtimeapi/README.md
parent849da15d5b7ddc68e4c2b90b603fc8948d4b5e6d (diff)
Add mod/runtimeapi
Change-Id: I6c0a45ddf460a63a1e4b9284e19bf4ab111bd463 Issue-ID: DCAEGEN2-1860 Signed-off-by: Michael Hwang <mhwang@research.att.com>
Diffstat (limited to 'mod/runtimeapi/README.md')
-rw-r--r--mod/runtimeapi/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/mod/runtimeapi/README.md b/mod/runtimeapi/README.md
new file mode 100644
index 0000000..d173df8
--- /dev/null
+++ b/mod/runtimeapi/README.md
@@ -0,0 +1,35 @@
+# Runtime API
+
+HTTP API to support runtime environment for DCAE-MOD. It has two major functionalities:
+1) accepts changes on the flow-graph via fbp protocol
+2) generate and distribute blueprints based on the change made on the flow-graph
+
+
+## Prerequisite
+
+If the docker image is not built then
+
+- Build current project
+```
+mvn clean install
+
+```
+
+- Dockerize the web module of the current project
+```
+cd runtime-web
+docker build -t runtime-api:latest .
+```
+
+## Run Docker container
+Note that DASHBOARD related variables should be set in the container
+```
+docker run --name runtime-api -d -p 9090:9090 \
+ -e DASHBOARD_URL=<url> -e DASHBOARD_USERNAME=<username> -e DASHBOARD_PASSWORD=<password> \
+ runtime-api:latest
+```
+
+
+docker run --name runtime-api -d -p 9090:9090 \
+ -e DASHBOARD_URL=https://dcae-inventory/dcae-service-types \
+ runtime-api:latest