summaryrefslogtreecommitdiffstats
path: root/docker/README.MD
diff options
context:
space:
mode:
Diffstat (limited to 'docker/README.MD')
-rw-r--r--docker/README.MD24
1 files changed, 24 insertions, 0 deletions
diff --git a/docker/README.MD b/docker/README.MD
new file mode 100644
index 0000000..26a793b
--- /dev/null
+++ b/docker/README.MD
@@ -0,0 +1,24 @@
+Introduction:
+=============
+This document provides the required steps for :
+- generating the docker image of the heat validation rest service
+- running the rest server.
+
+Installation steps:
+====================
+Install following software:
+- maven
+- docker
+
+Configuration steps:
+====================
+you can override the defaults settings (declared in default_settings.cfg and prod_settings.cfg)
+by setting the env variable with the appropriate values (see Dockerfile for available ENV vars)
+
+How to run?
+===========
+- make sure that the MSB is running
+- build the image :
+- ``$ mvn -P docker clean package``
+- run the server in DEBUG mode:
+- ``$ docker run --rm --name vnfsdk-ice -d -p 5000:5000 -e DEBUG=True -e MSB_ADDR=<MSB ADDR> -e MSB_PORT=80 onap/vnfsdk/ice``