aboutsummaryrefslogtreecommitdiffstats
path: root/workflow/README.md
diff options
context:
space:
mode:
authorpriyanshu <pagarwal@amdocs.com>2018-07-16 19:25:05 +0530
committerpriyanshu <pagarwal@amdocs.com>2018-07-16 19:25:07 +0530
commit7e78cd19bbb2b0730fafc0b328a71c69f5730e16 (patch)
tree24b4b72ef67f64304bfee867076517c37896db5b /workflow/README.md
parent39c01dd3ccb69f53d2e9350994e25f6e64412aa4 (diff)
Workflow Docker containers
1. Implemented workflow init container. 2. Implemented workflow backend container. 3. Added a placeholder for frontend module container. 4. Modifiled directory structure and POM files. 5. Added a ReadMe with sample commands to detail how to run the containers. Change-Id: Ib110fcc104ce72ff28fce514a1475a032cc2d82b Issue-ID: SDC-1482 Signed-off-by: priyanshu <pagarwal@amdocs.com> Signed-off-by: vempo <vitaliy.emporopulo@amdocs.com> Signed-off-by: priyanshu <pagarwal@amdocs.com>
Diffstat (limited to 'workflow/README.md')
-rw-r--r--workflow/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/workflow/README.md b/workflow/README.md
new file mode 100644
index 00000000..40b4bbb2
--- /dev/null
+++ b/workflow/README.md
@@ -0,0 +1,29 @@
+# Steps to run the Workflow application on Docker
+
+## 1. Initialize Workflow Database
+
+`docker run -d -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**
+
+`docker run -d -e CS_HOST=10.247.41.19 -e CS_USER=test -e CS_PASSWORD=secret -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` \ No newline at end of file