Merge "add api integration and add review comments"
[sdc/sdc-workflow-designer.git] / README.md
1 # Steps to run the Workflow application on Docker
2
3 ## 1. Initialize Workflow Database
4
5 `docker run -d -e CS_AUTHENTICATE={CS_AUTHENTICATE} -e CS_HOST={HOST} -e CS_PORT={PORT} -e CS_USER={USER} 
6 -e CS_PASSWORD={PASSWORD} {INIT_IMAGE}`
7
8 This is done only once to initialize the DB schema.
9
10 **Example** 
11
12 running docker with secured Cassandra DB
13
14 `docker run -d -e CS_HOST=10.247.41.19 -e CS_AUTHENTICATE=true -e CS_USER=test -e CS_PASSWORD=secret -e CS_PORT=9160 
15 onap/workflow-init:latest`
16
17 running docker with unsecured Cassandra DB
18
19 `docker run -d -e CS_HOST=10.247.41.19 -e CS_AUTHENTICATE=false -e CS_PORT=9160 onap/workflow-init:latest`
20
21 or
22
23 `docker run -d -e CS_HOST=10.247.41.19 -e CS_PORT=9160 onap/workflow-init:latest`
24
25 ## 2. Start Backend
26
27 `docker run -d -e JAVA_OPTIONS={JAVA_OPTIONS} -e CS_HOSTS={COMMA_SEPARATED_HOSTS} -e CS_PORT={PORT} 
28 -e CS_USER={USER} -e CS_PASSWORD={PASSWORD} -p {HOST_PORT}:{APPLICATION_PORT} {BACKEND_IMAGE}`
29
30 or, if Cassandra authentication is not required
31
32 `docker run -d -e JAVA_OPTIONS={JAVA_OPTIONS} -e CS_HOSTS={COMMA_SEPARATED_HOSTS} -e CS_PORT={PORT} 
33 -e CS_AUTHENTICATE=false -p {HOST_PORT}:{APPLICATION_PORT} {BACKEND_IMAGE}`
34
35 The server listens on 8080 by default, but it is possible to change the application port by passing 
36 `-e SERVER_PORT={PORT}` to Docker _run_ command.
37
38 To check health information of application you can use option `-e SHOW_HEALTH={always}`
39
40 **Example**
41
42 `docker run -d -e JAVA_OPTIONS="-Xmx128m -Xms128m -Xss1m" -e CS_HOSTS=10.247.41.19,10.247.41.20 
43 -e CS_PORT=9042 -e CS_AUTHENTICATE=false -p 8080:8080 onap/workflow-backend:latest`