aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authormark.j.leonard <mark.j.leonard@gmail.com>2018-09-26 11:58:30 +0100
committermark.j.leonard <mark.j.leonard@gmail.com>2018-09-26 12:02:22 +0100
commit392d41cdfc989d08cf5b79ea9a20e1f82665b447 (patch)
tree146df533a232f12705ef0c59ab1bd10cabdb7b9d /README.md
parentecd35f117eb0118f9cbd96fe132a1c359214bfc7 (diff)
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>
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 12 insertions, 5 deletions
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