1 files changed, 48 insertions, 0 deletions
diff --git a/deployment/src/main/release/README.txt b/deployment/src/main/release/README.txt
new file mode 100644
index 0000000..dad4f96
--- /dev/null
+++ b/deployment/src/main/release/README.txt
@@ -0,0 +1,48 @@
+Introduction:
+=============
+    This document provides the required steps for installation
+    and configuration this service.
+
+Installation steps:
+====================
+    Install following software:
+        - Java 1.8 or lattest
+        - Apache Tomcat Server 8.0 or lattest
+
+    Set the following environment variables:
+        - JAVA_HOME: Set to JAVA JDK installed location
+        - CATALINIA_HOME: Set to Tomcat installed location
+        - CATALINIA_BASE: Set to the location, where this
+          service installer is unzipped, its optional
+        - PATH: Update it with the location of command 'mysql'
+
+    - In command console, cd to 'bin' directory under the location,
+      where this service installer is unzipped
+
+Configuration steps:
+====================    
+    - Update the MSB address in $PATH/etc/conf/restclient.json
+    - Update the multivimproxy service ip address in $PATH/etc/adapterInfo/adapterinfo.json
+
+How to run?
+===========
+    - In command console, cd to 'bin' directory under the location,
+      where this service installer is unzipped and
+      run ./start.sh
+          NOTE: It starts the tomcat at predefined http port. To change
+          default port, update the port in tomcat configuration file
+          'conf/server.xml'
+          - Verify that 'Tomcat started.' is reported on the console.
+    - Once service is started, please verify below details:
+        - from MSB service, verify that "multivimproxy"  is reported from GET request on "/api/microservices/v1/services"
+        - from this service, run one of the supported REST API mentioned in onap wiki and verify that the
+          expected response is returned.
+
+How to stop?
+=============
+    - In command console, cd to 'bin' directory under the location,
+      where this service installer is unzipped and
+      run ./stop.sh
+
+
+