refactor: use SecretName, ListenerName, ConfigMapName

Author: maltesander

extra/crds.yaml

@@ -354,6 +354,9 @@ spec:
                                     properties:
                                       configMap:
                                         description: Name of the [discovery ConfigMap](https://docs.stackable.tech/home/nightly/concepts/service_discovery) providing information about the 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
@@ -638,6 +641,9 @@ spec:
                                     properties:
                                       configMap:
                                         description: Name of the [discovery ConfigMap](https://docs.stackable.tech/home/nightly/concepts/service_discovery) providing information about the 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
@@ -898,7 +904,10 @@ spec:
                           This setting controls:
                           - Which cert the servers should use to authenticate themselves against other servers
                           - Which ca.crt to use when validating the other server
+                        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
                       serverSecretClass:
                         default: tls
@@ -907,7 +916,10 @@ spec:
                           This setting controls:
                           - If TLS encryption is used at all
                           - Which cert the servers should use to authenticate themselves against the client
+                        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
                     type: object
                   vectorAggregatorConfigMapName:
@@ -916,7 +928,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:
                 - catalogLabelSelector
@@ -1529,6 +1544,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 coordinator.
+                        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:
@@ -3517,6 +3535,9 @@ spec:
                         properties:
                           configMap:
                             description: Name of the [discovery ConfigMap](https://docs.stackable.tech/home/nightly/concepts/service_discovery) providing information about the 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
@@ -3526,6 +3547,9 @@ spec:
                         properties:
                           configMap:
                             description: Name of the [discovery ConfigMap](https://docs.stackable.tech/home/nightly/concepts/service_discovery) providing information about the Hive 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
                         required:
                         - configMap
@@ -3787,6 +3811,9 @@ spec:
                         properties:
                           configMap:
                             description: Name of the [discovery ConfigMap](https://docs.stackable.tech/home/nightly/concepts/service_discovery) providing information about the 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
@@ -3796,6 +3823,9 @@ spec:
                         properties:
                           configMap:
                             description: Name of the [discovery ConfigMap](https://docs.stackable.tech/home/nightly/concepts/service_discovery) providing information about the Hive 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
                         required:
                         - configMap
@@ -3966,6 +3996,9 @@ spec:
                         properties:
                           configMap:
                             description: Name of the [discovery ConfigMap](https://docs.stackable.tech/home/nightly/concepts/service_discovery) providing information about the 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
@@ -3980,6 +4013,9 @@ spec:
                         properties:
                           configMap:
                             description: Name of the [discovery ConfigMap](https://docs.stackable.tech/home/nightly/concepts/service_discovery) providing information about the Hive 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
                         required:
                         - configMap

rust/operator-binary/src/catalog/commons.rs

@@ -37,7 +37,7 @@ impl ExtendCatalogConfig for MetastoreConnection {
         _trino_version: u16,
     ) -> Result<(), FromTrinoCatalogError> {
         let hive_cm: ConfigMap = client
-            .get(&self.config_map, catalog_namespace.as_ref())
+            .get(self.config_map.as_ref(), catalog_namespace.as_ref())
             .await
             .with_context(|_| FailedToGetDiscoveryConfigMapSnafu {
                 catalog: catalog_name.to_string(),

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

@@ -32,8 +32,8 @@ pub fn build_group_listener(
     recommended_labels: Labels,
     listener_class: String,
     listener_group_name: String,
-) -> Result<Listener, Error> {
-    Ok(Listener {
+) -> Listener {
+    Listener {
         metadata: ObjectMetaBuilder::new()
             .name_and_namespace(cluster)
             .name(listener_group_name)
@@ -46,7 +46,7 @@ pub fn build_group_listener(
             ..ListenerSpec::default()
         },
         status: None,
-    })
+    }
 }
 
 pub fn build_group_listener_pvc(

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

@@ -98,11 +98,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,
-    },
 }
 
 type Result<T, E = Error> = std::result::Result<T, E>;
@@ -208,10 +203,7 @@ pub fn validate(
         .spec
         .cluster_config
         .vector_aggregator_config_map_name
-        .as_deref()
-        .map(ConfigMapName::from_str)
-        .transpose()
-        .context(ParseVectorAggregatorConfigMapNameSnafu)?;
+        .clone();
 
     let mut role_group_configs: BTreeMap<TrinoRole, BTreeMap<RoleGroupName, TrinoRoleGroupConfig>> =
         BTreeMap::new();

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

@@ -39,7 +39,7 @@ pub fn get_affinity(
             .map(|hive_cluster_name| {
                 affinity_between_role_pods(
                     "hive",
-                    hive_cluster_name, // The discovery cm has the same name as the HiveCluster itself
+                    hive_cluster_name.as_ref(), // The discovery cm has the same name as the HiveCluster itself
                     "metastore",
                     50,
                 )
@@ -67,7 +67,7 @@ pub fn get_affinity(
             .map(|hdfs_cluster_name| {
                 affinity_between_role_pods(
                     "hdfs",
-                    hdfs_cluster_name, // The discovery cm has the same name as the HdfsCluster itself
+                    hdfs_cluster_name.as_ref(), // The discovery cm has the same name as the HdfsCluster itself
                     "datanode",
                     50,
                 )

rust/operator-binary/src/crd/catalog/commons.rs

@@ -1,16 +1,19 @@
 use serde::{Deserialize, Serialize};
-use stackable_operator::schemars::{self, JsonSchema};
+use stackable_operator::{
+    schemars::{self, JsonSchema},
+    v2::types::kubernetes::ConfigMapName,
+};
 
 #[derive(Clone, Debug, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
 #[serde(rename_all = "camelCase")]
 pub struct MetastoreConnection {
     /// Name of the [discovery ConfigMap](DOCS_BASE_URL_PLACEHOLDER/concepts/service_discovery) providing information about the Hive metastore.
-    pub config_map: String,
+    pub config_map: ConfigMapName,
 }
 
 #[derive(Clone, Debug, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
 #[serde(rename_all = "camelCase")]
 pub struct HdfsConnection {
     /// Name of the [discovery ConfigMap](DOCS_BASE_URL_PLACEHOLDER/concepts/service_discovery) providing information about the HDFS cluster.
-    pub config_map: String,
+    pub config_map: ConfigMapName,
 }

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

@@ -37,7 +37,7 @@ use stackable_operator::{
         role_group_utils::ResourceNames,
         role_utils::JavaCommonConfig,
         types::{
-            kubernetes::NamespaceName,
+            kubernetes::{ConfigMapName, ListenerClassName, NamespaceName, SecretClassName},
             operator::{ClusterName, RoleGroupName, RoleName},
         },
     },
@@ -174,7 +174,7 @@ pub mod versioned {
 
         /// This field controls which [ListenerClass](DOCS_BASE_URL_PLACEHOLDER/listener-operator/listenerclass.html) is used to expose the coordinator.
         #[serde(default = "coordinator_default_listener_class")]
-        pub listener_class: String,
+        pub listener_class: ListenerClassName,
     }
 
     #[derive(Clone, Debug, Default, Deserialize, Eq, JsonSchema, Merge, PartialEq, Serialize)]
@@ -292,7 +292,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, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
@@ -328,7 +328,7 @@ pub mod versioned {
             default = "tls_secret_class_default",
             skip_serializing_if = "Option::is_none"
         )]
-        pub server_secret_class: Option<String>,
+        pub server_secret_class: Option<SecretClassName>,
         /// Only affects internal communication. Use mutual verification between Trino nodes
         /// This setting controls:
         /// - Which cert the servers should use to authenticate themselves against other servers
@@ -337,7 +337,7 @@ pub mod versioned {
             default = "tls_secret_class_default",
             skip_serializing_if = "Option::is_none"
         )]
-        pub internal_secret_class: Option<String>,
+        pub internal_secret_class: Option<SecretClassName>,
     }
 
     #[derive(Clone, Debug, Default, JsonSchema, PartialEq, Fragment)]
@@ -379,8 +379,9 @@ impl Default for v1alpha1::TrinoCoordinatorRoleConfig {
     }
 }
 
-fn coordinator_default_listener_class() -> String {
-    "cluster-internal".to_string()
+fn coordinator_default_listener_class() -> ListenerClassName {
+    ListenerClassName::from_str("cluster-internal")
+        .expect("the default listener class name must be valid")
 }
 
 impl Default for v1alpha1::TrinoTls {
@@ -392,8 +393,11 @@ impl Default for v1alpha1::TrinoTls {
     }
 }
 
-fn tls_secret_class_default() -> Option<String> {
-    Some(TLS_DEFAULT_SECRET_CLASS.to_string())
+fn tls_secret_class_default() -> Option<SecretClassName> {
+    Some(
+        SecretClassName::from_str(TLS_DEFAULT_SECRET_CLASS)
+            .expect("the default TLS SecretClass name must be valid"),
+    )
 }
 
 #[derive(
@@ -419,7 +423,7 @@ pub enum TrinoRole {
 }
 
 impl TrinoRole {
-    pub fn listener_class_name(&self, trino: &v1alpha1::TrinoCluster) -> Option<String> {
+    pub fn listener_class_name(&self, trino: &v1alpha1::TrinoCluster) -> Option<ListenerClassName> {
         match self {
             Self::Coordinator => trino
                 .spec
@@ -606,7 +610,11 @@ impl v1alpha1::TrinoCluster {
     /// Return user provided server TLS settings
     pub fn get_server_tls(&self) -> Option<&str> {
         let spec: &v1alpha1::TrinoClusterSpec = &self.spec;
-        spec.cluster_config.tls.server_secret_class.as_deref()
+        spec.cluster_config
+            .tls
+            .server_secret_class
+            .as_ref()
+            .map(|secret_class| secret_class.as_ref())
     }
 
     /// Return if client TLS should be set depending on settings for authentication and client TLS.
@@ -617,7 +625,11 @@ impl v1alpha1::TrinoCluster {
     /// Return user provided internal TLS settings.
     pub fn get_internal_tls(&self) -> Option<&str> {
         let spec: &v1alpha1::TrinoClusterSpec = &self.spec;
-        spec.cluster_config.tls.internal_secret_class.as_deref()
+        spec.cluster_config
+            .tls
+            .internal_secret_class
+            .as_ref()
+            .map(|secret_class| secret_class.as_ref())
     }
 }
 

rust/operator-binary/src/trino_controller.rs

@@ -150,11 +150,6 @@ pub enum Error {
         source: stackable_operator::cluster_resources::Error,
     },
 
-    #[snafu(display("failed to configure listener"))]
-    ListenerConfiguration {
-        source: build::resource::listener::Error,
-    },
-
     #[snafu(display("failed to create internal secret"))]
     CreateInternalSecret {
         source: random_secret_creation::Error,
@@ -369,8 +364,7 @@ pub async fn reconcile_trino(
                 validated_cluster.recommended_labels(trino_role, "none"),
                 listener_class.to_string(),
                 listener_group_name,
-            )
-            .context(ListenerConfigurationSnafu)?;
+            );
 
             cluster_resources
                 .add(client, role_group_listener)