refactor: move logging mod to controller, remove util mod

Author: maltesander

rust/operator-binary/src/config/command.rs

@@ -6,15 +6,29 @@ use stackable_operator::{
     utils::COMMON_BASH_TRAP_FUNCTIONS,
 };
 
-use crate::{
-    crd::{
-        KafkaPodDescriptor, STACKABLE_CONFIG_DIR, STACKABLE_KERBEROS_KRB5_PATH,
-        role::{broker::BROKER_PROPERTIES_FILE, controller::CONTROLLER_PROPERTIES_FILE},
-        security::KafkaTlsSecurity,
-    },
-    product_logging::{BROKER_ID_POD_MAP_DIR, STACKABLE_LOG_DIR},
+use crate::crd::{
+    BROKER_ID_POD_MAP_DIR, KafkaPodDescriptor, LOG4J_CONFIG_FILE, LOG4J2_CONFIG_FILE,
+    STACKABLE_CONFIG_DIR, STACKABLE_KERBEROS_KRB5_PATH, STACKABLE_LOG_CONFIG_DIR,
+    STACKABLE_LOG_DIR,
+    role::{broker::BROKER_PROPERTIES_FILE, controller::CONTROLLER_PROPERTIES_FILE},
+    security::KafkaTlsSecurity,
 };
 
+/// The JVM options selecting the Kafka log4j/log4j2 config file. Kafka 3.x uses log4j,
+/// Kafka 4.0 and higher use log4j2.
+pub fn kafka_log_opts(product_version: &str) -> String {
+    if product_version.starts_with("3.") {
+        format!("-Dlog4j.configuration=file:{STACKABLE_LOG_CONFIG_DIR}/{LOG4J_CONFIG_FILE}")
+    } else {
+        format!("-Dlog4j2.configurationFile=file:{STACKABLE_LOG_CONFIG_DIR}/{LOG4J2_CONFIG_FILE}")
+    }
+}
+
+/// The env var carrying the Kafka log4j options (see [`kafka_log_opts`]).
+pub fn kafka_log_opts_env_var() -> String {
+    "KAFKA_LOG4J_OPTS".to_string()
+}
+
 /// Returns the commands to start the main Kafka container
 pub fn broker_kafka_container_commands(
     kraft_mode: bool,

rust/operator-binary/src/controller.rs

@@ -15,7 +15,9 @@ use stackable_operator::{
         core::{DeserializeGuard, error_boundary},
         runtime::{controller::Action, reflector::ObjectRef},
     },
+    kvp::ObjectLabels,
     logging::controller::ReconcilerError,
+    memory::{BinaryMultiple, MemoryQuantity},
     role_utils::{GenericRoleConfig, RoleGroupRef},
     shared::time::Duration,
     status::condition::{
@@ -53,6 +55,34 @@ use crate::{
 pub const KAFKA_CONTROLLER_NAME: &str = "kafkacluster";
 pub const KAFKA_FULL_CONTROLLER_NAME: &str = concatcp!(KAFKA_CONTROLLER_NAME, '.', OPERATOR_NAME);
 
+/// The maximum size of a single Kafka log file before it is rotated.
+pub const MAX_KAFKA_LOG_FILES_SIZE: MemoryQuantity = MemoryQuantity {
+    value: 10.0,
+    unit: BinaryMultiple::Mebi,
+};
+
+/// Build recommended values for labels.
+///
+/// Generic over the owner `T` so the owner can be either the raw `KafkaCluster` or the
+/// [`ValidatedCluster`] (which also implements `Resource`).
+pub fn build_recommended_labels<'a, T>(
+    owner: &'a T,
+    controller_name: &'a str,
+    app_version: &'a str,
+    role: &'a str,
+    role_group: &'a str,
+) -> ObjectLabels<'a, T> {
+    ObjectLabels {
+        owner,
+        app_name: APP_NAME,
+        app_version,
+        operator_name: OPERATOR_NAME,
+        controller_name,
+        role,
+        role_group,
+    }
+}
+
 pub struct Ctx {
     pub client: stackable_operator::client::Client,
     pub operator_environment: OperatorEnvironmentOptions,

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

@@ -8,16 +8,17 @@ use stackable_operator::{
 };
 
 use crate::{
-    controller::{KAFKA_CONTROLLER_NAME, ValidatedCluster, ValidatedRoleGroupConfig},
+    controller::{
+        KAFKA_CONTROLLER_NAME, ValidatedCluster, ValidatedRoleGroupConfig,
+        build::properties::logging::role_group_config_map_data, build_recommended_labels,
+    },
     crd::{
         JVM_SECURITY_PROPERTIES_FILE, MetadataManager, STACKABLE_LISTENER_BOOTSTRAP_DIR,
         STACKABLE_LISTENER_BROKER_DIR,
         listener::{KafkaListenerConfig, node_address_cmd},
         role::AnyConfig,
         v1alpha1,
     },
-    product_logging::role_group_config_map_data,
-    utils::build_recommended_labels,
 };
 
 #[derive(Snafu, Debug)]

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

@@ -9,9 +9,8 @@ use stackable_operator::{
 };
 
 use crate::{
-    controller::{KAFKA_CONTROLLER_NAME, ValidatedCluster},
+    controller::{KAFKA_CONTROLLER_NAME, ValidatedCluster, build_recommended_labels},
     crd::{role::KafkaRole, v1alpha1},
-    utils::build_recommended_labels,
 };
 
 #[derive(Snafu, Debug)]

…t/operator-binary/src/product_logging.rs …c/controller/build/properties/logging.rsrust/operator-binary/src/product_logging.rs renamed to rust/operator-binary/src/controller/build/properties/logging.rs rust/operator-binary/src/product_logging.rs renamed to rust/operator-binary/src/controller/build/properties/logging.rs

@@ -1,3 +1,6 @@
+//! Renders the logging config files (`log4j.properties` / `log4j2.properties` and the
+//! Vector agent config) assembled into the rolegroup `ConfigMap`.
+
 use std::{borrow::Cow, collections::BTreeMap, fmt::Display};
 
 use stackable_operator::{
@@ -9,41 +12,21 @@ use stackable_operator::{
     role_utils::RoleGroupRef,
 };
 
-use crate::crd::{
-    role::{AnyConfig, broker::BrokerContainer, controller::ControllerContainer},
-    v1alpha1,
+use crate::{
+    controller::MAX_KAFKA_LOG_FILES_SIZE,
+    crd::{
+        LOG4J_CONFIG_FILE, LOG4J2_CONFIG_FILE, STACKABLE_LOG_DIR,
+        role::{AnyConfig, broker::BrokerContainer, controller::ControllerContainer},
+        v1alpha1,
+    },
 };
 
-pub const BROKER_ID_POD_MAP_DIR: &str = "/stackable/broker-id-pod-map";
-pub const STACKABLE_LOG_CONFIG_DIR: &str = "/stackable/log_config";
-pub const STACKABLE_LOG_DIR: &str = "/stackable/log";
-// log4j
-const LOG4J_CONFIG_FILE: &str = "log4j.properties";
 const KAFKA_LOG4J_FILE: &str = "kafka.log4j.xml";
-// log4j2
-const LOG4J2_CONFIG_FILE: &str = "log4j2.properties";
 const KAFKA_LOG4J2_FILE: &str = "kafka.log4j2.xml";
-// max size
-pub const MAX_KAFKA_LOG_FILES_SIZE: MemoryQuantity = MemoryQuantity {
-    value: 10.0,
-    unit: BinaryMultiple::Mebi,
-};
 
 const CONSOLE_CONVERSION_PATTERN_LOG4J: &str = "[%d] %p %m (%c)%n";
 const CONSOLE_CONVERSION_PATTERN_LOG4J2: &str = "%d{ISO8601} %p [%t] %c - %m%n";
 
-pub fn kafka_log_opts(product_version: &str) -> String {
-    if product_version.starts_with("3.") {
-        format!("-Dlog4j.configuration=file:{STACKABLE_LOG_CONFIG_DIR}/{LOG4J_CONFIG_FILE}")
-    } else {
-        format!("-Dlog4j2.configurationFile=file:{STACKABLE_LOG_CONFIG_DIR}/{LOG4J2_CONFIG_FILE}")
-    }
-}
-
-pub fn kafka_log_opts_env_var() -> String {
-    "KAFKA_LOG4J_OPTS".to_string()
-}
-
 /// Get the role group ConfigMap data with logging and Vector configurations
 pub fn role_group_config_map_data(
     product_version: &str,

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

@@ -2,6 +2,7 @@
 
 pub mod broker_properties;
 pub mod controller_properties;
+pub mod logging;
 
 use crate::crd::{KafkaPodDescriptor, role::KafkaRole};
 

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

@@ -60,6 +60,12 @@ pub const STACKABLE_CONFIG_DIR: &str = "/stackable/config";
 // kerberos
 pub const STACKABLE_KERBEROS_DIR: &str = "/stackable/kerberos";
 pub const STACKABLE_KERBEROS_KRB5_PATH: &str = "/stackable/kerberos/krb5.conf";
+// logging
+pub const STACKABLE_LOG_DIR: &str = "/stackable/log";
+pub const STACKABLE_LOG_CONFIG_DIR: &str = "/stackable/log_config";
+pub const BROKER_ID_POD_MAP_DIR: &str = "/stackable/broker-id-pod-map";
+pub const LOG4J_CONFIG_FILE: &str = "log4j.properties";
+pub const LOG4J2_CONFIG_FILE: &str = "log4j2.properties";
 
 #[derive(Snafu, Debug)]
 pub enum Error {

rust/operator-binary/src/main.rs

@@ -46,9 +46,7 @@ mod crd;
 mod framework;
 mod kerberos;
 mod operations;
-mod product_logging;
 mod resource;
-mod utils;
 mod webhooks;
 
 mod built_info {

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

@@ -4,9 +4,8 @@ use stackable_operator::{
 };
 
 use crate::{
-    controller::{KAFKA_CONTROLLER_NAME, ValidatedCluster},
+    controller::{KAFKA_CONTROLLER_NAME, ValidatedCluster, build_recommended_labels},
     crd::{role::broker::BrokerConfig, security::KafkaTlsSecurity, v1alpha1},
-    utils::build_recommended_labels,
 };
 
 #[derive(Snafu, Debug)]

rust/operator-binary/src/resource/service.rs

@@ -8,9 +8,8 @@ use stackable_operator::{
 };
 
 use crate::{
-    controller::{KAFKA_CONTROLLER_NAME, ValidatedCluster},
+    controller::{KAFKA_CONTROLLER_NAME, ValidatedCluster, build_recommended_labels},
     crd::{APP_NAME, METRICS_PORT, METRICS_PORT_NAME, security::KafkaTlsSecurity, v1alpha1},
-    utils::build_recommended_labels,
 };
 
 #[derive(Snafu, Debug)]