summaryrefslogtreecommitdiffstats
path: root/deployment/src/main/release/README.txt
diff options
context:
space:
mode:
authorluxin <luxin7@huawei.com>2018-03-28 11:16:04 +0800
committerluxin <luxin7@huawei.com>2018-03-28 11:16:48 +0800
commit5e3ad2aeed27bd318ed6e7bb9d3180a02b9e3ccf (patch)
treec6299a59246a4e8873505e6304d2fdb79739dc94 /deployment/src/main/release/README.txt
parent45ab470edd754384e6c8efc1c3f22b828f5c542e (diff)
Make install package for multivimproxy
Change-Id: I565789552eafd61fa20f041402e9a208fbe41879 Issue-ID: VFC-644 Signed-off-by: luxin <luxin7@huawei.com>
Diffstat (limited to 'deployment/src/main/release/README.txt')
-rw-r--r--deployment/src/main/release/README.txt48
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
+
+
+