move label-related functions out of controller into a separate module

Author: adwk67

rust/operator-binary/src/controller.rs

@@ -25,7 +25,6 @@ use stackable_operator::{
         core::{DeserializeGuard, error_boundary},
         runtime::{controller::Action, reflector::ObjectRef},
     },
-    kvp::Labels,
     logging::controller::ReconcilerError,
     shared::time::Duration,
     status::condition::{
@@ -35,7 +34,6 @@ use stackable_operator::{
     v2::{
         HasName, HasUid, NameIsValidLabelValue,
         cluster_resources::cluster_resources_new,
-        kvp::label::{recommended_labels, role_group_selector},
         role_group_utils::ResourceNames,
         types::{
             kubernetes::{ConfigMapName, ListenerName, NamespaceName, Uid},
@@ -250,53 +248,6 @@ impl ValidatedCluster {
         ))
         .expect("the bootstrap listener name is a valid Listener name")
     }
-
-    /// Recommended labels for a role-group resource, using the given product version.
-    fn recommended_labels_for(
-        &self,
-        product_version: &ProductVersion,
-        role: &KafkaRole,
-        role_group_name: &RoleGroupName,
-    ) -> Labels {
-        recommended_labels(
-            self,
-            &product_name(),
-            product_version,
-            &operator_name(),
-            &controller_name(),
-            &Self::role_name(role),
-            role_group_name,
-        )
-    }
-
-    /// Recommended labels for a role-group resource.
-    pub fn recommended_labels(&self, role: &KafkaRole, role_group_name: &RoleGroupName) -> Labels {
-        self.recommended_labels_for(&self.product_version, role, role_group_name)
-    }
-
-    /// Recommended labels without a version, for PVC templates that cannot be modified once
-    /// deployed.
-    pub fn unversioned_recommended_labels(
-        &self,
-        role: &KafkaRole,
-        role_group_name: &RoleGroupName,
-    ) -> Labels {
-        // A version value is required, and we do want to use the "recommended" format for the
-        // other desired labels.
-        let none_version =
-            ProductVersion::from_str("none").expect("'none' is a valid product version");
-        self.recommended_labels_for(&none_version, role, role_group_name)
-    }
-
-    /// Selector labels matching the pods of a role group.
-    pub fn role_group_selector(&self, role: &KafkaRole, role_group_name: &RoleGroupName) -> Labels {
-        role_group_selector(
-            self,
-            &product_name(),
-            &Self::role_name(role),
-            role_group_name,
-        )
-    }
 }
 
 impl HasName for ValidatedCluster {

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

@@ -0,0 +1,71 @@
+//! Recommended-label and selector construction for the KafkaCluster build step.
+//!
+//! These build Kubernetes labels/selectors from a [`ValidatedCluster`]. They live here rather
+//! than as methods on [`ValidatedCluster`] so the validated model only exposes views on its
+//! properties, not build-step helpers.
+
+use std::str::FromStr;
+
+use stackable_operator::{
+    kvp::Labels,
+    v2::{kvp::label, types::operator::ProductVersion},
+};
+
+use crate::{
+    controller::{RoleGroupName, ValidatedCluster, controller_name, operator_name, product_name},
+    crd::role::KafkaRole,
+};
+
+/// Recommended labels for a role-group resource, using the given product version.
+fn recommended_labels_for(
+    cluster: &ValidatedCluster,
+    product_version: &ProductVersion,
+    role: &KafkaRole,
+    role_group_name: &RoleGroupName,
+) -> Labels {
+    label::recommended_labels(
+        cluster,
+        &product_name(),
+        product_version,
+        &operator_name(),
+        &controller_name(),
+        &ValidatedCluster::role_name(role),
+        role_group_name,
+    )
+}
+
+/// Recommended labels for a role-group resource.
+pub fn recommended_labels(
+    cluster: &ValidatedCluster,
+    role: &KafkaRole,
+    role_group_name: &RoleGroupName,
+) -> Labels {
+    recommended_labels_for(cluster, &cluster.product_version, role, role_group_name)
+}
+
+/// Recommended labels without a version, for PVC templates that cannot be modified once
+/// deployed.
+pub fn unversioned_recommended_labels(
+    cluster: &ValidatedCluster,
+    role: &KafkaRole,
+    role_group_name: &RoleGroupName,
+) -> Labels {
+    // A version value is required, and we do want to use the "recommended" format for the
+    // other desired labels.
+    let none_version = ProductVersion::from_str("none").expect("'none' is a valid product version");
+    recommended_labels_for(cluster, &none_version, role, role_group_name)
+}
+
+/// Selector labels matching the pods of a role group.
+pub fn role_group_selector(
+    cluster: &ValidatedCluster,
+    role: &KafkaRole,
+    role_group_name: &RoleGroupName,
+) -> Labels {
+    label::role_group_selector(
+        cluster,
+        &product_name(),
+        &ValidatedCluster::role_name(role),
+        role_group_name,
+    )
+}

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

@@ -4,6 +4,7 @@ pub mod command;
 pub mod graceful_shutdown;
 pub mod jvm;
 pub mod kerberos;
+pub mod labels;
 pub mod properties;
 pub mod resource;
 pub mod security;

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

@@ -14,6 +14,7 @@ use crate::{
     controller::{
         RoleGroupName, ValidatedCluster, ValidatedRoleGroupConfig,
         build::{
+            labels,
             properties::{
                 ConfigFileName, config_file_name, product_logging::role_group_config_map_data,
             },
@@ -133,7 +134,11 @@ pub fn build_rolegroup_config_map(
                     None,
                     Some(true),
                 ))
-                .with_labels(validated_cluster.recommended_labels(&role, role_group_name))
+                .with_labels(labels::recommended_labels(
+                    validated_cluster,
+                    &role,
+                    role_group_name,
+                ))
                 .build(),
         )
         .add_data(

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

@@ -9,7 +9,7 @@ use stackable_operator::{
 };
 
 use crate::{
-    controller::{RoleGroupName, ValidatedCluster},
+    controller::{RoleGroupName, ValidatedCluster, build::labels},
     crd::role::KafkaRole,
 };
 
@@ -57,13 +57,12 @@ pub fn build_discovery_configmap(
                     None,
                     Some(true),
                 ))
-                .with_labels(
-                    validated_cluster.recommended_labels(
-                        &KafkaRole::Broker,
-                        &RoleGroupName::from_str("discovery")
-                            .expect("'discovery' is a valid role group name"),
-                    ),
-                )
+                .with_labels(labels::recommended_labels(
+                    validated_cluster,
+                    &KafkaRole::Broker,
+                    &RoleGroupName::from_str("discovery")
+                        .expect("'discovery' is a valid role group name"),
+                ))
                 .build(),
         )
         .add_data("KAFKA", bootstrap_servers)

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

@@ -4,7 +4,9 @@ use stackable_operator::{
 };
 
 use crate::{
-    controller::{RoleGroupName, ValidatedCluster, security::ValidatedKafkaSecurity},
+    controller::{
+        RoleGroupName, ValidatedCluster, build::labels, security::ValidatedKafkaSecurity,
+    },
     crd::role::{KafkaRole, broker::BrokerConfig},
 };
 
@@ -28,7 +30,11 @@ pub fn build_broker_rolegroup_bootstrap_listener(
                 None,
                 Some(true),
             ))
-            .with_labels(validated_cluster.recommended_labels(role, role_group_name))
+            .with_labels(labels::recommended_labels(
+                validated_cluster,
+                role,
+                role_group_name,
+            ))
             .build(),
         spec: listener::v1alpha1::ListenerSpec {
             class_name: Some(merged_config.bootstrap_listener_class.to_string()),

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

@@ -8,7 +8,9 @@ use stackable_operator::{
 };
 
 use crate::{
-    controller::{RoleGroupName, ValidatedCluster, security::ValidatedKafkaSecurity},
+    controller::{
+        RoleGroupName, ValidatedCluster, build::labels, security::ValidatedKafkaSecurity,
+    },
     crd::{METRICS_PORT, METRICS_PORT_NAME, role::KafkaRole},
 };
 
@@ -35,15 +37,17 @@ pub fn build_rolegroup_headless_service(
                 None,
                 Some(true),
             ))
-            .with_labels(validated_cluster.recommended_labels(role, role_group_name))
+            .with_labels(labels::recommended_labels(
+                validated_cluster,
+                role,
+                role_group_name,
+            ))
             .build(),
         spec: Some(ServiceSpec {
             cluster_ip: Some("None".to_string()),
             ports: Some(headless_ports(kafka_security)),
             selector: Some(
-                validated_cluster
-                    .role_group_selector(role, role_group_name)
-                    .into(),
+                labels::role_group_selector(validated_cluster, role, role_group_name).into(),
             ),
             publish_not_ready_addresses: Some(true),
             ..ServiceSpec::default()
@@ -72,7 +76,11 @@ pub fn build_rolegroup_metrics_service(
                 None,
                 Some(true),
             ))
-            .with_labels(validated_cluster.recommended_labels(role, role_group_name))
+            .with_labels(labels::recommended_labels(
+                validated_cluster,
+                role,
+                role_group_name,
+            ))
             .with_labels(prometheus_labels(&Scraping::Enabled))
             .with_annotations(prometheus_annotations(
                 &Scraping::Enabled,
@@ -87,9 +95,7 @@ pub fn build_rolegroup_metrics_service(
             cluster_ip: Some("None".to_string()),
             ports: Some(metrics_ports()),
             selector: Some(
-                validated_cluster
-                    .role_group_selector(role, role_group_name)
-                    .into(),
+                labels::role_group_selector(validated_cluster, role, role_group_name).into(),
             ),
             publish_not_ready_addresses: Some(true),
             ..ServiceSpec::default()

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

@@ -52,6 +52,7 @@ use crate::{
             },
             graceful_shutdown::add_graceful_shutdown_config,
             kerberos::add_kerberos_pod_config,
+            labels,
             properties::product_logging::MAX_KAFKA_LOG_FILES_SIZE,
             security::{
                 add_broker_volume_and_volume_mounts, add_controller_volume_and_volume_mounts,
@@ -152,10 +153,11 @@ pub fn build_broker_rolegroup_statefulset(
     let resolved_product_image = &validated_cluster.image;
     let merged_config = &validated_rg.config.config;
     let resource_names = validated_cluster.resource_names(kafka_role, role_group_name);
-    let recommended_labels = validated_cluster.recommended_labels(kafka_role, role_group_name);
+    let recommended_labels =
+        labels::recommended_labels(validated_cluster, kafka_role, role_group_name);
     // Used for PVC templates that cannot be modified once they are deployed
     let unversioned_recommended_labels =
-        validated_cluster.unversioned_recommended_labels(kafka_role, role_group_name);
+        labels::unversioned_recommended_labels(validated_cluster, kafka_role, role_group_name);
 
     let kcat_prober_container_name = BrokerContainer::KcatProber.to_string();
     let mut cb_kcat_prober =
@@ -419,8 +421,7 @@ pub fn build_broker_rolegroup_statefulset(
             replicas: validated_rg.replicas.map(i32::from),
             selector: LabelSelector {
                 match_labels: Some(
-                    validated_cluster
-                        .role_group_selector(kafka_role, role_group_name)
+                    labels::role_group_selector(validated_cluster, kafka_role, role_group_name)
                         .into(),
                 ),
                 ..LabelSelector::default()
@@ -446,7 +447,8 @@ pub fn build_controller_rolegroup_statefulset(
     let resolved_product_image = &validated_cluster.image;
     let merged_config = &validated_rg.config.config;
     let resource_names = validated_cluster.resource_names(kafka_role, role_group_name);
-    let recommended_labels = validated_cluster.recommended_labels(kafka_role, role_group_name);
+    let recommended_labels =
+        labels::recommended_labels(validated_cluster, kafka_role, role_group_name);
 
     let kafka_container_name = ControllerContainer::Kafka.to_string();
     let mut cb_kafka =
@@ -649,8 +651,7 @@ pub fn build_controller_rolegroup_statefulset(
             replicas: validated_rg.replicas.map(i32::from),
             selector: LabelSelector {
                 match_labels: Some(
-                    validated_cluster
-                        .role_group_selector(kafka_role, role_group_name)
+                    labels::role_group_selector(validated_cluster, kafka_role, role_group_name)
                         .into(),
                 ),
                 ..LabelSelector::default()