components/slice-analysis-ms/README.md

   1 SLICE-ANALYSIS-MS
   2
   3 ### Build Instructions
   4
   5 This project is organized as a mvn project and is a sub-project of dcaegen2/services (inside components directory). The build generate a jar and package into docker container.
   6
   7 ```
   8 git clone https://gerrit.onap.org/r/dcaegen2/services
   9 To build slice-analysis-ms run `mvn clean install` from **components/slice-analysis-ms** directory
  10 To build docker image run `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 - slice-analysis-ms application name that will be registered with consul
  20 - CONSUL_PROTOCOL - Consul protocol by default set to **https**, 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 **https**, 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 slice-analysis-ms application as it is registered in CBS catalog
  25
  26
  27 ### Deployment
  28
  29
  30 ### Standalone deployment
  31 Slice analysis ms can be deployed standalone using docker-compose.
  32
  33 Navigate to src/main/docker directory. docker-compose.yaml can be found there.
  34
  35 To install :
  36     docker-compose up
  37
  38 To uninstall :
  39     docker-compose down