Allow to configure the Elasticsearch connection in environment variables (#8585)

* Allow to configure the Elasticsearch connection in environment variables

* Allow to configure the Elasticsearch connection in environment variables - documentation updates

* remove es.url and use the components instead (#111)

Co-authored-by: david.blasby <david.blasby@geocat.net>

---------

Co-authored-by: davidblasby <48937730+davidblasby@users.noreply.github.com>
Co-authored-by: david.blasby <david.blasby@geocat.net>

Author: 3 people

core/src/test/resources/WEB-INF/config.properties

@@ -8,7 +8,7 @@ usersavedselection.watchlist.searchurl=catalog.search#/search?_uuid={{filter}}
 usersavedselection.watchlist.recordurl=api/records/{{index:uuid}}
 
 
-es.url=http://localhost:9200
+
 es.port=9200
 es.host=localhost
 es.protocol=http

docs/manual/docs/install-guide/installing-index.md

@@ -108,15 +108,32 @@ Older version may be supported but are untested.
 
 ## Configure GeoNetwork connection to Elasticsearch
 
-1. Update Elasticsearch connection details in ```WEB-INF/config.properties```:
-    
-    ``` properties
-    es.protocol=http
-    es.port=9200
-    es.host=localhost
-    es.url=${es.protocol}://${es.host}:${es.port}
-    es.username=
-    es.password=
-    ```
+By default, GeoNetwork expects Elasticsearch to be running at <http://localhost:9200> without authentication. If your Elasticsearch server is on a different host or port or requires authentication, you will need to configure connection details using either of these methods:
+
+* Define the connection details in Java properties.
+
+  ```shell
+  export JAVA_OPTS="$JAVA_OPTS -Des.protocol=http -Des.port=9200 -Des.host=localhost  -Des.protocol=http -Des.username= -Des.password="
+  ```
+
+* Define the connection details in environment variables.
+
+  ```shell
+  export GEONETWORK_ES_HOST=localhost
+  export GEONETWORK_ES_PROTOCOL=http
+  export GEONETWORK_ES_PORT=9200
+  export GEONETWORK_ES_USERNAME=
+  export GEONETWORK_ES_PASSWORD=
+  ```
+
+* Edit the values in ```WEB-INF/config.properties``` (not recommended):
+
+  ```properties
+  es.protocol=#{systemEnvironment['GEONETWORK_ES_PROTOCOL']?:'http'}
+  es.port=#{systemEnvironment['GEONETWORK_ES_PORT']?:9200}
+  es.host=#{systemEnvironment['GEONETWORK_ES_HOST']?:'localhost'}
+  es.username=#{systemEnvironment['GEONETWORK_ES_USERNAME']?:''}
+  es.password=#{systemEnvironment['GEONETWORK_ES_PASSWORD']?:''}
+  ```
 
-2.  Restart the application:
+Once the configuration is complete, you will need to restart the application.

docs/manual/docs/tutorials/introduction/deployment/deploy.md

@@ -30,7 +30,9 @@ Once you have Tomcat installed on your system, locate the webapps folder and pla
 Open the file /geonetwork/WEB-INF/config.properties and alter the elasticsearch connection
 
 ``` bash
-$ es.url=http://localhost:9200
+es.protocol=http
+es.host=localhost
+es.port=9200
 ```
 
 Then (re)start Jetty/Tomcat.

harvesters/src/test/resources/WEB-INF/config.properties

@@ -7,7 +7,6 @@ usersavedselection.watchlist.searchurl=catalog.search#/search?_uuid={{filter}}
 # Define the link to each record sent by email by the watchlist notifier
 usersavedselection.watchlist.recordurl=api/records/{{index:uuid}}
 
-es.url=http://localhost:9200
 es.port=9200
 es.host=localhost
 es.protocol=http

index/src/main/java/org/fao/geonet/index/es/EsRestClient.java

@@ -81,7 +81,7 @@ public class EsRestClient implements InitializingBean {
 
     private ElasticsearchAsyncClient asyncClient;
 
-    @Value("${es.url}")
+
     private String serverUrl;
 
     @Value("${es.protocol}")
@@ -127,10 +127,18 @@ public void setDashboardAppUrl(String dashboardAppUrl) {
 
     @Override
     public void afterPropertiesSet() throws Exception {
+        if (StringUtils.isBlank(serverProtocol) || StringUtils.isBlank(serverHost) || StringUtils.isBlank(serverPort)) {
+            Log.error("geonetwork.index", String.format(
+                "Elasticsearch URL defined by serverProtocol='%s', serverHost='%s', serverPort='%s' is missing. "
+                    + "Check configuration.", this.serverProtocol,this.serverHost,this.serverPort));
+        }
+
+        //build server URL
+        serverUrl = serverProtocol + "://" + serverHost + ":" + serverPort;
         if (StringUtils.isNotEmpty(serverUrl)) {
             RestClientBuilder builder = RestClient.builder(new HttpHost(serverHost, Integer.parseInt(serverPort), serverProtocol));
 
-            if (serverUrl.startsWith("https://")) {
+            if (serverProtocol.startsWith("https")) {
                 SSLContext sslContext = new SSLContextBuilder().loadTrustMaterial(
                     null, new TrustStrategy() {
                         public boolean isTrusted(X509Certificate[] arg0, String arg1) throws CertificateException {

pom.xml

@@ -1604,7 +1604,6 @@
     <es.protocol>http</es.protocol>
     <es.port>9200</es.port>
     <es.host>localhost</es.host>
-    <es.url>${es.protocol}://${es.host}:${es.port}</es.url>
     <es.index.features>gn-features</es.index.features>
     <es.index.features.type>features</es.index.features.type>
     <es.index.records>gn-records</es.index.records>

schemas-test/src/main/webapp/WEB-INF/config.properties

@@ -7,8 +7,9 @@ usersavedselection.watchlist.searchurl=catalog.search#/search?_uuid={{filter}}
 # Define the link to each record sent by email by the watchlist notifier
 usersavedselection.watchlist.recordurl=api/records/{{index:uuid}}
 
-
-es.url=http://localhost:9200
+es.protocol=http
+es.host=localhost
+es.port=9200
 es.index.features=features
 es.index.records=records
 es.index.searchlogs=searchlogs

services/src/main/webapp/WEB-INF/config.properties

@@ -7,8 +7,9 @@ usersavedselection.watchlist.searchurl=catalog.search#/search?_uuid={{filter}}
 # Define the link to each record sent by email by the watchlist notifier
 usersavedselection.watchlist.recordurl=api/records/{{index:uuid}}
 
+es.protocol=http
+es.host=localhost
 es.port=9200
-es.url=http://localhost:9200
 es.index.features=features
 es.index.records=records
 es.index.searchlogs=searchlogs

services/src/test/resources/WEB-INF/config.properties

@@ -7,8 +7,7 @@ usersavedselection.watchlist.searchurl=catalog.search#/search?_uuid={{filter}}
 # Define the link to each record sent by email by the watchlist notifier
 usersavedselection.watchlist.recordurl=api/records/{{index:uuid}}
 
-es.url=http://localhost:9200
-es.port=9200
+ es.port=9200
 es.host=localhost
 es.protocol=http
 es.index.features=features

web/src/main/webResources/WEB-INF/config.properties

@@ -11,12 +11,11 @@ usersavedselection.watchlist.searchurl=catalog.search#/search?_uuid={{filter}}
 # Define the link to each record sent by email by the watchlist notifier
 usersavedselection.watchlist.recordurl=api/records/{{index:uuid}}
 
-es.protocol=${es.protocol}
-es.port=${es.port}
-es.host=${es.host}
-es.url=\${es.protocol}://\${es.host}:\${es.port}
-es.username=${es.username}
-es.password=${es.password}
+es.protocol=#{systemEnvironment['GEONETWORK_ES_PROTOCOL']?:'${es.protocol}'}
+es.port=#{systemEnvironment['GEONETWORK_ES_PORT']?:${es.port}}
+es.host=#{systemEnvironment['GEONETWORK_ES_HOST']?:'${es.host}'}
+es.username=#{systemEnvironment['GEONETWORK_ES_USERNAME']?:'${es.username}'}
+es.password=#{systemEnvironment['GEONETWORK_ES_PASSWORD']?:'${es.password}'}
 es.index.features=${es.index.features}
 es.index.features.type=${es.index.features.type}
 # Define the number of decimals to apply when converting geometries to GeoJSON
@@ -33,7 +32,7 @@ es.index.records_public=${es.index.records_public}
 es.index.searchlogs=${es.index.searchlogs}
 es.index.searchlogs.type=${es.index.searchlogs.type}
 
-kb.url=${kb.url}
+kb.url=#{systemEnvironment['GEONETWORK_KIBANA_URL']?:'${kb.url}'}
 
 es.index.checker.interval=0/5 * * * * ?