aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authoryufei_zhou <yufei.zhou@nokia-sbell.com>2017-10-11 15:55:31 +0800
committeryufei_zhou <yufei.zhou@nokia-sbell.com>2017-10-11 15:55:31 +0800
commitd1ef98fa4b5a586a8071edd7aec34b7391648334 (patch)
tree036b57ebdbc8a32ffe0c38db82f53f016d402823 /docs
parent7268770ee19e39a0aba48f9f5e1d1f7cc943c049 (diff)
Add Nokia Vnfm Driver installation
Change-Id: I8db15e2671fdb074620ec90379c9d7b82e23e163 Issue-ID: VFC-53 Signed-off-by: yufei_zhou <yufei.zhou@nokia-sbell.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/installation.rst66
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/installation.rst b/docs/installation.rst
index c1d2b396..5fcbdc03 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -12,3 +12,69 @@ Environment
Steps
+++++
+
+Nokia VNFM Driver Installation guide
+====================================
+ 1. Download .zip installer package
+
+ 2. Unzip this installer to the installation directory (ex: /opt/openo/nfvo/)
+
+ 3. Refer the README.txt from the installation directory, to install and configure this service. Please refer the same README document below for easy reference:
+
+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 vnfm_db 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 credentials in 'application.properties' under webapps directory.
+ - Update the VNFM address in 'application.properties' under webapps directory.
+ - Update the service name and version of MSB services in 'application.properties' under webapps directory.
+ - Update the MSB address in $PATH/etc/conf/restclient.json
+ - Update the service ip address in $PATH/etc/adapterInfo/jujuadapterinfo.json
+
+
+
+How to run?
+===========
+ - In command console, cd to 'bin' directory under the location,
+ where this service installer is unzipped and
+ run ./startup.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 "nokia-vnfm-driver" 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 ./shutdown.sh