feat: Add OPENSEARCH_HOSTS to discovery ConfigMap

Author: siegfriedweber

CHANGELOG.md

@@ -19,8 +19,8 @@ All notable changes to this project will be documented in this file.
   - Discovery service named `<cluster-name>`, added.
     The discovery service is used to populate the discovery ConfigMap.
   - Discovery ConfigMap named `<cluster-name>`, added.
-    The ConfigMap contains the keys `OPENSEARCH_HOST`, `OPENSEARCH_PORT` and `OPENSEARCH_PROTOCOL`.
-    Users should use this information to connect to the cluster.
+    The ConfigMap contains the keys `OPENSEARCH_HOSTNAME`, `OPENSEARCH_PORT`, `OPENSEARCH_PROTOCOL`
+    and `OPENSEARCH_HOSTS`. Users should use this information to connect to the cluster.
   - Configuration parameter `spec.nodes.roleConfig.discoveryServiceListenerClass` added to set the
     ListenerClass for the discovery service.
   - Configuration parameter `spec.nodes.roleGroups.<role-group-name>.config.discoveryServiceExposed`

docs/modules/opensearch/pages/reference/discovery.adoc

@@ -1,6 +1,9 @@
 :clusterName: simple-opensearch
 :namespace: stackable
-:discoveryServiceListenerClass: external-stable
+:exampleDiscoveryServiceListenerClass: external-unstable
+:exampleOpensearchProtocol: https
+:exampleOpensearchIp: 10.104.213.49
+:exampleOpensearchPort: 31315
 
 = Discovery
 :page-aliases: discovery.adoc
@@ -27,7 +30,7 @@ spec:
       serverSecretClass: tls # <3>
   nodes:
     roleConfig:
-      discoveryServiceListenerClass: {discoveryServiceListenerClass} # <4>
+      discoveryServiceListenerClass: {exampleDiscoveryServiceListenerClass} # <4>
     roleGroups:
       cluster-manager:
         config:
@@ -55,7 +58,7 @@ The resulting discovery ConfigMap is `{namespace}/{clusterName}`.
 
 The `{namespace}/{clusterName}` discovery ConfigMap contains the following fields where `{clusterName}` represents the name and `{namespace}` the namespace of the cluster:
 
-`OPENSEARCH_HOST`::
+`OPENSEARCH_HOSTNAME`::
 ====
 Contains the hostname or IP of the service that references the exposed role groups.
 
@@ -64,9 +67,10 @@ In case, `discoveryServiceListenerClass` was set to `cluster-internal`, the foll
 [subs="normal"]
   {clusterName}.{namespace}.svc.cluster.local
 
-If `discoveryServiceListenerClass` was set to `external-stable`, the content could look like:
+If `discoveryServiceListenerClass` was set to `{exampleDiscoveryServiceListenerClass}`, the content could look like:
 
-  10.104.213.49
+[subs="normal"]
+  {exampleOpensearchIp}
 ====
 
 `OPENSEARCH_PORT`::
@@ -75,12 +79,22 @@ Contains the port of the service that references the exposed role groups.
 
 Depending on the `discoveryServiceListenerClass`, the port will be either the default HTTP port 9200 or a NodePort:
 
-  31315
+[subs="normal"]
+  {exampleOpensearchPort}
 ====
 
 `OPENSEARCH_PROTOCOL`::
 ====
 Contains either `http` or `https`, depending on whether a `serverSecretClass` is configured:
 
-  https
+[subs="normal"]
+  {exampleOpensearchProtocol}
+====
+
+`OPENSEARCH_HOSTS`::
+====
+Contains the URL of the service that references the exposed role groups.
+
+[subs="normal"]
+  {exampleOpensearchProtocol}://{exampleOpensearchIp}:{exampleOpensearchPort}
 ====

rust/operator-binary/src/controller/build/role_builder.rs

@@ -171,23 +171,30 @@ impl<'a> RoleBuilder<'a> {
 
         let metadata = self.common_metadata(discovery_config_map_name(&self.cluster.name));
 
+        let protocol = if self.cluster.tls_config.server_secret_class.is_some() {
+            "https"
+        } else {
+            "http"
+        };
+
         let data = [
+            ("OPENSEARCH_PROTOCOL".to_owned(), protocol.to_owned()),
             (
-                "OPENSEARCH_PROTOCOL".to_owned(),
-                if self.cluster.tls_config.server_secret_class.is_some() {
-                    "https".to_owned()
-                } else {
-                    "http".to_owned()
-                },
-            ),
-            (
-                "OPENSEARCH_HOST".to_owned(),
+                "OPENSEARCH_HOSTNAME".to_owned(),
                 discovery_endpoint.hostname.to_string(),
             ),
             (
                 "OPENSEARCH_PORT".to_owned(),
                 discovery_endpoint.port.to_string(),
             ),
+            (
+                "OPENSEARCH_HOSTS".to_owned(),
+                format!(
+                    "{protocol}://{hostname}:{port}",
+                    hostname = discovery_endpoint.hostname,
+                    port = discovery_endpoint.port
+                ),
+            ),
         ];
 
         Some(ConfigMap {
@@ -661,9 +668,10 @@ mod tests {
                     ],
                 },
                 "data": {
-                    "OPENSEARCH_HOST": "1.2.3.4",
+                    "OPENSEARCH_HOSTNAME": "1.2.3.4",
                     "OPENSEARCH_PORT": "12345",
                     "OPENSEARCH_PROTOCOL": "https",
+                    "OPENSEARCH_HOSTS": "https://1.2.3.4:12345",
                 },
             }),
             discovery_config_map

tests/templates/kuttl/backup-restore/22-create-testuser.yaml

@@ -65,7 +65,7 @@ data:
     from opensearchpy import OpenSearch
     from opensearchpy.exceptions import RequestError
 
-    host = os.environ['OPENSEARCH_HOST']
+    host = os.environ['OPENSEARCH_HOSTNAME']
     port = os.environ['OPENSEARCH_PORT']
     http_use_tls = os.environ['OPENSEARCH_PROTOCOL'] == 'https'
 

tests/templates/kuttl/backup-restore/23-create-data.yaml

@@ -65,7 +65,7 @@ data:
     from opensearchpy import OpenSearch
     from opensearchpy.exceptions import RequestError
 
-    host = os.environ['OPENSEARCH_HOST']
+    host = os.environ['OPENSEARCH_HOSTNAME']
     port = os.environ['OPENSEARCH_PORT']
     http_use_tls = os.environ['OPENSEARCH_PROTOCOL'] == 'https'
 

tests/templates/kuttl/backup-restore/30-create-snapshot.yaml

@@ -65,7 +65,7 @@ data:
     from opensearchpy import OpenSearch
     from opensearchpy.exceptions import RequestError
 
-    host = os.environ['OPENSEARCH_HOST']
+    host = os.environ['OPENSEARCH_HOSTNAME']
     port = os.environ['OPENSEARCH_PORT']
     http_use_tls = os.environ['OPENSEARCH_PROTOCOL'] == 'https'
 

tests/templates/kuttl/backup-restore/31-backup-security-indices.yaml.j2

@@ -129,7 +129,7 @@ data:
         -cacert config/tls/ca.crt \
         -cert config/tls-client/tls.crt \
         -key config/tls-client/tls.key \
-        --hostname $OPENSEARCH_HOST \
+        --hostname $OPENSEARCH_HOSTNAME \
         -backup /tmp/backup
   upload-security-indices-backup.sh: |
     #!/usr/bin/env sh

tests/templates/kuttl/backup-restore/60-restore-security-indices.yaml.j2

@@ -139,5 +139,5 @@ data:
         -cacert config/tls/ca.crt \
         -cert config/tls-client/tls.crt \
         -key config/tls-client/tls.key \
-        --hostname $OPENSEARCH_HOST \
+        --hostname $OPENSEARCH_HOSTNAME \
         --configdir /tmp/backup

tests/templates/kuttl/backup-restore/61-restore-snapshot.yaml

@@ -65,7 +65,7 @@ data:
     from opensearchpy import OpenSearch
     from opensearchpy.exceptions import RequestError
 
-    host = os.environ['OPENSEARCH_HOST']
+    host = os.environ['OPENSEARCH_HOSTNAME']
     port = os.environ['OPENSEARCH_PORT']
     http_use_tls = os.environ['OPENSEARCH_PROTOCOL'] == 'https'
 

tests/templates/kuttl/backup-restore/70-test-opensearch-2.yaml

@@ -65,7 +65,7 @@ data:
     from opensearchpy import OpenSearch
     from opensearchpy.exceptions import RequestError
 
-    host = os.environ['OPENSEARCH_HOST']
+    host = os.environ['OPENSEARCH_HOSTNAME']
     port = os.environ['OPENSEARCH_PORT']
     http_use_tls = os.environ['OPENSEARCH_PROTOCOL'] == 'https'