Change: add OPEN-O seed code for VF-C
[vfc/nfvo/driver/vnfm/svnfm.git] / huawei / vnfmadapter / VnfmadapterService / deployment / src / main / release / README.txt
1 Introduction:
2 =============
3     This document provides the required steps for installation
4     and configuration this service.
5
6 Installation steps:
7 ====================
8     Install following software:
9         - Java 1.8 or lattest
10         - MySql Server 5.7 or lattest.
11         - Apache Tomcat Server 8.0 or lattest
12
13     Set the following environment variables:
14         - JAVA_HOME: Set to JAVA JDK installed location
15         - CATALINIA_HOME: Set to Tomcat installed location
16         - CATALINIA_BASE: Set to the location, where this
17           service installer is unzipped, its optional
18         - PATH: Update it with the location of command 'mysql'
19
20     - In command console, cd to 'bin' directory under the location,
21       where this service installer is unzipped and
22       run ./init_db.sh <db user> <db password> <db server ip> <db port>
23         CAUTION: Existing vnfmdb will be cleaned before
24         initializing the schema, so please take a back-up of it
25         before executing it next time.
26
27 Configuration steps:
28 ====================
29     - Update the db credetials in bean with id="source"  in 'services.xml'
30       under webapps spring directory.
31     - Update the MSB address in $PATH/etc/conf/restclient.json
32     - Update the vnfmadapter service ip address in $PATH/etc/adapterInfo/vnfmadapterinfo.json
33
34
35 How to run?
36 ===========
37     - In command console, cd to 'bin' directory under the location,
38       where this service installer is unzipped and
39       run ./start.sh
40           NOTE: It starts the tomcat at predefined http port. To change
41           default port, update the port in tomcat configuration file
42           'conf/server.xml'
43           - Verify that 'Tomcat started.' is reported on the console.
44     - Once service is started, please verify below details:
45         - from MSB service, verify that "hwvnfm"  is reported from GET request on "/openoapi/microservices/v1/services"
46         - from this service, run one of the supported REST API mentioned in open-o NFVO wiki and verify that the
47           expected response is returned.
48 How to stop?
49 =============
50     - In command console, cd to 'bin' directory under the location,
51       where this service installer is unzipped and
52       run ./stop.sh
53
54 Update:
55 =========
56 The latest information are available through the OPEN-O release notes at
57 https://wiki.open-o.org/view/OPEN-O_Sun_Release_Notes