Document why we have a limit of 40 chars

sbernauer · sbernauer · commit f8f5d7cd0822 · 2026-07-07T11:27:29.000+02:00
diff --git a/rust/operator-binary/src/catalog/black_hole.rs b/rust/operator-binary/src/catalog/black_hole.rs
@@ -1,9 +1,9 @@
 use async_trait::async_trait;
 use stackable_operator::{client::Client, v2::types::kubernetes::NamespaceName};
 
-use super::{FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig};
 use crate::{
-    controller::dereference::TrinoCatalogName, crd::catalog::black_hole::BlackHoleConnector,
+    catalog::{FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig},
+    crd::catalog::{TrinoCatalogName, black_hole::BlackHoleConnector},
 };
 
 pub const CONNECTOR_NAME: &str = "blackhole";
diff --git a/rust/operator-binary/src/catalog/commons.rs b/rust/operator-binary/src/catalog/commons.rs
@@ -8,21 +8,23 @@ use stackable_operator::{
     v2::types::kubernetes::NamespaceName,
 };
 
-use super::{
-    ExtendCatalogConfig, FromTrinoCatalogError,
-    config::CatalogConfig,
-    from_trino_catalog_error::{
-        ConfigureS3Snafu, FailedToGetDiscoveryConfigMapDataKeySnafu,
-        FailedToGetDiscoveryConfigMapDataSnafu, FailedToGetDiscoveryConfigMapSnafu,
-        S3TlsNoVerificationNotSupportedSnafu, S3TlsRequiredSnafu,
-    },
-};
 use crate::{
+    catalog::{
+        ExtendCatalogConfig, FromTrinoCatalogError,
+        config::CatalogConfig,
+        from_trino_catalog_error::{
+            ConfigureS3Snafu, FailedToGetDiscoveryConfigMapDataKeySnafu,
+            FailedToGetDiscoveryConfigMapDataSnafu, FailedToGetDiscoveryConfigMapSnafu,
+            S3TlsNoVerificationNotSupportedSnafu, S3TlsRequiredSnafu,
+        },
+    },
     config,
-    controller::dereference::TrinoCatalogName,
     crd::{
         CONFIG_DIR_NAME,
-        catalog::commons::{HdfsConnection, MetastoreConnection},
+        catalog::{
+            TrinoCatalogName,
+            commons::{HdfsConnection, MetastoreConnection},
+        },
     },
 };
 
diff --git a/rust/operator-binary/src/catalog/config.rs b/rust/operator-binary/src/catalog/config.rs
@@ -8,10 +8,9 @@ use stackable_operator::{
     v2::types::kubernetes::NamespaceName,
 };
 
-use super::{FromTrinoCatalogError, ToCatalogConfig};
 use crate::{
-    controller::dereference::TrinoCatalogName,
-    crd::catalog::{TrinoCatalogConnector, v1alpha1},
+    catalog::{FromTrinoCatalogError, ToCatalogConfig},
+    crd::catalog::{TrinoCatalogConnector, TrinoCatalogName, v1alpha1},
 };
 
 #[derive(Clone, Debug)]
diff --git a/rust/operator-binary/src/catalog/delta_lake.rs b/rust/operator-binary/src/catalog/delta_lake.rs
@@ -1,9 +1,9 @@
 use async_trait::async_trait;
 use stackable_operator::{client::Client, v2::types::kubernetes::NamespaceName};
 
-use super::{ExtendCatalogConfig, FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig};
 use crate::{
-    controller::dereference::TrinoCatalogName, crd::catalog::delta_lake::DeltaLakeConnector,
+    catalog::{ExtendCatalogConfig, FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig},
+    crd::catalog::{TrinoCatalogName, delta_lake::DeltaLakeConnector},
 };
 
 pub const CONNECTOR_NAME: &str = "delta_lake";
diff --git a/rust/operator-binary/src/catalog/generic.rs b/rust/operator-binary/src/catalog/generic.rs
@@ -1,10 +1,12 @@
 use async_trait::async_trait;
 use stackable_operator::{client::Client, v2::types::kubernetes::NamespaceName};
 
-use super::{FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig};
 use crate::{
-    controller::dereference::TrinoCatalogName,
-    crd::catalog::generic::{GenericConnector, Property},
+    catalog::{FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig},
+    crd::catalog::{
+        TrinoCatalogName,
+        generic::{GenericConnector, Property},
+    },
 };
 
 #[async_trait]
diff --git a/rust/operator-binary/src/catalog/google_sheet.rs b/rust/operator-binary/src/catalog/google_sheet.rs
@@ -5,10 +5,12 @@ use stackable_operator::{
     v2::types::kubernetes::NamespaceName,
 };
 
-use super::{FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig};
 use crate::{
-    controller::dereference::TrinoCatalogName,
-    crd::{CONFIG_DIR_NAME, catalog::google_sheet::GoogleSheetConnector},
+    catalog::{FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig},
+    crd::{
+        CONFIG_DIR_NAME,
+        catalog::{TrinoCatalogName, google_sheet::GoogleSheetConnector},
+    },
 };
 
 pub const CONNECTOR_NAME: &str = "gsheets";
@@ -24,9 +26,9 @@ impl ToCatalogConfig for GoogleSheetConnector {
     ) -> Result<CatalogConfig, FromTrinoCatalogError> {
         let mut config = CatalogConfig::new(catalog_name, CONNECTOR_NAME);
 
-        let volume_name = format!("{catalog_name}-google-sheets-credentials");
+        let volume_name = format!("{catalog_name}-sheets-credentials");
         let google_sheets_credentials_dir =
-            format!("{CONFIG_DIR_NAME}/catalog/{catalog_name}/google-sheets-credentials/");
+            format!("{CONFIG_DIR_NAME}/catalog/{catalog_name}/sheets-credentials/");
 
         config.volumes.push(
             VolumeBuilder::new(&volume_name)
diff --git a/rust/operator-binary/src/catalog/hive.rs b/rust/operator-binary/src/catalog/hive.rs
@@ -1,8 +1,10 @@
 use async_trait::async_trait;
 use stackable_operator::{client::Client, v2::types::kubernetes::NamespaceName};
 
-use super::{ExtendCatalogConfig, FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig};
-use crate::{controller::dereference::TrinoCatalogName, crd::catalog::hive::HiveConnector};
+use crate::{
+    catalog::{ExtendCatalogConfig, FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig},
+    crd::catalog::{TrinoCatalogName, hive::HiveConnector},
+};
 
 pub const CONNECTOR_NAME: &str = "hive";
 
diff --git a/rust/operator-binary/src/catalog/iceberg.rs b/rust/operator-binary/src/catalog/iceberg.rs
@@ -1,8 +1,10 @@
 use async_trait::async_trait;
 use stackable_operator::{client::Client, v2::types::kubernetes::NamespaceName};
 
-use super::{ExtendCatalogConfig, FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig};
-use crate::{controller::dereference::TrinoCatalogName, crd::catalog::iceberg::IcebergConnector};
+use crate::{
+    catalog::{ExtendCatalogConfig, FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig},
+    crd::catalog::{TrinoCatalogName, iceberg::IcebergConnector},
+};
 
 pub const CONNECTOR_NAME: &str = "iceberg";
 
diff --git a/rust/operator-binary/src/catalog/mod.rs b/rust/operator-binary/src/catalog/mod.rs
@@ -14,9 +14,8 @@ use async_trait::async_trait;
 use snafu::Snafu;
 use stackable_operator::{client::Client, v2::types::kubernetes::NamespaceName};
 
-use crate::controller::dereference::TrinoCatalogName;
-
 use self::config::CatalogConfig;
+use crate::crd::catalog::TrinoCatalogName;
 
 #[derive(Debug, Snafu)]
 #[snafu(module)]
diff --git a/rust/operator-binary/src/catalog/postgresql.rs b/rust/operator-binary/src/catalog/postgresql.rs
@@ -5,10 +5,12 @@ use stackable_operator::{
     v2::types::kubernetes::NamespaceName,
 };
 
-use super::{FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig};
 use crate::{
-    catalog::from_trino_catalog_error::GetPostgresConnectionDetailsSnafu,
-    controller::dereference::TrinoCatalogName, crd::catalog::postgresql::PostgresqlConnector,
+    catalog::{
+        FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig,
+        from_trino_catalog_error::GetPostgresConnectionDetailsSnafu,
+    },
+    crd::catalog::{TrinoCatalogName, postgresql::PostgresqlConnector},
 };
 
 pub const CONNECTOR_NAME: &str = "postgresql";
diff --git a/rust/operator-binary/src/catalog/tpcds.rs b/rust/operator-binary/src/catalog/tpcds.rs
@@ -1,8 +1,10 @@
 use async_trait::async_trait;
 use stackable_operator::{client::Client, v2::types::kubernetes::NamespaceName};
 
-use super::{FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig};
-use crate::{controller::dereference::TrinoCatalogName, crd::catalog::tpcds::TpcdsConnector};
+use crate::{
+    catalog::{FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig},
+    crd::catalog::{TrinoCatalogName, tpcds::TpcdsConnector},
+};
 
 pub const CONNECTOR_NAME: &str = "tpcds";
 
diff --git a/rust/operator-binary/src/catalog/tpch.rs b/rust/operator-binary/src/catalog/tpch.rs
@@ -1,8 +1,10 @@
 use async_trait::async_trait;
 use stackable_operator::{client::Client, v2::types::kubernetes::NamespaceName};
 
-use super::{FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig};
-use crate::{controller::dereference::TrinoCatalogName, crd::catalog::tpch::TpchConnector};
+use crate::{
+    catalog::{FromTrinoCatalogError, ToCatalogConfig, config::CatalogConfig},
+    crd::catalog::{TrinoCatalogName, tpch::TpchConnector},
+};
 
 pub const CONNECTOR_NAME: &str = "tpch";
 
diff --git a/rust/operator-binary/src/controller/build/command.rs b/rust/operator-binary/src/controller/build/command.rs
@@ -12,15 +12,12 @@ use crate::{
     authentication::TrinoAuthenticationConfig,
     catalog::config::CatalogConfig,
     config::{client_protocol, fault_tolerant_execution},
-    controller::{
-        ValidatedCluster, ValidatedTrinoConfig, build::properties::ConfigFileName,
-        dereference::TrinoCatalogName,
-    },
+    controller::{ValidatedCluster, ValidatedTrinoConfig, build::properties::ConfigFileName},
     crd::{
         CONFIG_DIR_NAME, Container, RW_CONFIG_DIR_NAME, STACKABLE_CLIENT_TLS_DIR,
         STACKABLE_INTERNAL_TLS_DIR, STACKABLE_MOUNT_INTERNAL_TLS_DIR,
         STACKABLE_MOUNT_SERVER_TLS_DIR, STACKABLE_SERVER_TLS_DIR, STACKABLE_TLS_STORE_PASSWORD,
-        TrinoRole,
+        TrinoRole, catalog::TrinoCatalogName,
     },
     trino_controller::{STACKABLE_LOG_CONFIG_DIR, STACKABLE_LOG_DIR},
 };
diff --git a/rust/operator-binary/src/controller/dereference.rs b/rust/operator-binary/src/controller/dereference.rs
@@ -7,7 +7,6 @@ use std::{num::ParseIntError, str::FromStr};
 
 use snafu::{OptionExt, ResultExt, Snafu};
 use stackable_operator::{
-    attributed_string_type,
     client::Client,
     kube::runtime::reflector::{Lookup, ObjectRef},
     v2::controller_utils::get_namespace,
@@ -22,7 +21,8 @@ use crate::{
     },
     crd::{
         authentication::{ResolvedAuthenticationClassRef, resolve_authentication_classes},
-        catalog, v1alpha1,
+        catalog::{self, TrinoCatalogName},
+        v1alpha1,
     },
 };
 
@@ -70,19 +70,12 @@ pub enum Error {
     InvalidOpaConfig {
         source: stackable_operator::commons::opa::Error,
     },
-}
 
-attributed_string_type! {
-    TrinoCatalogName,
-    "The name of a TrinoCluster",
-    "lakehouse",
-    // Suffixes are added to produce resource names.
-    //
-    // 40 characters for catalog names should be sufficient and still allow the operators to append
-    // custom suffixes to build resource names.
-    (max_length = 40),
-    is_rfc_1035_label_name,
-    is_valid_label_value
+    #[snafu(display("invalid trino catalog name"))]
+    InvalidTrinoCatalogName {
+        source: stackable_operator::v2::macros::attributed_string_type::Error,
+        catalog_name: String,
+    },
 }
 
 type Result<T, E = Error> = std::result::Result<T, E>;
@@ -134,7 +127,8 @@ pub async fn dereference(
                 if replace_hyphens_with_underscores {
                     catalog_name = catalog_name.replace('-', "_");
                 }
-                TrinoCatalogName(catalog_name)
+                TrinoCatalogName::from_str(&catalog_name)
+                    .with_context(|_| InvalidTrinoCatalogNameSnafu { catalog_name })?
             }
         };
         let catalog_config = CatalogConfig::from_catalog(
diff --git a/rust/operator-binary/src/controller/mod.rs b/rust/operator-binary/src/controller/mod.rs
@@ -32,8 +32,7 @@ use crate::{
         client_protocol::ResolvedClientProtocolConfig,
         fault_tolerant_execution::ResolvedFaultTolerantExecutionConfig,
     },
-    controller::dereference::TrinoCatalogName,
-    crd::{APP_NAME, TrinoRole, discovery::TrinoPodRef, v1alpha1},
+    crd::{APP_NAME, TrinoRole, catalog::TrinoCatalogName, discovery::TrinoPodRef, v1alpha1},
     trino_controller::{CONTROLLER_NAME, OPERATOR_NAME},
 };
 
diff --git a/rust/operator-binary/src/controller/validate.rs b/rust/operator-binary/src/controller/validate.rs
@@ -26,14 +26,13 @@ use stackable_operator::{
 };
 use strum::{EnumDiscriminants, IntoEnumIterator, IntoStaticStr};
 
-use super::{
-    ValidatedCluster, ValidatedClusterConfig, ValidatedRoleConfig, ValidatedTls,
-    ValidatedTrinoConfig,
-};
 use crate::{
     authentication::{self, TrinoAuthenticationConfig, TrinoAuthenticationTypes},
-    controller::dereference::{DereferencedObjects, TrinoCatalogName},
-    crd::{Container, TrinoRole, v1alpha1},
+    controller::{
+        ValidatedCluster, ValidatedClusterConfig, ValidatedRoleConfig, ValidatedTls,
+        ValidatedTrinoConfig, dereference::DereferencedObjects,
+    },
+    crd::{Container, TrinoRole, catalog::TrinoCatalogName, v1alpha1},
 };
 
 #[derive(Snafu, Debug, EnumDiscriminants)]
diff --git a/rust/operator-binary/src/crd/catalog/mod.rs b/rust/operator-binary/src/crd/catalog/mod.rs
@@ -9,7 +9,7 @@ pub mod postgresql;
 pub mod tpcds;
 pub mod tpch;
 
-use std::collections::HashMap;
+use std::{collections::HashMap, str::FromStr};
 
 use black_hole::BlackHoleConnector;
 use generic::GenericConnector;
@@ -18,6 +18,7 @@ use hive::HiveConnector;
 use iceberg::IcebergConnector;
 use serde::{Deserialize, Serialize};
 use stackable_operator::{
+    attributed_string_type,
     kube::CustomResource,
     schemars::{self, JsonSchema},
     versioned::versioned,
@@ -132,6 +133,20 @@ pub enum TrinoCatalogConnector {
     Tpch(TpchConnector),
 }
 
+attributed_string_type! {
+    TrinoCatalogName,
+    "The name of a TrinoCluster",
+    "lakehouse",
+    // Suffixes are added to produce resource/volume names.
+    //
+    // 40 characters should be sufficient and still allow the operators to append custom suffixes.
+    // As of 2026-07 the longest suffix is for a volume name (63 characters limit) and is
+    // "-sheets-credentials" (19 characters).
+    (max_length = 40),
+    is_rfc_1035_label_name,
+    is_valid_label_value
+}
+
 #[cfg(test)]
 mod tests {
     use stackable_operator::versioned::test_utils::RoundtripTestData;
