aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPriyanshu <pagarwal@amdocs.com>2019-02-27 08:36:28 +0530
committerpriyanshu <pagarwal@amdocs.com>2019-02-27 08:36:28 +0530
commitee0b26c61e4eb9251fb3a2fcc31fb276dcae7865 (patch)
treec2ba0fbf48559c7316e1e4482895232e9915bda0 /README.md
parenta51021d6021ca2168c4a4ac7b8959dea52fc8b51 (diff)
HTTPS support for workflow
1. Added support for both http and https on BE. 2. By default the HTTPS is not enabled. 3. Added some logging properties. 4. updated ReadMe. Change-Id: I5337b19d6fe5eeaf7ded47019dc6bd3fbdcca309 Issue-ID: SDC-2136 Signed-off-by: priyanshu <pagarwal@amdocs.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4a84a7a3..87b980cb 100644
--- a/README.md
+++ b/README.md
@@ -98,7 +98,8 @@ messages. You can also see the logs of the initialization container using `docke
`docker run -d -e SDC_PROTOCL=http/https -e SDC_ENDPOINT=<sdc-host>:<sdc-port> -e SDC_USER=<sdc-username>
-e SDC_PASSWORD=<sdc-password> -e CS_HOSTS=<cassandra-hosts> -e CS_PORT=<cassandra-port>
-e CS_AUTHENTICATE=true/false -e CS_USER=<cassandra-user> -e CS_PASSWORD=<cassandra-password>
--e JAVA_OPTIONS=<jvm-options> nexus3.onap.org:10001/onap/workflow-backend:latest`
+-e SSL_ENABLED=true/false -e SSL_KEY_PASSWORD=<ssl_key_password> -e SSL_KEYSTORE_PATH=<ssl_keystore_path>
+-e SSL_KEYSTORE_TYPE=<ssl_keystore_type> -e JAVA_OPTIONS=<jvm-options> nexus3.onap.org:10001/onap/workflow-backend:latest`
### Environment Variables
@@ -122,12 +123,21 @@ assumed if this variable is not specified.
- CS_PASSWORD &mdash; Cassandra password if CS_AUTHENTICATE is *true*.
+- SSL_ENABLED &mdash; whether ssl authentication must be used to connect to application. A *false* will be
+assumed if this variable is not specified.
+
+- SSL_KEY_PASSWORD &mdash; SSL key password if SSL_ENABLED is *true*.
+
+- SSL_KEYSTORE_PATH &mdash; SSL Keystore path if SSL_ENABLED is *true*.
+
+- SSL_KEYSTORE_TYPE &mdash; SSL Keystore type if SSL_ENABLED is *true*.
+
- JAVA_OPTIONS &mdash; optionally, JVM (Java Virtual Machine) arguments.
### Example
Assuming you have a dedicated Cassandra container as described in Database section, and the access to it is not
-protected with a password. The following command will start a backend container:
+protected with a password. The following command will start a backend container without SSL support:
`docker run -d --name workflow-backend -e SDC_PROTOCOL=http
-e SDC_ENDPOINT=$(docker inspect sdc-BE --format={{.NetworkSettings.IPAddress}}):8080