moved validated structs to controller/mod.rs, renamed controller -> trino_controller, pass through validated cluster

Author: adwk67

rust/operator-binary/src/authentication/password/file.rs

@@ -17,7 +17,9 @@ use stackable_operator::{
     utils::COMMON_BASH_TRAP_FUNCTIONS,
 };
 
-use crate::{authentication::password::PASSWORD_AUTHENTICATOR_NAME, controller::STACKABLE_LOG_DIR};
+use crate::{
+    authentication::password::PASSWORD_AUTHENTICATOR_NAME, trino_controller::STACKABLE_LOG_DIR,
+};
 
 // mounts
 const PASSWORD_DB_VOLUME_NAME: &str = "users";

rust/operator-binary/src/command.rs

@@ -10,13 +10,13 @@ use crate::{
     authentication::TrinoAuthenticationConfig,
     catalog::config::CatalogConfig,
     config::{client_protocol, fault_tolerant_execution},
-    controller::{STACKABLE_LOG_CONFIG_DIR, STACKABLE_LOG_DIR},
     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, v1alpha1,
     },
+    trino_controller::{STACKABLE_LOG_CONFIG_DIR, STACKABLE_LOG_DIR},
 };
 
 // TODO: replace with build::properties::ConfigFileName once command.rs moves under build/

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

@@ -68,7 +68,7 @@ pub fn build_rolegroup_config_map(
     role: &TrinoRole,
     rolegroup_ref: &RoleGroupRef<v1alpha1::TrinoCluster>,
     cluster_info: &KubernetesClusterInfo,
-    recommended_labels: &ObjectLabels<'_, v1alpha1::TrinoCluster>,
+    recommended_labels: &ObjectLabels<'_, ValidatedCluster>,
 ) -> Result<ConfigMap> {
     let role_group_configs =
         cluster
@@ -217,7 +217,7 @@ pub fn build_rolegroup_config_map(
 pub fn build_rolegroup_catalog_config_map(
     cluster: &ValidatedCluster,
     rolegroup_ref: &RoleGroupRef<v1alpha1::TrinoCluster>,
-    recommended_labels: &ObjectLabels<'_, v1alpha1::TrinoCluster>,
+    recommended_labels: &ObjectLabels<'_, ValidatedCluster>,
 ) -> Result<ConfigMap> {
     ConfigMapBuilder::new()
         .metadata(

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

@@ -0,0 +1,132 @@
+//! Controller-level vocabulary: the [`ValidatedCluster`] type produced by the [`validate`] step
+//! and consumed by the [`build`] steps, plus the `dereference` / `validate` / `build` sub-modules.
+
+use std::collections::BTreeMap;
+
+use stackable_operator::{
+    commons::product_image_selection::ResolvedProductImage,
+    kube::{Resource, api::ObjectMeta},
+    role_utils::JvmArgumentOverrides,
+    v2::types::{
+        kubernetes::{NamespaceName, Uid},
+        operator::ClusterName,
+    },
+};
+
+use crate::{
+    authentication::TrinoAuthenticationConfig,
+    authorization::opa::TrinoOpaConfig,
+    catalog::config::CatalogConfig,
+    config::{
+        client_protocol::ResolvedClientProtocolConfig,
+        fault_tolerant_execution::ResolvedFaultTolerantExecutionConfig,
+    },
+    crd::{TrinoRole, discovery::TrinoPodRef, v1alpha1},
+};
+
+pub(crate) mod build;
+pub(crate) mod dereference;
+pub(crate) mod validate;
+
+pub use validate::{RoleGroupName, TrinoRoleGroupConfig};
+
+#[derive(Clone, Debug)]
+pub struct ValidatedTls {
+    pub server: Option<String>,
+    pub internal: Option<String>,
+}
+
+/// Cluster-wide settings, grouped to parallel `spec.clusterConfig` CRD.
+#[derive(Clone, Debug)]
+pub struct ValidatedClusterConfig {
+    pub tls: ValidatedTls,
+    pub authentication: TrinoAuthenticationConfig,
+    pub authentication_enabled: bool,
+    pub authorization: Option<TrinoOpaConfig>,
+    pub fault_tolerant_execution: Option<ResolvedFaultTolerantExecutionConfig>,
+    pub client_protocol: Option<ResolvedClientProtocolConfig>,
+    pub coordinator_pod_refs: Vec<TrinoPodRef>,
+    pub catalogs: Vec<CatalogConfig>,
+}
+
+/// The validated TrinoCluster. The output of the validate step.
+#[derive(Clone, Debug)]
+pub struct ValidatedCluster {
+    /// Metadata mirroring the source [`v1alpha1::TrinoCluster`] (name, namespace and UID).
+    ///
+    /// Kept private and only exposed through the [`Resource`] implementation, so that a
+    /// `ValidatedCluster` can be used directly as the owner of generated objects (e.g. to set
+    /// owner references) without threading the raw `TrinoCluster` through the build step.
+    metadata: ObjectMeta,
+    pub name: ClusterName,
+    pub namespace: NamespaceName,
+    pub uid: Uid,
+    pub image: ResolvedProductImage,
+    pub product_version: u16,
+    pub cluster_config: ValidatedClusterConfig,
+    pub role_group_configs: BTreeMap<TrinoRole, BTreeMap<RoleGroupName, TrinoRoleGroupConfig>>,
+    /// Role-level JVM argument overrides per role. Required to render `jvm.config` in the build
+    /// step without access to the raw [`v1alpha1::TrinoCluster`] (the role-group level overrides
+    /// are carried by [`TrinoRoleGroupConfig::product_specific_common_config`]).
+    pub role_jvm_argument_overrides: BTreeMap<TrinoRole, JvmArgumentOverrides>,
+}
+
+impl ValidatedCluster {
+    #[allow(clippy::too_many_arguments)]
+    pub fn new(
+        name: ClusterName,
+        namespace: NamespaceName,
+        uid: Uid,
+        image: ResolvedProductImage,
+        product_version: u16,
+        cluster_config: ValidatedClusterConfig,
+        role_group_configs: BTreeMap<TrinoRole, BTreeMap<RoleGroupName, TrinoRoleGroupConfig>>,
+        role_jvm_argument_overrides: BTreeMap<TrinoRole, JvmArgumentOverrides>,
+    ) -> Self {
+        Self {
+            metadata: ObjectMeta {
+                name: Some(name.to_string()),
+                namespace: Some(namespace.to_string()),
+                uid: Some(uid.to_string()),
+                ..ObjectMeta::default()
+            },
+            name,
+            namespace,
+            uid,
+            image,
+            product_version,
+            cluster_config,
+            role_group_configs,
+            role_jvm_argument_overrides,
+        }
+    }
+}
+
+impl Resource for ValidatedCluster {
+    type DynamicType = <v1alpha1::TrinoCluster as Resource>::DynamicType;
+    type Scope = <v1alpha1::TrinoCluster as Resource>::Scope;
+
+    fn kind(dt: &Self::DynamicType) -> std::borrow::Cow<'_, str> {
+        v1alpha1::TrinoCluster::kind(dt)
+    }
+
+    fn group(dt: &Self::DynamicType) -> std::borrow::Cow<'_, str> {
+        v1alpha1::TrinoCluster::group(dt)
+    }
+
+    fn version(dt: &Self::DynamicType) -> std::borrow::Cow<'_, str> {
+        v1alpha1::TrinoCluster::version(dt)
+    }
+
+    fn plural(dt: &Self::DynamicType) -> std::borrow::Cow<'_, str> {
+        v1alpha1::TrinoCluster::plural(dt)
+    }
+
+    fn meta(&self) -> &ObjectMeta {
+        &self.metadata
+    }
+
+    fn meta_mut(&mut self) -> &mut ObjectMeta {
+        &mut self.metadata
+    }
+}

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

@@ -8,29 +8,18 @@ use std::{collections::BTreeMap, str::FromStr};
 use snafu::{ResultExt, Snafu};
 use stackable_operator::{
     cli::OperatorEnvironmentOptions,
-    commons::product_image_selection::{self, ResolvedProductImage},
-    kube::{Resource, ResourceExt as _, api::ObjectMeta},
+    commons::product_image_selection,
+    kube::ResourceExt as _,
     role_utils::{GenericRoleConfig, JavaCommonConfig, JvmArgumentOverrides},
-    v2::{
-        controller_utils::{get_cluster_name, get_namespace, get_uid},
-        types::{
-            kubernetes::{NamespaceName, Uid},
-            operator::ClusterName,
-        },
-    },
+    v2::controller_utils::{get_cluster_name, get_namespace, get_uid},
 };
 use strum::{EnumDiscriminants, IntoEnumIterator, IntoStaticStr};
 
+use super::{ValidatedCluster, ValidatedClusterConfig, ValidatedTls};
 use crate::{
     authentication::{self, TrinoAuthenticationConfig, TrinoAuthenticationTypes},
-    authorization::opa::TrinoOpaConfig,
-    catalog::config::CatalogConfig,
-    config::{
-        client_protocol::ResolvedClientProtocolConfig,
-        fault_tolerant_execution::ResolvedFaultTolerantExecutionConfig,
-    },
     controller::dereference::DereferencedObjects,
-    crd::{TrinoRole, discovery::TrinoPodRef, v1alpha1},
+    crd::{TrinoRole, v1alpha1},
     framework::role_utils::with_validated_config,
 };
 
@@ -98,107 +87,6 @@ pub type TrinoRoleGroupConfig = crate::framework::role_utils::RoleGroupConfig<
     v1alpha1::TrinoConfigOverrides,
 >;
 
-#[derive(Clone, Debug)]
-pub struct ValidatedTls {
-    pub server: Option<String>,
-    pub internal: Option<String>,
-}
-
-/// Cluster-wide settings, grouped to parallel `spec.clusterConfig` CRD.
-#[derive(Clone, Debug)]
-pub struct ValidatedClusterConfig {
-    pub tls: ValidatedTls,
-    pub authentication: TrinoAuthenticationConfig,
-    pub authentication_enabled: bool,
-    pub authorization: Option<TrinoOpaConfig>,
-    pub fault_tolerant_execution: Option<ResolvedFaultTolerantExecutionConfig>,
-    pub client_protocol: Option<ResolvedClientProtocolConfig>,
-    pub coordinator_pod_refs: Vec<TrinoPodRef>,
-    pub catalogs: Vec<CatalogConfig>,
-}
-
-/// The validated TrinoCluster. The output of the validate step.
-#[derive(Clone, Debug)]
-pub struct ValidatedCluster {
-    /// Metadata mirroring the source [`v1alpha1::TrinoCluster`] (name, namespace and UID).
-    ///
-    /// Kept private and only exposed through the [`Resource`] implementation, so that a
-    /// `ValidatedCluster` can be used directly as the owner of generated objects (e.g. to set
-    /// owner references) without threading the raw `TrinoCluster` through the build step.
-    metadata: ObjectMeta,
-    pub name: ClusterName,
-    pub namespace: NamespaceName,
-    pub uid: Uid,
-    pub image: ResolvedProductImage,
-    pub product_version: u16,
-    pub cluster_config: ValidatedClusterConfig,
-    pub role_group_configs: BTreeMap<TrinoRole, BTreeMap<RoleGroupName, TrinoRoleGroupConfig>>,
-    /// Role-level JVM argument overrides per role. Required to render `jvm.config` in the build
-    /// step without access to the raw [`v1alpha1::TrinoCluster`] (the role-group level overrides
-    /// are carried by [`TrinoRoleGroupConfig::product_specific_common_config`]).
-    pub role_jvm_argument_overrides: BTreeMap<TrinoRole, JvmArgumentOverrides>,
-}
-
-impl ValidatedCluster {
-    #[allow(clippy::too_many_arguments)]
-    pub fn new(
-        name: ClusterName,
-        namespace: NamespaceName,
-        uid: Uid,
-        image: ResolvedProductImage,
-        product_version: u16,
-        cluster_config: ValidatedClusterConfig,
-        role_group_configs: BTreeMap<TrinoRole, BTreeMap<RoleGroupName, TrinoRoleGroupConfig>>,
-        role_jvm_argument_overrides: BTreeMap<TrinoRole, JvmArgumentOverrides>,
-    ) -> Self {
-        Self {
-            metadata: ObjectMeta {
-                name: Some(name.to_string()),
-                namespace: Some(namespace.to_string()),
-                uid: Some(uid.to_string()),
-                ..ObjectMeta::default()
-            },
-            name,
-            namespace,
-            uid,
-            image,
-            product_version,
-            cluster_config,
-            role_group_configs,
-            role_jvm_argument_overrides,
-        }
-    }
-}
-
-impl Resource for ValidatedCluster {
-    type DynamicType = <v1alpha1::TrinoCluster as Resource>::DynamicType;
-    type Scope = <v1alpha1::TrinoCluster as Resource>::Scope;
-
-    fn kind(dt: &Self::DynamicType) -> std::borrow::Cow<'_, str> {
-        v1alpha1::TrinoCluster::kind(dt)
-    }
-
-    fn group(dt: &Self::DynamicType) -> std::borrow::Cow<'_, str> {
-        v1alpha1::TrinoCluster::group(dt)
-    }
-
-    fn version(dt: &Self::DynamicType) -> std::borrow::Cow<'_, str> {
-        v1alpha1::TrinoCluster::version(dt)
-    }
-
-    fn plural(dt: &Self::DynamicType) -> std::borrow::Cow<'_, str> {
-        v1alpha1::TrinoCluster::plural(dt)
-    }
-
-    fn meta(&self) -> &ObjectMeta {
-        &self.metadata
-    }
-
-    fn meta_mut(&mut self) -> &mut ObjectMeta {
-        &mut self.metadata
-    }
-}
-
 /// Validates the cluster spec and dereferenced inputs.
 pub fn validate(
     trino: &v1alpha1::TrinoCluster,
@@ -211,7 +99,7 @@ pub fn validate(
         .spec
         .image
         .resolve(
-            super::CONTAINER_IMAGE_BASE_NAME,
+            crate::trino_controller::CONTAINER_IMAGE_BASE_NAME,
             &operator_environment.image_repository,
             crate::built_info::PKG_VERSION,
         )

rust/operator-binary/src/main.rs

@@ -33,12 +33,12 @@ use stackable_operator::{
 };
 
 use crate::{
-    controller::{FULL_CONTROLLER_NAME, OPERATOR_NAME},
     crd::{
         TrinoCluster, TrinoClusterVersion,
         catalog::{TrinoCatalog, TrinoCatalogVersion},
         v1alpha1,
     },
+    trino_controller::{FULL_CONTROLLER_NAME, OPERATOR_NAME},
     webhooks::conversion::create_webhook_server,
 };
 
@@ -53,6 +53,7 @@ mod framework;
 mod listener;
 mod operations;
 mod service;
+mod trino_controller;
 mod webhooks;
 
 mod built_info {
@@ -195,9 +196,9 @@ async fn main() -> anyhow::Result<()> {
                 )
                 .graceful_shutdown_on(sigterm_watcher.handle())
                 .run(
-                    controller::reconcile_trino,
-                    controller::error_policy,
-                    Arc::new(controller::Ctx {
+                    trino_controller::reconcile_trino,
+                    trino_controller::error_policy,
+                    Arc::new(trino_controller::Ctx {
                         client: client.clone(),
                         operator_environment,
                     }),

rust/operator-binary/src/operations/pdb.rs

@@ -7,8 +7,8 @@ use stackable_operator::{
 };
 
 use crate::{
-    controller::{CONTROLLER_NAME, OPERATOR_NAME},
     crd::{APP_NAME, TrinoRole, v1alpha1},
+    trino_controller::{CONTROLLER_NAME, OPERATOR_NAME},
 };
 
 #[derive(Snafu, Debug)]