X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=README.md;h=ae2127d24d9c8ec0271c5bb1551818aa495bd323;hb=707cbaec2a5147b60732d7ea6ff0f557202b3fc0;hp=f3f1c735df701d18822ab0bd5b07482ff1702f38;hpb=e45435883fde7858068ae42bbafdbdad37e5e0bf;p=aai%2Fsearch-data-service.git

diff --git a/README.md b/README.md
index f3f1c73..ae2127d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # Search Data Service Micro Service
 
+[![alt text](https://bestpractices.coreinfrastructure.org/projects/1737/badge)](https://bestpractices.coreinfrastructure.org/projects/1737)
+
 ## Overview
 The _Search Data Service_ acts as an abstraction layer for clients which have a need to interact with data which is most suitably persisted in a searchable document store.  The purpose of imposing an abstraction service between the client and the document store itself is to decouple clients from any direct knowledge of any specific document store technology, allowing the underlying technology to be swapped out without a direct impact to any clients which interact with search data.
 
@@ -98,13 +100,20 @@ Create this file with exactly the contents below:
     
 _elastic-search.properties_
 
-This file tells the _Search Data Service_ how to communicate with the ElasticSearch data store which it will use for its back end.
+This properties file configures the _Search Data Service_ for communication with ElasticSearch.
 The contents of this file will be determined by your ElasticSearch deployment:
 
-    es-cluster-name=<<name of your ElasticSearch cluster>>
-    es-ip-address=<<ip address of your ElasticSearch instance>>
-    ex.http-port=9200
-    
+    es.cluster-name=<<name of your ElasticSearch cluster>>
+    es.ip-address=<<IP address of your ElasticSearch instance>>
+    es.http-port=9200
+    # Optional parameters
+    es.uri-scheme=<<either http or https>>
+    es.trust-store=<<key store containing the certs of trusted servers>>
+    es.trust-store-password=<<encrypted passsword to open the trust store>>
+    es.key-store=<<key store containing the client cert>>
+    es.key-store-password=<<encrypted passsword to open the client key store>>
+    es.auth-user=<<username for HTTP Basic Authentication>>
+    es.auth-password=<<encrypted passsword for HTTP Basic Authentication>>
 
 
 ##### Contents of the /opt/app/search-data-service/app-config/auth Directory