Fields discoveryServiceExposed and discoveryServiceListenerClass added to the CRD

Author: siegfriedweber

deploy/helm/opensearch-operator/crds/crds.yaml

@@ -246,6 +246,10 @@ spec:
                               type: object
                               x-kubernetes-preserve-unknown-fields: true
                           type: object
+                        discoveryServiceExposed:
+                          description: Determines whether this role group is exposed in the discovery service.
+                          nullable: true
+                          type: boolean
                         gracefulShutdownTimeout:
                           description: |-
                             Time period Pods have to gracefully shut down, e.g. `30m`, `1h` or `2d`. Consult the
@@ -520,11 +524,19 @@ spec:
                       x-kubernetes-preserve-unknown-fields: true
                     roleConfig:
                       default:
+                        discoveryServiceListenerClass: cluster-internal
                         podDisruptionBudget:
                           enabled: true
                           maxUnavailable: null
                       description: This is a product-agnostic RoleConfig, which is sufficient for most of the products.
                       properties:
+                        discoveryServiceListenerClass:
+                          default: cluster-internal
+                          description: The [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) that is used for the discovery service.
+                          maxLength: 253
+                          minLength: 1
+                          pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+                          type: string
                         podDisruptionBudget:
                           default:
                             enabled: true
@@ -603,6 +615,10 @@ spec:
                                     type: object
                                     x-kubernetes-preserve-unknown-fields: true
                                 type: object
+                              discoveryServiceExposed:
+                                description: Determines whether this role group is exposed in the discovery service.
+                                nullable: true
+                                type: boolean
                               gracefulShutdownTimeout:
                                 description: |-
                                   Time period Pods have to gracefully shut down, e.g. `30m`, `1h` or `2d`. Consult the

rust/operator-binary/src/controller.rs

@@ -20,7 +20,6 @@ use stackable_operator::{
     },
     kube::{Resource, api::ObjectMeta, core::DeserializeGuard, runtime::controller::Action},
     logging::controller::ReconcilerError,
-    role_utils::GenericRoleConfig,
     shared::time::Duration,
 };
 use strum::{EnumDiscriminants, IntoStaticStr};
@@ -168,7 +167,7 @@ pub struct ValidatedCluster {
     pub name: ClusterName,
     pub namespace: NamespaceName,
     pub uid: Uid,
-    pub role_config: GenericRoleConfig,
+    pub role_config: v1alpha1::OpenSearchRoleConfig,
     pub role_group_configs: BTreeMap<RoleGroupName, OpenSearchRoleGroupConfig>,
     pub tls_config: v1alpha1::OpenSearchTls,
     pub keystores: Vec<v1alpha1::OpenSearchKeystore>,
@@ -182,7 +181,7 @@ impl ValidatedCluster {
         name: ClusterName,
         namespace: NamespaceName,
         uid: impl Into<Uid>,
-        role_config: GenericRoleConfig,
+        role_config: v1alpha1::OpenSearchRoleConfig,
         role_group_configs: BTreeMap<RoleGroupName, OpenSearchRoleGroupConfig>,
         tls_config: v1alpha1::OpenSearchTls,
         keystores: Vec<v1alpha1::OpenSearchKeystore>,
@@ -382,7 +381,6 @@ mod tests {
         k8s_openapi::api::core::v1::PodTemplateSpec,
         kvp::LabelValue,
         product_logging::spec::AutomaticContainerLogConfig,
-        role_utils::GenericRoleConfig,
         shared::time::Duration,
     };
     use uuid::uuid;
@@ -475,7 +473,7 @@ mod tests {
             ClusterName::from_str_unsafe("my-opensearch"),
             NamespaceName::from_str_unsafe("default"),
             uuid!("e6ac237d-a6d4-43a1-8135-f36506110912"),
-            GenericRoleConfig::default(),
+            v1alpha1::OpenSearchRoleConfig::default(),
             [
                 (
                     RoleGroupName::from_str_unsafe("coordinating"),

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

@@ -67,7 +67,6 @@ mod tests {
         kube::Resource,
         kvp::LabelValue,
         product_logging::spec::AutomaticContainerLogConfig,
-        role_utils::GenericRoleConfig,
         shared::time::Duration,
     };
     use uuid::uuid;
@@ -175,7 +174,7 @@ mod tests {
             ClusterName::from_str_unsafe("my-opensearch"),
             NamespaceName::from_str_unsafe("default"),
             uuid!("e6ac237d-a6d4-43a1-8135-f36506110912"),
-            GenericRoleConfig::default(),
+            v1alpha1::OpenSearchRoleConfig::default(),
             [
                 (
                     RoleGroupName::from_str_unsafe("coordinating"),

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

@@ -436,7 +436,6 @@ mod tests {
         k8s_openapi::api::core::v1::PodTemplateSpec,
         kvp::LabelValue,
         product_logging::spec::AutomaticContainerLogConfig,
-        role_utils::GenericRoleConfig,
         shared::time::Duration,
     };
     use uuid::uuid;
@@ -532,7 +531,7 @@ mod tests {
             ClusterName::from_str_unsafe("my-opensearch-cluster"),
             NamespaceName::from_str_unsafe("default"),
             uuid!("0b1e30e6-326e-4c1a-868d-ad6598b49e8b"),
-            GenericRoleConfig::default(),
+            v1alpha1::OpenSearchRoleConfig::default(),
             [(
                 RoleGroupName::from_str_unsafe("default"),
                 role_group_config.clone(),

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

@@ -146,7 +146,7 @@ impl<'a> RoleBuilder<'a> {
 
     /// Builds a [`PodDisruptionBudget`] used by all role-groups
     pub fn build_pdb(&self) -> Option<PodDisruptionBudget> {
-        let pdb_config = &self.cluster.role_config.pod_disruption_budget;
+        let pdb_config = &self.cluster.role_config.common.pod_disruption_budget;
 
         if pdb_config.enabled {
             let max_unavailable = pdb_config
@@ -229,7 +229,6 @@ mod tests {
         k8s_openapi::api::core::v1::PodTemplateSpec,
         kvp::LabelValue,
         product_logging::spec::AutomaticContainerLogConfig,
-        role_utils::GenericRoleConfig,
         shared::time::Duration,
     };
     use uuid::uuid;
@@ -308,7 +307,7 @@ mod tests {
             ClusterName::from_str_unsafe("my-opensearch-cluster"),
             NamespaceName::from_str_unsafe("default"),
             uuid!("0b1e30e6-326e-4c1a-868d-ad6598b49e8b"),
-            GenericRoleConfig::default(),
+            v1alpha1::OpenSearchRoleConfig::default(),
             [(
                 RoleGroupName::from_str_unsafe("default"),
                 role_group_config.clone(),

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

@@ -822,7 +822,6 @@ mod tests {
         k8s_openapi::api::core::v1::PodTemplateSpec,
         kvp::LabelValue,
         product_logging::spec::AutomaticContainerLogConfig,
-        role_utils::GenericRoleConfig,
         shared::time::Duration,
     };
     use strum::IntoEnumIterator;
@@ -925,7 +924,7 @@ mod tests {
             ClusterName::from_str_unsafe("my-opensearch-cluster"),
             NamespaceName::from_str_unsafe("default"),
             uuid!("0b1e30e6-326e-4c1a-868d-ad6598b49e8b"),
-            GenericRoleConfig::default(),
+            v1alpha1::OpenSearchRoleConfig::default(),
             [(
                 RoleGroupName::from_str_unsafe("default"),
                 role_group_config.clone(),

rust/operator-binary/src/controller/validate.rs

@@ -279,7 +279,7 @@ mod tests {
             ContainerLogConfigChoiceFragment, ContainerLogConfigFragment,
             CustomContainerLogConfigFragment, LogLevel, LoggerConfig, LoggingFragment,
         },
-        role_utils::{CommonConfiguration, GenericRoleConfig, Role, RoleGroup},
+        role_utils::{CommonConfiguration, Role, RoleGroup},
         shared::time::Duration,
     };
     use uuid::uuid;
@@ -332,7 +332,7 @@ mod tests {
                 ClusterName::from_str_unsafe("my-opensearch"),
                 NamespaceName::from_str_unsafe("default"),
                 uuid!("e6ac237d-a6d4-43a1-8135-f36506110912"),
-                GenericRoleConfig::default(),
+                v1alpha1::OpenSearchRoleConfig::default(),
                 [(
                     RoleGroupName::from_str_unsafe("default"),
                     RoleGroupConfig {
@@ -764,7 +764,7 @@ mod tests {
                         product_specific_common_config: GenericProductSpecificCommonConfig::default(
                         ),
                     },
-                    role_config: GenericRoleConfig::default(),
+                    role_config: v1alpha1::OpenSearchRoleConfig::default(),
                     role_groups: [(
                         "default".to_owned(),
                         RoleGroup {

rust/operator-binary/src/crd/mod.rs

@@ -41,7 +41,8 @@ use crate::{
     },
 };
 
-constant!(DEFAULT_LISTENER_CLASS: ListenerClassName = "cluster-internal");
+constant!(DEFAULT_ROLE_GROUP_LISTENER_CLASS: ListenerClassName = "cluster-internal");
+constant!(DEFAULT_DISCOVERY_SERVICE_LISTENER_CLASS: ListenerClassName = "cluster-internal");
 constant!(TLS_DEFAULT_SECRET_CLASS: SecretClassName = "tls");
 
 #[versioned(
@@ -81,8 +82,11 @@ pub mod versioned {
         pub cluster_operation: ClusterOperation,
 
         // no doc - docs in Role struct
-        pub nodes:
-            Role<OpenSearchConfigFragment, GenericRoleConfig, GenericProductSpecificCommonConfig>,
+        pub nodes: Role<
+            OpenSearchConfigFragment,
+            OpenSearchRoleConfig,
+            GenericProductSpecificCommonConfig,
+        >,
     }
 
     #[derive(Clone, Debug, Default, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
@@ -202,6 +206,9 @@ pub mod versioned {
         #[fragment_attrs(serde(default))]
         pub affinity: StackableAffinity,
 
+        /// Determines whether this role group is exposed in the discovery service.
+        pub discovery_service_exposed: bool,
+
         /// Time period Pods have to gracefully shut down, e.g. `30m`, `1h` or `2d`. Consult the
         /// operator documentation for details.
         #[fragment_attrs(serde(default))]
@@ -277,6 +284,17 @@ pub mod versioned {
         pub data: PvcConfig,
     }
 
+    #[derive(Clone, Debug, Deserialize, JsonSchema, PartialEq, Serialize)]
+    #[serde(rename_all = "camelCase")]
+    pub struct OpenSearchRoleConfig {
+        #[serde(flatten)]
+        pub common: GenericRoleConfig,
+
+        /// The [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) that is used for the discovery service.
+        #[serde(default = "discovery_service_listener_class_default")]
+        pub discovery_service_listener_class: ListenerClassName,
+    }
+
     #[derive(Clone, Default, Debug, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
     #[serde(rename_all = "camelCase")]
     pub struct OpenSearchClusterStatus {
@@ -320,12 +338,13 @@ impl v1alpha1::OpenSearchConfig {
                 node_affinity: None,
                 node_selector: None,
             },
+            discovery_service_exposed: Some(true),
             // Default taken from the Helm chart, see
             // https://github.com/opensearch-project/helm-charts/blob/opensearch-3.0.0/charts/opensearch/values.yaml#L364
             graceful_shutdown_timeout: Some(
                 Duration::from_str("2m").expect("should be a valid duration"),
             ),
-            listener_class: Some(DEFAULT_LISTENER_CLASS.to_owned()),
+            listener_class: Some(DEFAULT_ROLE_GROUP_LISTENER_CLASS.to_owned()),
             logging: product_logging::spec::default_logging(),
             // Defaults taken from the Helm chart, see
             // https://github.com/opensearch-project/helm-charts/blob/opensearch-3.0.0/charts/opensearch/values.yaml#L16-L20
@@ -384,6 +403,19 @@ fn internal_secret_class_default() -> SecretClassName {
     TLS_DEFAULT_SECRET_CLASS.to_owned()
 }
 
+impl Default for v1alpha1::OpenSearchRoleConfig {
+    fn default() -> Self {
+        v1alpha1::OpenSearchRoleConfig {
+            common: GenericRoleConfig::default(),
+            discovery_service_listener_class: discovery_service_listener_class_default(),
+        }
+    }
+}
+
+fn discovery_service_listener_class_default() -> ListenerClassName {
+    DEFAULT_DISCOVERY_SERVICE_LISTENER_CLASS.to_owned()
+}
+
 #[derive(Clone, Debug, Default, Deserialize, JsonSchema, PartialEq, Serialize)]
 pub struct NodeRoles(pub Vec<v1alpha1::NodeRole>);