Removed healthcheck config from README 09/71209/1
authorvempo <vitaliy.emporopulo@amdocs.com>
Tue, 23 Oct 2018 08:57:12 +0000 (11:57 +0300)
committervempo <vitaliy.emporopulo@amdocs.com>
Tue, 23 Oct 2018 09:16:42 +0000 (12:16 +0300)
Minor improvements, proofreading.

Change-Id: I89be90ca9e69fc71771a651edd3010bd2c252213
Issue-ID: SDC-1743
Signed-off-by: vempo <vitaliy.emporopulo@amdocs.com>
README.md

index 1efb90d..0e4a722 100644 (file)
--- a/README.md
+++ b/README.md
@@ -85,13 +85,13 @@ You can also see the logs of the initialization container using `docker logs wor
 `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> -e SHOW_HEALTH=<heathcheck-mode> nexus3.onap.org:10001/onap/workflow-backend:latest`
+-e JAVA_OPTIONS=<jvm-options> nexus3.onap.org:10001/onap/workflow-backend:latest`
 
 ### Environment Variables
 
 - SDC_PROTOCOL &mdash; protocol to be used for calling SDC APIs (http or https).
 
-- SDC_ENDPOINT &mdash; the base path of SDC external API, in the format  ="10.247.41.20:8080" 
+- SDC_ENDPOINT &mdash; the base path of SDC external API, in the format `host:port`, where *host* is a SDC backend server, and *port* is usually 8080.
 
 - SDC_USER &mdash; Workflow consumer username 
 
@@ -110,10 +110,6 @@ assumed if this variable is not specified.
 
 - JAVA_OPTIONS &mdash; optionally, JVM (Java Virtual Machine) arguments.
 
-- SHOW_HEALTH &mdash; how health information will be exposed, as documented in 
-[Spring Boot](https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-endpoints.html#production-ready-health) documentation.
-The default for Workflow designer is *always*.
-
 ### Example
 
 Assuming you have a dedicated Cassandra container as described in Database section, and the access to it is not 
@@ -194,10 +190,12 @@ Let's assume that hostname of the machine that runs Docker containers with the W
 section of *AUTO.json* will look like below:
 
 ```
+
 "Plugins": {
     "WORKFLOW": {
         "workflow_discovery_url": "http://workflow.example.com:9088/ping",
         "workflow_source_url": "http://workflow.example.com:9088"
     }
 },
+
 ```