refactor: move listener build out of crd

Author: maltesander

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

@@ -0,0 +1,78 @@
+//! Build the listener `Volume`/`PersistentVolumeClaim` exposing a rolegroup.
+
+use snafu::{ResultExt, Snafu};
+use stackable_operator::{
+    builder::pod::volume::{
+        ListenerOperatorVolumeSourceBuilder, ListenerOperatorVolumeSourceBuilderError,
+        ListenerReference, VolumeBuilder,
+    },
+    k8s_openapi::api::core::v1::{PersistentVolumeClaim, Volume},
+    kvp::Labels,
+};
+
+use crate::crd::{AnyServiceConfig, HbaseRole, LISTENER_VOLUME_NAME};
+
+#[derive(Snafu, Debug)]
+pub enum Error {
+    #[snafu(display("failed to build listener volume"))]
+    BuildListenerVolume {
+        source: ListenerOperatorVolumeSourceBuilderError,
+    },
+
+    #[snafu(display("failed to build listener pvc"))]
+    BuildListenerPvc {
+        source: ListenerOperatorVolumeSourceBuilderError,
+    },
+}
+
+type Result<T, E = Error> = std::result::Result<T, E>;
+
+/// The ephemeral listener [`Volume`] for the masters and region servers, or `None` for the rest
+/// servers (which use a [`PersistentVolumeClaim`] instead, see [`build_listener_pvc`]).
+pub fn build_listener_volume(
+    role: &HbaseRole,
+    merged_config: &AnyServiceConfig,
+    recommended_labels: &Labels,
+) -> Result<Option<Volume>> {
+    let volume = match role {
+        // Master and regionservers should use ephemeral listener volumes
+        // since clients pull the latest address from ZooKeeper
+        HbaseRole::Master | HbaseRole::RegionServer => Some(
+            VolumeBuilder::new(LISTENER_VOLUME_NAME)
+                .ephemeral(
+                    ListenerOperatorVolumeSourceBuilder::new(
+                        &ListenerReference::ListenerClass(
+                            merged_config.listener_class().to_string(),
+                        ),
+                        recommended_labels,
+                    )
+                    .build_ephemeral()
+                    .context(BuildListenerVolumeSnafu)?,
+                )
+                .build(),
+        ),
+        HbaseRole::RestServer => None,
+    };
+    Ok(volume)
+}
+
+/// The listener [`PersistentVolumeClaim`] template for the rest servers, or `None` for the masters
+/// and region servers (which use an ephemeral [`Volume`] instead, see [`build_listener_volume`]).
+pub fn build_listener_pvc(
+    role: &HbaseRole,
+    merged_config: &AnyServiceConfig,
+    recommended_labels: &Labels,
+) -> Result<Option<Vec<PersistentVolumeClaim>>> {
+    let pvc = match role {
+        HbaseRole::Master | HbaseRole::RegionServer => None,
+        HbaseRole::RestServer => Some(vec![
+            ListenerOperatorVolumeSourceBuilder::new(
+                &ListenerReference::ListenerClass(merged_config.listener_class().to_string()),
+                recommended_labels,
+            )
+            .build_pvc(LISTENER_VOLUME_NAME.to_string())
+            .context(BuildListenerPvcSnafu)?,
+        ]),
+    };
+    Ok(pvc)
+}

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

@@ -3,6 +3,7 @@
 
 pub mod config_map;
 pub mod discovery;
+pub mod listener;
 pub mod pdb;
 pub mod service;
 pub mod statefulset;

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

@@ -85,10 +85,10 @@ pub enum Error {
     },
 
     #[snafu(display("failed to build listener volume"))]
-    ListenerVolume { source: crate::crd::Error },
+    ListenerVolume { source: super::listener::Error },
 
     #[snafu(display("failed to build listener persistent volume claim"))]
-    ListenerPersistentVolumeClaim { source: crate::crd::Error },
+    ListenerPersistentVolumeClaim { source: super::listener::Error },
 }
 
 type Result<T, E = Error> = std::result::Result<T, E>;
@@ -298,13 +298,13 @@ pub fn build_rolegroup_statefulset(
         ));
     }
 
-    let listener_pvc = hbase_role
-        .listener_pvc(merged_config, &recommended_labels)
-        .context(ListenerPersistentVolumeClaimSnafu)?;
+    let listener_pvc =
+        super::listener::build_listener_pvc(hbase_role, merged_config, &recommended_labels)
+            .context(ListenerPersistentVolumeClaimSnafu)?;
 
-    if let Some(listener_volume) = hbase_role
-        .listener_volume(merged_config, &recommended_labels)
-        .context(ListenerVolumeSnafu)?
+    if let Some(listener_volume) =
+        super::listener::build_listener_volume(hbase_role, merged_config, &recommended_labels)
+            .context(ListenerVolumeSnafu)?
     {
         pod_builder
             .add_volume(listener_volume)

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

@@ -1,12 +1,7 @@
 use security::AuthenticationConfig;
 use serde::{Deserialize, Serialize};
 use shell_escape::escape;
-use snafu::{ResultExt, Snafu};
 use stackable_operator::{
-    builder::pod::volume::{
-        ListenerOperatorVolumeSourceBuilder, ListenerOperatorVolumeSourceBuilderError,
-        ListenerReference, VolumeBuilder,
-    },
     commons::{
         affinity::StackableAffinity,
         cluster_operation::ClusterOperation,
@@ -21,12 +16,8 @@ use stackable_operator::{
         merge::{Atomic, Merge},
     },
     deep_merger::ObjectOverrides,
-    k8s_openapi::{
-        api::core::v1::{PersistentVolumeClaim, Volume},
-        apimachinery::pkg::api::resource::Quantity,
-    },
+    k8s_openapi::apimachinery::pkg::api::resource::Quantity,
     kube::CustomResource,
-    kvp::Labels,
     product_logging::{self, spec::Logging},
     role_utils::{GenericRoleConfig, Role},
     schemars::{self, JsonSchema},
@@ -103,19 +94,6 @@ pub type RegionServerRoleType = Role<
 pub type RestServerRoleType =
     Role<HbaseConfigFragment, v1alpha1::HbaseConfigOverrides, GenericRoleConfig, JavaCommonConfig>;
 
-#[derive(Snafu, Debug)]
-pub enum Error {
-    #[snafu(display("failed to build listener volume"))]
-    BuildListenerVolume {
-        source: ListenerOperatorVolumeSourceBuilderError,
-    },
-
-    #[snafu(display("failed to build listener pvc"))]
-    BuildListenerPvc {
-        source: ListenerOperatorVolumeSourceBuilderError,
-    },
-}
-
 #[versioned(
     version(name = "v1alpha1"),
     crates(
@@ -311,52 +289,6 @@ impl HbaseRole {
         }
     }
 
-    pub fn listener_volume(
-        &self,
-        merged_config: &AnyServiceConfig,
-        recommended_labels: &Labels,
-    ) -> Result<Option<Volume>, Error> {
-        let volume = match &self {
-            // Master and regionservers should use ephemeral listener volumes
-            // since clients pull the latest address from ZooKeeper
-            HbaseRole::Master | HbaseRole::RegionServer => Some(
-                VolumeBuilder::new(LISTENER_VOLUME_NAME)
-                    .ephemeral(
-                        ListenerOperatorVolumeSourceBuilder::new(
-                            &ListenerReference::ListenerClass(
-                                merged_config.listener_class().to_string(),
-                            ),
-                            recommended_labels,
-                        )
-                        .build_ephemeral()
-                        .context(BuildListenerVolumeSnafu)?,
-                    )
-                    .build(),
-            ),
-            HbaseRole::RestServer => None,
-        };
-        Ok(volume)
-    }
-
-    pub fn listener_pvc(
-        &self,
-        merged_config: &AnyServiceConfig,
-        recommended_labels: &Labels,
-    ) -> Result<Option<Vec<PersistentVolumeClaim>>, Error> {
-        let pvc = match &self {
-            HbaseRole::Master | HbaseRole::RegionServer => None,
-            HbaseRole::RestServer => Some(vec![
-                ListenerOperatorVolumeSourceBuilder::new(
-                    &ListenerReference::ListenerClass(merged_config.listener_class().to_string()),
-                    recommended_labels,
-                )
-                .build_pvc(LISTENER_VOLUME_NAME.to_string())
-                .context(BuildListenerPvcSnafu)?,
-            ]),
-        };
-        Ok(pvc)
-    }
-
     /// Returns required port name and port number tuples depending on the role.
     ///
     /// Hbase versions 2.6.* will have two ports for each role. The metrics are available on the