summaryrefslogtreecommitdiffstats
path: root/deployment/src/main/release/README.txt
diff options
context:
space:
mode:
authorluxin <luxin7@huawei.com>2017-03-15 16:49:25 +0800
committerluxin <luxin7@huawei.com>2017-03-15 16:49:25 +0800
commit7b63090190459364e2c4be3edf49ebb6256f6dab (patch)
tree5002435abdbbbb7307b69155d982abf9564e7270 /deployment/src/main/release/README.txt
parent7709f7cfdc7d19032fe590547a24678de04dbe97 (diff)
Onboarding Interface
Validate&Lifecycle Test Onboarding Interface VNFSDK-78 Change-Id: Ic59ffb6d2b2ddbb128fa5634307ad16c5bb4f319 Signed-off-by: luxin <luxin7@huawei.com>
Diffstat (limited to 'deployment/src/main/release/README.txt')
-rw-r--r--deployment/src/main/release/README.txt41
1 files changed, 41 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..443a11b
--- /dev/null
+++ b/deployment/src/main/release/README.txt
@@ -0,0 +1,41 @@
+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
+
+Configuration steps:
+====================
+ - Update the MSB address in $PATH/etc/conf/restclient.json
+ - Update the lifecycle-test service ip address in $PATH/etc/adapterInfo/lifecycletestinfo.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 "lifecycle-test" 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