refactor: switch to v2 ConfigMapName, SecretName, ListenerName in CRD

Author: maltesander

extra/crds.yaml

@@ -40,6 +40,9 @@ spec:
                         properties:
                           secretClass:
                             description: Name of the SecretClass providing the keytab for the HBase services.
+                            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
                         required:
                         - secretClass
@@ -84,6 +87,9 @@ spec:
                           providing information about the HDFS cluster.
                           See also the [Stackable Operator for HDFS](https://docs.stackable.tech/home/nightly/hdfs/) to learn
                           more about setting up an HDFS cluster.
+                        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
                     required:
                     - configMap
@@ -352,7 +358,10 @@ spec:
                       It must contain the key `ADDRESS` with the address of the Vector aggregator.
                       Follow the [logging tutorial](https://docs.stackable.tech/home/nightly/tutorials/logging-vector-aggregator)
                       to learn how to configure log aggregation with Vector.
+                    maxLength: 253
+                    minLength: 1
                     nullable: true
+                    pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
                     type: string
                 required:
                 - metadataDatabase
@@ -872,6 +881,9 @@ spec:
                       listenerClass:
                         default: cluster-internal
                         description: This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) is used to expose the metastore.
+                        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:

rust/operator-binary/src/controller.rs

@@ -40,7 +40,7 @@ use stackable_operator::{
         kvp::label::{recommended_labels, role_group_selector},
         role_group_utils::ResourceNames,
         types::{
-            kubernetes::ListenerName,
+            kubernetes::{ListenerClassName, ListenerName, SecretClassName},
             operator::{ControllerName, OperatorName, ProductName, ProductVersion, RoleName},
         },
     },
@@ -456,7 +456,7 @@ pub struct ValidatedClusterConfig {
     pub s3_connection_spec: Option<s3::v1alpha1::ConnectionSpec>,
     pub hive_opa_config: Option<HiveOpaConfig>,
     /// The Kerberos `SecretClass` name, if Kerberos is enabled.
-    pub kerberos_secret_class: Option<String>,
+    pub kerberos_secret_class: Option<SecretClassName>,
     /// Kerberos-related `hive-site.xml` entries (empty when Kerberos is disabled).
     pub kerberos_config: BTreeMap<String, String>,
     /// Whether a `core-site.xml` with `hadoop.security.authentication=kerberos` is
@@ -468,7 +468,7 @@ pub struct ValidatedClusterConfig {
 #[derive(Clone, Debug)]
 pub struct ValidatedRoleConfig {
     pub pdb: stackable_operator::commons::pdb::PdbConfig,
-    pub listener_class: String,
+    pub listener_class: ListenerClassName,
 }
 
 pub async fn reconcile_hive(

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

@@ -1,10 +1,11 @@
-use std::collections::BTreeMap;
+use std::{collections::BTreeMap, str::FromStr};
 
 use stackable_operator::{
     client::Client,
     commons::opa::{OpaApiVersion, OpaConfig},
     k8s_openapi::api::core::v1::ConfigMap,
     kube::ResourceExt,
+    v2::types::kubernetes::VolumeName,
 };
 
 use crate::crd::v1alpha1::HiveCluster;
@@ -33,7 +34,9 @@ const OPA_AUTHORIZATION_POLICY_URL_PARTITION: &str =
     "com.bosch.bdps.opa.authorization.policy.url.partition";
 const OPA_AUTHORIZATION_POLICY_URL_USER: &str = "com.bosch.bdps.opa.authorization.policy.url.user";
 
-pub const OPA_TLS_VOLUME_NAME: &str = "opa-tls";
+// Typed name for the OPA TLS secret-operator volume, reusing the existing `"opa-tls"` string
+// value so the produced volume/mount name is unchanged.
+stackable_operator::constant!(pub(crate) OPA_TLS_VOLUME_NAME: VolumeName = "opa-tls");
 
 pub struct HiveOpaConfig {
     /// Endpoint for OPA, e.g.
@@ -124,6 +127,6 @@ impl HiveOpaConfig {
     pub fn tls_ca_cert_mount_path(&self) -> Option<String> {
         self.tls_secret_class
             .as_ref()
-            .map(|_| format!("/stackable/secrets/{OPA_TLS_VOLUME_NAME}"))
+            .map(|_| format!("/stackable/secrets/{}", &*OPA_TLS_VOLUME_NAME))
     }
 }

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

@@ -1,5 +1,8 @@
 use snafu::{OptionExt, Snafu};
-use stackable_operator::crd::listener::v1alpha1::{Listener, ListenerPort, ListenerSpec};
+use stackable_operator::{
+    crd::listener::v1alpha1::{Listener, ListenerPort, ListenerSpec},
+    v2::types::kubernetes::ListenerClassName,
+};
 
 use crate::{
     controller::{ValidatedCluster, build::PLACEHOLDER_LISTENER_ROLE_GROUP},
@@ -53,7 +56,7 @@ pub fn build_listener_connection_string(
 pub fn build_role_listener(
     cluster: &ValidatedCluster,
     hive_role: &HiveRole,
-    listener_class: &String,
+    listener_class: &ListenerClassName,
 ) -> Listener {
     // The role listener is a role-level (not role-group-level) object, so there is no real
     // role-group name; "none" is used as a placeholder for the recommended labels.
@@ -65,7 +68,7 @@ pub fn build_role_listener(
         .build();
 
     let spec = ListenerSpec {
-        class_name: Some(listener_class.to_owned()),
+        class_name: Some(listener_class.to_string()),
         ports: Some(listener_ports()),
         ..Default::default()
     };

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

@@ -209,10 +209,10 @@ pub(crate) fn build_metastore_rolegroup_statefulset(
         })
     {
         container_builder
-            .add_volume_mount(OPA_TLS_VOLUME_NAME, &tls_mount_path)
+            .add_volume_mount(&*OPA_TLS_VOLUME_NAME, &tls_mount_path)
             .context(AddVolumeMountSnafu)?;
 
-        let opa_tls_volume = VolumeBuilder::new(OPA_TLS_VOLUME_NAME)
+        let opa_tls_volume = VolumeBuilder::new(&*OPA_TLS_VOLUME_NAME)
             .ephemeral(
                 SecretOperatorVolumeSourceBuilder::new(
                     tls_secret_class,

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

@@ -91,11 +91,6 @@ pub enum Error {
         "the Vector aggregator discovery ConfigMap name is required when the Vector agent is enabled"
     ))]
     MissingVectorAggregatorConfigMapName,
-
-    #[snafu(display("invalid Vector aggregator discovery ConfigMap name"))]
-    ParseVectorAggregatorConfigMapName {
-        source: stackable_operator::v2::macros::attributed_string_type::Error,
-    },
 }
 
 /// Validated logging configuration for the Hive metastore and (optional) Vector container.
@@ -183,16 +178,13 @@ pub fn validate_cluster(
 
     let default_config = MetaStoreConfig::default_config(name.as_ref(), &hive_role);
 
-    // The Vector aggregator discovery ConfigMap name (validated here so an invalid name fails
-    // up-front). It is only required when the Vector agent is enabled for a role group.
+    // The Vector aggregator discovery ConfigMap name. It is only required when the Vector agent is
+    // enabled for a role group; validity is already enforced by the `ConfigMapName` type on the CRD.
     let vector_aggregator_config_map_name = hive
         .spec
         .cluster_config
         .vector_aggregator_config_map_name
-        .as_deref()
-        .map(ConfigMapName::from_str)
-        .transpose()
-        .context(ParseVectorAggregatorConfigMapNameSnafu)?;
+        .clone();
 
     let mut groups: BTreeMap<RoleGroupName, HiveRoleGroupConfig> = BTreeMap::new();
     for (rg_name, rg) in &role.role_groups {

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

@@ -1,3 +1,5 @@
+use std::str::FromStr;
+
 use databases::MetadataDatabaseConnection;
 /// Re-export of the shared product-logging spec data types (test-only).
 ///
@@ -36,8 +38,12 @@ use stackable_operator::{
     shared::time::Duration,
     status::condition::{ClusterCondition, HasStatusCondition},
     v2::{
-        config_overrides::KeyValueConfigOverrides, role_utils::JavaCommonConfig,
-        types::common::Port,
+        config_overrides::KeyValueConfigOverrides,
+        role_utils::JavaCommonConfig,
+        types::{
+            common::Port,
+            kubernetes::{ConfigMapName, ListenerClassName, SecretClassName},
+        },
     },
     versioned::versioned,
 };
@@ -76,8 +82,9 @@ pub const STACKABLE_TRUST_STORE_PASSWORD: &str = "changeit";
 pub const DEFAULT_LISTENER_CLASS: &str = "cluster-internal";
 
 // used by crds to define a default listener_class name
-pub fn metastore_default_listener_class() -> String {
-    DEFAULT_LISTENER_CLASS.to_owned()
+pub fn metastore_default_listener_class() -> ListenerClassName {
+    ListenerClassName::from_str(DEFAULT_LISTENER_CLASS)
+        .expect("the default listener class is a valid listener class name")
 }
 
 const DEFAULT_METASTORE_GRACEFUL_SHUTDOWN_TIMEOUT: Duration = Duration::from_minutes_unchecked(5);
@@ -154,7 +161,7 @@ pub mod versioned {
 
         /// This field controls which [ListenerClass](DOCS_BASE_URL_PLACEHOLDER/listener-operator/listenerclass.html) is used to expose the metastore.
         #[serde(default = "metastore_default_listener_class")]
-        pub listener_class: String,
+        pub listener_class: ListenerClassName,
     }
 
     #[derive(Clone, Debug, Deserialize, JsonSchema, PartialEq, Serialize)]
@@ -185,7 +192,7 @@ pub mod versioned {
         /// Follow the [logging tutorial](DOCS_BASE_URL_PLACEHOLDER/tutorials/logging-vector-aggregator)
         /// to learn how to configure log aggregation with Vector.
         #[serde(skip_serializing_if = "Option::is_none")]
-        pub vector_aggregator_config_map_name: Option<String>,
+        pub vector_aggregator_config_map_name: Option<ConfigMapName>,
     }
 
     #[derive(Clone, Debug, Default, Deserialize, Eq, JsonSchema, Merge, PartialEq, Serialize)]
@@ -228,7 +235,7 @@ impl v1alpha1::HiveCluster {
         self.kerberos_secret_class().is_some()
     }
 
-    pub fn kerberos_secret_class(&self) -> Option<String> {
+    pub fn kerberos_secret_class(&self) -> Option<SecretClassName> {
         self.spec
             .cluster_config
             .authentication
@@ -253,7 +260,7 @@ pub struct HdfsConnection {
     /// providing information about the HDFS cluster.
     /// See also the [Stackable Operator for HDFS](DOCS_BASE_URL_PLACEHOLDER/hdfs/) to learn
     /// more about setting up an HDFS cluster.
-    pub config_map: String,
+    pub config_map: ConfigMapName,
 }
 
 #[derive(Clone, Debug, Display, EnumString, EnumIter, Eq, Hash, Ord, PartialEq, PartialOrd)]

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

@@ -2,9 +2,10 @@ use serde::{Deserialize, Serialize};
 use stackable_operator::{
     commons::opa::OpaConfig,
     schemars::{self, JsonSchema},
+    v2::types::kubernetes::SecretClassName,
 };
 
-#[derive(Clone, Debug, Deserialize, Eq, Hash, JsonSchema, PartialEq, Serialize)]
+#[derive(Clone, Debug, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
 #[serde(rename_all = "camelCase")]
 pub struct AuthenticationConfig {
     /// Kerberos configuration.
@@ -19,9 +20,9 @@ pub struct AuthorizationConfig {
     pub opa: Option<OpaConfig>,
 }
 
-#[derive(Clone, Debug, Deserialize, Eq, Hash, JsonSchema, PartialEq, Serialize)]
+#[derive(Clone, Debug, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
 #[serde(rename_all = "camelCase")]
 pub struct KerberosConfig {
     /// Name of the SecretClass providing the keytab for the HBase services.
-    pub secret_class: String,
+    pub secret_class: SecretClassName,
 }

rust/operator-binary/src/main.rs

@@ -196,7 +196,7 @@ fn references_config_map(
     };
 
     match &hive.spec.cluster_config.hdfs {
-        Some(hdfs_connection) => hdfs_connection.config_map == config_map.name_any(),
+        Some(hdfs_connection) => hdfs_connection.config_map.as_ref() == config_map.name_any(),
         None => false,
     }
 }