add api integration and add review comments

Issue-ID: SDC-1562
Change-Id: I0aa3a099f3a36da9e8493708b8bfe52e5f991885
Signed-off-by: Yarin Dekel <yarind@amdocs.com>
25 files changed
tree: 2fdf791a2a594af4a5a2c98b2a9bfd2830cd1a0a
  1. deprecated-workflow-designer/
  2. workflow-bdd/
  3. workflow-designer-be/
  4. workflow-designer-init/
  5. workflow-designer-ui/
  6. .gitignore
  7. .gitreview
  8. INFO.yaml
  9. LICENSE.txt
  10. pom.xml
  11. README.md
  12. version.properties
README.md

Steps to run the Workflow application on Docker

1. Initialize Workflow Database

docker run -d -e CS_AUTHENTICATE={CS_AUTHENTICATE} -e CS_HOST={HOST} -e CS_PORT={PORT} -e CS_USER={USER} -e CS_PASSWORD={PASSWORD} {INIT_IMAGE}

This is done only once to initialize the DB schema.

Example

running docker with secured Cassandra DB

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 onap/workflow-init:latest

running docker with unsecured Cassandra DB

docker run -d -e CS_HOST=10.247.41.19 -e CS_AUTHENTICATE=false -e CS_PORT=9160 onap/workflow-init:latest

or

docker run -d -e CS_HOST=10.247.41.19 -e CS_PORT=9160 onap/workflow-init:latest

2. Start Backend

docker run -d -e JAVA_OPTIONS={JAVA_OPTIONS} -e CS_HOSTS={COMMA_SEPARATED_HOSTS} -e CS_PORT={PORT} -e CS_USER={USER} -e CS_PASSWORD={PASSWORD} -p {HOST_PORT}:{APPLICATION_PORT} {BACKEND_IMAGE}

or, if Cassandra authentication is not required

docker run -d -e JAVA_OPTIONS={JAVA_OPTIONS} -e CS_HOSTS={COMMA_SEPARATED_HOSTS} -e CS_PORT={PORT} -e CS_AUTHENTICATE=false -p {HOST_PORT}:{APPLICATION_PORT} {BACKEND_IMAGE}

The server listens on 8080 by default, but it is possible to change the application port by passing -e SERVER_PORT={PORT} to Docker run command.

Example

docker run -d -e JAVA_OPTIONS="-Xmx128m -Xms128m -Xss1m" -e CS_HOSTS=10.247.41.19,10.247.41.20 -e CS_PORT=9042 -e CS_AUTHENTICATE=false -p 8080:8080 onap/workflow-backend:latest