refactor: use v2 ownerref, add HasName and HasUid traits.

Author: maltesander

rust/operator-binary/src/controller.rs

@@ -72,6 +72,7 @@ use stackable_operator::{
         statefulset::StatefulSetConditionBuilder,
     },
     utils::COMMON_BASH_TRAP_FUNCTIONS,
+    v2::{HasName, HasUid, builder::meta::ownerreference_from_resource},
 };
 use strum::EnumDiscriminants;
 
@@ -139,11 +140,6 @@ pub enum Error {
         rolegroup: RoleGroupRef<v1alpha1::HiveCluster>,
     },
 
-    #[snafu(display("object is missing metadata to build owner reference"))]
-    ObjectMissingMetadataForOwnerRef {
-        source: stackable_operator::builder::meta::Error,
-    },
-
     #[snafu(display("failed to build discovery ConfigMap"))]
     BuildDiscoveryConfig { source: discovery::Error },
 
@@ -323,6 +319,7 @@ pub struct ValidatedCluster {
     metadata: ObjectMeta,
     pub name: stackable_operator::v2::types::operator::ClusterName,
     pub namespace: stackable_operator::v2::types::kubernetes::NamespaceName,
+    pub uid: stackable_operator::v2::types::kubernetes::Uid,
     pub image: ResolvedProductImage,
     pub role_config: Option<ValidatedRoleConfig>,
     pub cluster_config: ValidatedClusterConfig,
@@ -348,12 +345,21 @@ impl ValidatedCluster {
             },
             name,
             namespace,
+            uid,
             image,
             role_config,
             cluster_config,
             role_group_configs,
         }
     }
+
+    /// The name of the per-role [`Listener`] object.
+    ///
+    /// Must stay in sync with [`v1alpha1::HiveCluster::role_listener_name`], which derives the
+    /// same name from the raw cluster (used e.g. by the StatefulSet listener-volume PVC).
+    pub fn role_listener_name(&self, hive_role: &HiveRole) -> String {
+        format!("{name}-{role}", name = self.name, role = hive_role)
+    }
 }
 
 /// Lets [`ValidatedCluster`] stand in for the raw [`v1alpha1::HiveCluster`] when building owner
@@ -388,6 +394,18 @@ impl Resource for ValidatedCluster {
     }
 }
 
+impl HasName for ValidatedCluster {
+    fn to_name(&self) -> String {
+        self.name.to_string()
+    }
+}
+
+impl HasUid for ValidatedCluster {
+    fn to_uid(&self) -> stackable_operator::v2::types::kubernetes::Uid {
+        self.uid.clone()
+    }
+}
+
 /// Cluster-wide settings resolved during validation and dereferencing.
 ///
 /// Everything the config-file builders need is resolved here so they never have to
@@ -472,11 +490,11 @@ pub async fn reconcile_hive(
             let rolegroup = hive.metastore_rolegroup_ref(rolegroup_name);
 
             let rg_metrics_service =
-                build_rolegroup_metrics_service(hive, &validated_cluster.image, &rolegroup)
+                build_rolegroup_metrics_service(&validated_cluster, &rolegroup)
                     .context(ServiceConfigurationSnafu)?;
 
             let rg_headless_service =
-                build_rolegroup_headless_service(hive, &validated_cluster.image, &rolegroup)
+                build_rolegroup_headless_service(&validated_cluster, &rolegroup)
                     .context(ServiceConfigurationSnafu)?;
 
             let rg_configmap = build::config_map::build_metastore_rolegroup_config_map(
@@ -547,8 +565,7 @@ pub async fn reconcile_hive(
         .context(FailedToCreatePdbSnafu)?;
 
         let role_listener: Listener = build_role_listener(
-            hive,
-            &validated_cluster.image,
+            &validated_cluster,
             &HiveRole::MetaStore,
             &role_config.listener_class,
         )
@@ -813,7 +830,7 @@ fn build_metastore_rolegroup_statefulset(
         .build();
 
     let pvc = ListenerOperatorVolumeSourceBuilder::new(
-        &ListenerReference::ListenerName(hive.role_listener_name(hive_role)),
+        &ListenerReference::ListenerName(cluster.role_listener_name(hive_role)),
         &unversioned_recommended_labels,
     )
     .build_pvc(LISTENER_VOLUME_NAME.to_owned())
@@ -929,10 +946,9 @@ fn build_metastore_rolegroup_statefulset(
 
     Ok(StatefulSet {
         metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(hive)
+            .name_and_namespace(cluster)
             .name(rolegroup_ref.object_name())
-            .ownerreference_from_resource(hive, None, Some(true))
-            .context(ObjectMissingMetadataForOwnerRefSnafu)?
+            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
             .with_recommended_labels(&recommended_object_labels)
             .context(MetadataBuildSnafu)?
             .with_label(RESTART_CONTROLLER_ENABLED_LABEL.to_owned())

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

@@ -6,7 +6,10 @@ use stackable_operator::{
     k8s_openapi::api::core::v1::ConfigMap,
     product_logging::framework::VECTOR_CONFIG_FILE,
     role_utils::RoleGroupRef,
-    v2::config_file_writer::{PropertiesWriterError, to_hadoop_xml, to_java_properties_string},
+    v2::{
+        builder::meta::ownerreference_from_resource,
+        config_file_writer::{PropertiesWriterError, to_hadoop_xml, to_java_properties_string},
+    },
 };
 
 use crate::{
@@ -26,11 +29,6 @@ pub enum Error {
     #[snafu(display("failed to serialize {}", ConfigFileName::Security))]
     WriteSecurityProperties { source: PropertiesWriterError },
 
-    #[snafu(display("object is missing metadata to build owner reference"))]
-    ObjectMissingMetadataForOwnerRef {
-        source: stackable_operator::builder::meta::Error,
-    },
-
     #[snafu(display("failed to build metadata"))]
     MetadataBuild {
         source: stackable_operator::builder::meta::Error,
@@ -72,8 +70,7 @@ pub fn build_metastore_rolegroup_config_map(
             ObjectMetaBuilder::new()
                 .name_and_namespace(cluster)
                 .name(rolegroup.object_name())
-                .ownerreference_from_resource(cluster, None, Some(true))
-                .context(ObjectMissingMetadataForOwnerRefSnafu)?
+                .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
                 .with_recommended_labels(&build_recommended_labels(
                     cluster,
                     &cluster.image.app_version_label_value,

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

@@ -4,6 +4,7 @@ use stackable_operator::{
     crd::listener::v1alpha1::Listener,
     k8s_openapi::api::core::v1::ConfigMap,
     kube::runtime::reflector::ObjectRef,
+    v2::builder::meta::ownerreference_from_resource,
 };
 
 use crate::{
@@ -14,12 +15,6 @@ use crate::{
 
 #[derive(Snafu, Debug)]
 pub enum Error {
-    #[snafu(display("object is missing metadata to build owner reference {obj_ref}"))]
-    ObjectMissingMetadataForOwnerRef {
-        source: stackable_operator::builder::meta::Error,
-        obj_ref: ObjectRef<v1alpha1::HiveCluster>,
-    },
-
     #[snafu(display("could not build discovery config map for {obj_ref}"))]
     DiscoveryConfigMap {
         source: stackable_operator::builder::configmap::Error,
@@ -70,10 +65,7 @@ fn build_discovery_configmap(
     discovery_configmap.metadata(
         ObjectMetaBuilder::new()
             .name_and_namespace(cluster)
-            .ownerreference_from_resource(cluster, None, Some(true))
-            .with_context(|_| ObjectMissingMetadataForOwnerRefSnafu {
-                obj_ref: cluster_object_ref(cluster),
-            })?
+            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
             .with_recommended_labels(&build_recommended_labels(
                 cluster,
                 &cluster.image.app_version_label_value,

rust/operator-binary/src/listener.rs

@@ -1,13 +1,13 @@
 use snafu::{OptionExt, ResultExt, Snafu};
 use stackable_operator::{
     builder::meta::ObjectMetaBuilder,
-    commons::product_image_selection::ResolvedProductImage,
     crd::listener::v1alpha1::{Listener, ListenerPort, ListenerSpec},
+    v2::builder::meta::ownerreference_from_resource,
 };
 
 use crate::{
-    controller::build_recommended_labels,
-    crd::{HIVE_PORT, HIVE_PORT_NAME, HiveRole, v1alpha1},
+    controller::{ValidatedCluster, build_recommended_labels},
+    crd::{HIVE_PORT, HIVE_PORT_NAME, HiveRole},
 };
 
 // Listener volumes
@@ -19,10 +19,6 @@ pub const DEFAULT_LISTENER_CLASS: &str = "cluster-internal";
 
 #[derive(Snafu, Debug)]
 pub enum Error {
-    #[snafu(display("object is missing metadata to build owner reference"))]
-    ObjectMissingMetadataForOwnerRef {
-        source: stackable_operator::builder::meta::Error,
-    },
     #[snafu(display("failed to build Metadata"))]
     MetadataBuild {
         source: stackable_operator::builder::meta::Error,
@@ -70,19 +66,17 @@ pub fn build_listener_connection_string(
 // Designed to build a listener per role
 // In case of Hive we expect only one role: Metastore
 pub fn build_role_listener(
-    hive: &v1alpha1::HiveCluster,
-    resolved_product_image: &ResolvedProductImage,
+    cluster: &ValidatedCluster,
     hive_role: &HiveRole,
     listener_class: &String,
 ) -> Result<Listener, Error> {
     let metadata = ObjectMetaBuilder::new()
-        .name_and_namespace(hive)
-        .name(hive.role_listener_name(hive_role))
-        .ownerreference_from_resource(hive, None, Some(true))
-        .context(ObjectMissingMetadataForOwnerRefSnafu)?
+        .name_and_namespace(cluster)
+        .name(cluster.role_listener_name(hive_role))
+        .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
         .with_recommended_labels(&build_recommended_labels(
-            hive,
-            &resolved_product_image.app_version_label_value,
+            cluster,
+            &cluster.image.app_version_label_value,
             &hive_role.to_string(),
             "none",
         ))

rust/operator-binary/src/service.rs

@@ -1,23 +1,19 @@
 use snafu::{ResultExt, Snafu};
 use stackable_operator::{
     builder::meta::ObjectMetaBuilder,
-    commons::product_image_selection::ResolvedProductImage,
     k8s_openapi::api::core::v1::{Service, ServicePort, ServiceSpec},
     kvp::{Annotations, Labels},
     role_utils::RoleGroupRef,
+    v2::builder::meta::ownerreference_from_resource,
 };
 
 use crate::{
-    controller::build_recommended_labels,
+    controller::{ValidatedCluster, build_recommended_labels},
     crd::{APP_NAME, HIVE_PORT, HIVE_PORT_NAME, METRICS_PORT, METRICS_PORT_NAME, v1alpha1},
 };
 
 #[derive(Debug, Snafu)]
 pub enum Error {
-    #[snafu(display("object is missing metadata to build owner reference"))]
-    ObjectMissingMetadataForOwnerRef {
-        source: stackable_operator::builder::meta::Error,
-    },
     #[snafu(display("failed to build Metadata"))]
     MetadataBuild {
         source: stackable_operator::builder::meta::Error,
@@ -32,19 +28,17 @@ pub enum Error {
 ///
 /// This is mostly useful for internal communication between peers, or for clients that perform client-side load balancing.
 pub fn build_rolegroup_headless_service(
-    hive: &v1alpha1::HiveCluster,
-    resolved_product_image: &ResolvedProductImage,
+    cluster: &ValidatedCluster,
     rolegroup: &RoleGroupRef<v1alpha1::HiveCluster>,
 ) -> Result<Service, Error> {
     let headless_service = Service {
         metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(hive)
+            .name_and_namespace(cluster)
             .name(rolegroup.rolegroup_headless_service_name())
-            .ownerreference_from_resource(hive, None, Some(true))
-            .context(ObjectMissingMetadataForOwnerRefSnafu)?
+            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
             .with_recommended_labels(&build_recommended_labels(
-                hive,
-                &resolved_product_image.app_version_label_value,
+                cluster,
+                &cluster.image.app_version_label_value,
                 &rolegroup.role,
                 &rolegroup.role_group,
             ))
@@ -57,9 +51,14 @@ pub fn build_rolegroup_headless_service(
             // Expecting same ports as on listener service, just as a headless, internal service
             ports: Some(service_ports()),
             selector: Some(
-                Labels::role_group_selector(hive, APP_NAME, &rolegroup.role, &rolegroup.role_group)
-                    .context(LabelBuildSnafu)?
-                    .into(),
+                Labels::role_group_selector(
+                    cluster,
+                    APP_NAME,
+                    &rolegroup.role,
+                    &rolegroup.role_group,
+                )
+                .context(LabelBuildSnafu)?
+                .into(),
             ),
             publish_not_ready_addresses: Some(true),
             ..ServiceSpec::default()
@@ -71,19 +70,17 @@ pub fn build_rolegroup_headless_service(
 
 /// The rolegroup metrics [`Service`] is a service that exposes metrics and a prometheus scraping label
 pub fn build_rolegroup_metrics_service(
-    hive: &v1alpha1::HiveCluster,
-    resolved_product_image: &ResolvedProductImage,
+    cluster: &ValidatedCluster,
     rolegroup: &RoleGroupRef<v1alpha1::HiveCluster>,
 ) -> Result<Service, Error> {
     let metrics_service = Service {
         metadata: ObjectMetaBuilder::new()
-            .name_and_namespace(hive)
+            .name_and_namespace(cluster)
             .name(rolegroup.rolegroup_metrics_service_name())
-            .ownerreference_from_resource(hive, None, Some(true))
-            .context(ObjectMissingMetadataForOwnerRefSnafu)?
+            .ownerreference(ownerreference_from_resource(cluster, None, Some(true)))
             .with_recommended_labels(&build_recommended_labels(
-                hive,
-                &resolved_product_image.app_version_label_value,
+                cluster,
+                &cluster.image.app_version_label_value,
                 &rolegroup.role,
                 &rolegroup.role_group,
             ))
@@ -97,9 +94,14 @@ pub fn build_rolegroup_metrics_service(
             cluster_ip: Some("None".to_string()),
             ports: Some(metrics_ports()),
             selector: Some(
-                Labels::role_group_selector(hive, APP_NAME, &rolegroup.role, &rolegroup.role_group)
-                    .context(LabelBuildSnafu)?
-                    .into(),
+                Labels::role_group_selector(
+                    cluster,
+                    APP_NAME,
+                    &rolegroup.role,
+                    &rolegroup.role_group,
+                )
+                .context(LabelBuildSnafu)?
+                .into(),
             ),
             publish_not_ready_addresses: Some(true),
             ..ServiceSpec::default()