summaryrefslogtreecommitdiffstats
path: root/ResmanagementService/deployment/src/main/release/README.txt
blob: e4e797c1ff635f11c44aacb0e7bf515b52d88143 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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