fix: use builder pattern for discovery configmap

Author: maltesander

rust/operator-binary/src/discovery.rs …binary/src/controller/build/discovery.rsrust/operator-binary/src/discovery.rs renamed to rust/operator-binary/src/controller/build/discovery.rs rust/operator-binary/src/discovery.rs renamed to rust/operator-binary/src/controller/build/discovery.rs

@@ -1,20 +1,19 @@
+//! Build the discovery `ConfigMap` for the HbaseCluster.
+
 use std::collections::BTreeMap;
 
 use snafu::{ResultExt, Snafu};
 use stackable_operator::{
     builder::{configmap::ConfigMapBuilder, meta::ObjectMetaBuilder},
-    commons::product_image_selection::ResolvedProductImage,
     k8s_openapi::api::core::v1::ConfigMap,
     kube::runtime::reflector::ObjectRef,
-    utils::cluster_info::KubernetesClusterInfo,
 };
 
 use crate::{
     config::writer::to_hadoop_xml,
-    crd::{HBASE_SITE_XML, HbaseRole, v1alpha1},
-    hbase_controller::build_recommended_labels,
-    kerberos::{self, kerberos_discovery_config_properties},
-    zookeeper::ZookeeperConnectionInformation,
+    controller::build::properties::ConfigFileName,
+    crd::{HbaseRole, v1alpha1},
+    hbase_controller::{ValidatedCluster, build_recommended_labels},
 };
 
 type Result<T, E = Error> = std::result::Result<T, E>;
@@ -36,43 +35,42 @@ pub enum Error {
     ObjectMeta {
         source: stackable_operator::builder::meta::Error,
     },
-
-    #[snafu(display("failed to add Kerberos discovery"))]
-    AddKerberosDiscovery { source: kerberos::Error },
 }
 
 /// Creates a discovery config map containing the `hbase-site.xml` for clients.
-pub fn build_discovery_configmap(
-    hbase: &v1alpha1::HbaseCluster,
-    cluster_info: &KubernetesClusterInfo,
-    zookeeper_connection_information: &ZookeeperConnectionInformation,
-    resolved_product_image: &ResolvedProductImage,
+///
+/// The rendered content comes entirely from `cluster`; `owner_ref` is retained only for the
+/// ConfigMap ObjectMeta / owner reference.
+pub fn build_discovery_config_map(
+    cluster: &ValidatedCluster,
+    owner_ref: &v1alpha1::HbaseCluster,
 ) -> Result<ConfigMap> {
-    let mut hbase_site = zookeeper_connection_information.as_hbase_settings();
-    hbase_site.extend(
-        kerberos_discovery_config_properties(hbase, cluster_info)
-            .context(AddKerberosDiscoverySnafu)?,
-    );
+    let cluster_config = &cluster.cluster_config;
+
+    let mut hbase_site = cluster_config
+        .zookeeper_connection_information
+        .as_hbase_settings();
+    hbase_site.extend(cluster_config.discovery_kerberos_config.clone());
 
     ConfigMapBuilder::new()
         .metadata(
             ObjectMetaBuilder::new()
-                .name_and_namespace(hbase)
-                .ownerreference_from_resource(hbase, None, Some(true))
+                .name_and_namespace(owner_ref)
+                .ownerreference_from_resource(owner_ref, None, Some(true))
                 .with_context(|_| ObjectMissingMetadataForOwnerRefSnafu {
-                    hbase: ObjectRef::from_obj(hbase),
+                    hbase: ObjectRef::from_obj(owner_ref),
                 })?
                 .with_recommended_labels(&build_recommended_labels(
-                    hbase,
-                    &resolved_product_image.app_version_label_value,
+                    owner_ref,
+                    &cluster.image.app_version_label_value,
                     &HbaseRole::RegionServer.to_string(),
                     "discovery",
                 ))
                 .context(ObjectMetaSnafu)?
                 .build(),
         )
         .add_data(
-            HBASE_SITE_XML,
+            ConfigFileName::HbaseSite.to_string(),
             to_hadoop_xml(
                 hbase_site
                     .into_iter()

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

@@ -1,2 +1,3 @@
 pub mod config_map;
+pub mod discovery;
 pub mod properties;

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

@@ -20,8 +20,8 @@ use crate::{
         ValidatedRoleGroupConfig,
     },
     kerberos::{
-        self, kerberos_config_properties, kerberos_ssl_client_settings,
-        kerberos_ssl_server_settings,
+        self, kerberos_config_properties, kerberos_discovery_config_properties,
+        kerberos_ssl_client_settings, kerberos_ssl_server_settings,
     },
 };
 
@@ -124,6 +124,8 @@ pub fn validate_cluster(
 
     let hbase_site_kerberos_config =
         kerberos_config_properties(hbase, cluster_info).context(AddKerberosConfigSnafu)?;
+    let discovery_kerberos_config = kerberos_discovery_config_properties(hbase, cluster_info)
+        .context(AddKerberosConfigSnafu)?;
     let ssl_server_settings = kerberos_ssl_server_settings(hbase);
     let ssl_client_settings = kerberos_ssl_client_settings(hbase);
 
@@ -135,6 +137,7 @@ pub fn validate_cluster(
             hbase_opa_config: dereferenced_objects.hbase_opa_config,
             kerberos_enabled: hbase.has_kerberos_enabled(),
             hbase_site_kerberos_config,
+            discovery_kerberos_config,
             ssl_server_settings,
             ssl_client_settings,
         },

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

@@ -58,8 +58,6 @@ pub const TLS_STORE_PASSWORD: &str = "changeit";
 
 pub const JVM_SECURITY_PROPERTIES_FILE: &str = "security.properties";
 
-pub const HBASE_SITE_XML: &str = "hbase-site.xml";
-
 pub const HBASE_CLUSTER_DISTRIBUTED: &str = "hbase.cluster.distributed";
 pub const HBASE_ROOTDIR: &str = "hbase.rootdir";
 

rust/operator-binary/src/hbase_controller.rs

@@ -56,11 +56,11 @@ use strum::{EnumDiscriminants, IntoStaticStr};
 
 use crate::{
     OPERATOR_NAME,
+    controller::build::discovery::build_discovery_config_map,
     crd::{
         APP_NAME, AnyServiceConfig, CONFIG_DIR_NAME, Container, HbaseClusterStatus, HbaseRole,
         LISTENER_VOLUME_DIR, LISTENER_VOLUME_NAME, merged_env, v1alpha1,
     },
-    discovery::build_discovery_configmap,
     kerberos::{self, add_kerberos_pod_config},
     operations::{graceful_shutdown::add_graceful_shutdown_config, pdb::add_pdbs},
     product_logging::{CONTAINERDEBUG_LOG_DIRECTORY, STACKABLE_LOG_DIR},
@@ -110,6 +110,9 @@ pub struct ValidatedClusterConfig {
     pub kerberos_enabled: bool,
     /// Pre-resolved kerberos properties for hbase-site.xml (empty when kerberos is disabled).
     pub hbase_site_kerberos_config: BTreeMap<String, String>,
+    /// Pre-resolved kerberos properties for the discovery `hbase-site.xml` exposed to clients
+    /// (empty when kerberos is disabled).
+    pub discovery_kerberos_config: BTreeMap<String, String>,
     /// Pre-resolved ssl-server.xml settings (empty when HTTPS is disabled).
     pub ssl_server_settings: BTreeMap<String, String>,
     /// Pre-resolved ssl-client.xml settings (empty when HTTPS is disabled).
@@ -161,7 +164,9 @@ pub enum Error {
     },
 
     #[snafu(display("failed to build discovery configmap"))]
-    BuildDiscoveryConfigMap { source: super::discovery::Error },
+    BuildDiscoveryConfigMap {
+        source: crate::controller::build::discovery::Error,
+    },
 
     #[snafu(display("failed to build rolegroup ConfigMap"))]
     BuildRolegroupConfigMap {
@@ -406,15 +411,8 @@ pub async fn reconcile_hbase(
 
     // Discovery CM will fail to build until the rest of the cluster has been deployed, so do it last
     // so that failure won't inhibit the rest of the cluster from booting up.
-    let discovery_cm = build_discovery_configmap(
-        hbase,
-        &client.kubernetes_cluster_info,
-        &validated_cluster
-            .cluster_config
-            .zookeeper_connection_information,
-        &validated_cluster.image,
-    )
-    .context(BuildDiscoveryConfigMapSnafu)?;
+    let discovery_cm = build_discovery_config_map(&validated_cluster, hbase)
+        .context(BuildDiscoveryConfigMapSnafu)?;
     cluster_resources
         .add(client, discovery_cm)
         .await

rust/operator-binary/src/main.rs

@@ -40,7 +40,6 @@ use crate::{
 mod config;
 mod controller;
 mod crd;
-mod discovery;
 mod hbase_controller;
 mod kerberos;
 mod operations;