From 392d41cdfc989d08cf5b79ea9a20e1f82665b447 Mon Sep 17 00:00:00 2001
From: "mark.j.leonard" <mark.j.leonard@gmail.com>
Date: Wed, 26 Sep 2018 11:58:30 +0100
Subject: Implement client authentication to ElasticSearch

Add configuration to the existing Elastic Search properties to allow
Basic Authentication and/or TLS (SSL) connectivity using HTTPS.

The new configuration is optional and this commit is intended to be
backwards compatible with existing deployments.

Change-Id: I19ec3da9ff810c3f6eabd6f5faf71adde182c861
Issue-ID: AAI-1650
Signed-off-by: mark.j.leonard <mark.j.leonard@gmail.com>
---
 README.md | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 506cc05..ae2127d 100644
--- a/README.md
+++ b/README.md
@@ -100,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
-- 
cgit 1.2.3-korg