Merge "Update microservice to run as standalone MS"
[dcaegen2/services/son-handler.git] / README.md
1 SONHMS 
2
3 ### Build Instructions
4
5 This project is organized as a mvn project and has "org.onap.dcaegen2" as parent project. The build generate a jar and package into docker container. 
6
7 ```
8 git clone https://gerrit.onap.org/r/dcaegen2/services/son-handler
9 mvn clean install
10 mvn clean install docker:build
11 ```
12
13
14 ### Environment variables in Docker Container
15
16
17 Variables coming from deployment system:
18
19 - APP_NAME - son-handler application name that will be registered with consul
20 - CONSUL_PROTOCOL - Consul protocol by default set to **http**, if it is need to change it then that can be set to different value 
21 - CONSUL_HOST - used with conjunction with CBSPOLLTIMER, should be a host address (without port! e.g my-ip-or-host) where Consul service lies
22 - CBS_PROTOCOL - Config Binding Service protocol by default set to **http**, if it is need to change it then that can be set to different value
23 - CONFIG_BINDING_SERVICE - used with conjunction with CBSPOLLTIMER, should be a name of CBS as it is registered in Consul
24 - HOSTNAME - used with conjunction with CBSPOLLTIMER, should be a name of sonhms application as it is registered in CBS catalog
25 ### Release images
26 For R4 - image/version  pushed to nexus3 
27 ```
28 nexus3.onap.org:10001/snapshots/onap/org.onap.dcaegen2.services.son-handler   1.0.0
29 ```
30
31 ### Deployment
32 son handler can be manually deployed in dcae environment using cloudify blueprint.
33
34 login to bootstrap container in dcae deployment
35
36 Copy the blueprints to the bootstrap container.
37
38 The blueprint can be found under dpo/blueprints in the son-handler project.
39
40 To install : 
41         cfy install -b sonhms -d sonhms -i <inputs filepath> <blueprint filepath> 
42
43 To uninstall:
44         cfy uninstall sonhms
45         cfy blueprints delete sonhms
46
47
48 ### Standalone deployment
49 son handler can be deployed standalone using docker-compose.
50
51 Navigate to src/main/docker directory. docker-compose.yaml can be found there.
52
53 To install :
54     docker-compose up
55
56 To uninstall :
57     docker-compose down