summaryrefslogtreecommitdiffstats
path: root/ResmanagementService/deployment/src/main/release/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'ResmanagementService/deployment/src/main/release/README.txt')
-rw-r--r--ResmanagementService/deployment/src/main/release/README.txt55
1 files changed, 55 insertions, 0 deletions
diff --git a/ResmanagementService/deployment/src/main/release/README.txt b/ResmanagementService/deployment/src/main/release/README.txt
new file mode 100644
index 0000000..e4e797c
--- /dev/null
+++ b/ResmanagementService/deployment/src/main/release/README.txt
@@ -0,0 +1,55 @@
+Introduction:
+=============
+ This document provides the required steps for installation
+ and configuration this service.
+
+Installation steps:
+====================
+ Install following software:
+ - Java 1.8 or lattest
+ - MySql Server 5.7 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 and
+ run ./init_db.sh <db user> <db password> <db server ip> <db port>
+ CAUTION: Existing resmanagementdb will be cleaned before
+ initializing the schema, so please take a back-up of it
+ before executing it next time.
+
+Configuration steps:
+====================
+ - Update the db credetials in bean with id="source" in 'services.xml'
+ under webapps spring directory.
+ - Update the MSB address in $PATH/etc/conf/restclient.json
+ - Update the resmangement service ip address in $PATH/etc/adapterInfo/resmgradapterinfo.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 "resmgr" is reported from GET request on "/openoapi/microservices/v1/services"
+ - from this service, run one of the supported REST API mentioned in open-o NFVO 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
+
+
+