Merge "Define constant instead of localhost"
[vfc/nfvo/driver/vnfm/svnfm.git] / nokia / vnfmdriver / vfcadaptorservice / 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 vnfm_db 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 'application.properties' under webapps directory.
30     - Update the MSB address in 'application.properties' under webapps directory.
31     - Update the VNFM address in 'application.properties' under webapps directory.
32     - Update the Catalog address in 'application.properties' under webapps directory.
33     - Update the NSLCM address in 'application.properties' under webapps directory.
34
35
36 How to run?
37 ===========
38     - In command console, cd to 'bin' directory under the location,
39       where this service installer is unzipped and
40       run ./startup.sh
41           NOTE: It starts the tomcat at predefined http port. To change
42           default port, update the port in tomcat configuration file
43           'conf/server.xml'
44           - Verify that 'Tomcat started.' is reported on the console.
45     - Once service is started, please verify below details:
46         - from MSB service, verify that "nokiavnfm"  is reported from GET request on "/openoapi/microservices/v1/services"
47         - from this service, run one of the supported REST API mentioned in open-o NFVO wiki and verify that the
48           expected response is returned.
49 How to stop?
50 =============
51     - In command console, cd to 'bin' directory under the location,
52       where this service installer is unzipped and
53       run ./shutdown.sh
54
55 Update:
56 =========
57 The latest information are available through the OPEN-O release notes at
58 https://wiki.open-o.org/view/OPEN-O_Sun_Release_Notes