refactor: move jvm config to controller/build and remove filename constants

Author: maltesander

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

@@ -40,7 +40,6 @@ use crate::{
 };
 
 mod command;
-mod config;
 pub mod crd;
 mod framework;
 mod listener;

rust/operator-binary/src/main.rs

@@ -65,7 +65,6 @@ use strum::{EnumDiscriminants, IntoStaticStr};
 use crate::{
     APP_NAME, OPERATOR_NAME, ObjectRef,
     command::create_init_container_command_args,
-    config::jvm::{construct_non_heap_jvm_args, construct_zk_server_heap_env},
     crd::{
         JMX_METRICS_PORT_NAME, METRICS_PROVIDER_HTTP_PORT_NAME, STACKABLE_CONFIG_DIR,
         STACKABLE_DATA_DIR, STACKABLE_LOG_CONFIG_DIR, STACKABLE_LOG_DIR, STACKABLE_RW_CONFIG_DIR,
@@ -80,6 +79,10 @@ use crate::{
         self, build_server_rolegroup_headless_service, build_server_rolegroup_metrics_service,
     },
     utils::build_recommended_labels,
+    zk_controller::build::{
+        jvm::{construct_non_heap_jvm_args, construct_zk_server_heap_env},
+        properties::ConfigFileName,
+    },
 };
 
 pub(crate) mod build;
@@ -231,7 +234,7 @@ pub enum Error {
     },
 
     #[snafu(display("failed to construct JVM arguments"))]
-    ConstructJvmArguments { source: crate::config::jvm::Error },
+    ConstructJvmArguments { source: build::jvm::Error },
 
     #[snafu(display("failed to apply group listener"))]
     ApplyGroupListener {
@@ -656,10 +659,11 @@ fn build_server_rolegroup_statefulset(
             {remove_vector_shutdown_file_command}
             prepare_signal_handlers
             containerdebug --output={STACKABLE_LOG_DIR}/containerdebug-state.json --loop &
-            bin/zkServer.sh start-foreground {STACKABLE_RW_CONFIG_DIR}/zoo.cfg &
+            bin/zkServer.sh start-foreground {STACKABLE_RW_CONFIG_DIR}/{zoo_cfg} &
             wait_for_termination $!
             {create_vector_shutdown_file_command}
             ",
+            zoo_cfg = ConfigFileName::ZooCfg,
             remove_vector_shutdown_file_command =
                 remove_vector_shutdown_file_command(STACKABLE_LOG_DIR),
             create_vector_shutdown_file_command =

rust/operator-binary/src/zk_controller.rs

@@ -7,4 +7,5 @@
 
 pub mod config_map;
 pub mod discovery;
+pub mod jvm;
 pub mod properties;

rust/operator-binary/src/zk_controller/build.rs

@@ -4,22 +4,14 @@ use stackable_operator::{
     role_utils::{self, JvmArgumentOverrides},
 };
 
+use super::properties::ConfigFileName;
 use crate::crd::{
     JMX_METRICS_PORT, LoggingFramework, STACKABLE_CONFIG_DIR, STACKABLE_LOG_CONFIG_DIR,
     ZookeeperServerRoleType, logging_framework, v1alpha1::ZookeeperConfig,
 };
 
 const JAVA_HEAP_FACTOR: f32 = 0.8;
 
-/// The JVM security properties file the operator writes into the rolegroup
-/// ConfigMap (see `zk_controller::build::properties::ConfigFileName`).
-const JVM_SECURITY_PROPERTIES_FILE: &str = "security.properties";
-
-/// The log config files the JVM is pointed at via system properties. These are
-/// written by `zk_controller::build::properties::logging`.
-const LOG4J_CONFIG_FILE: &str = "log4j.properties";
-const LOGBACK_CONFIG_FILE: &str = "logback.xml";
-
 #[derive(Snafu, Debug)]
 pub enum Error {
     #[snafu(display("invalid memory resource configuration - missing default or value in crd?"))]
@@ -43,16 +35,21 @@ fn construct_jvm_args(
     let logging_framework = logging_framework(product_version);
 
     let jvm_args = vec![
-        format!("-Djava.security.properties={STACKABLE_CONFIG_DIR}/{JVM_SECURITY_PROPERTIES_FILE}"),
+        format!(
+            "-Djava.security.properties={STACKABLE_CONFIG_DIR}/{}",
+            ConfigFileName::SecurityProperties
+        ),
         format!(
             "-javaagent:/stackable/jmx/jmx_prometheus_javaagent.jar={JMX_METRICS_PORT}:/stackable/jmx/server.yaml"
         ),
         match logging_framework {
-            LoggingFramework::LOG4J => {
-                format!("-Dlog4j.configuration=file:{STACKABLE_LOG_CONFIG_DIR}/{LOG4J_CONFIG_FILE}")
-            }
+            LoggingFramework::LOG4J => format!(
+                "-Dlog4j.configuration=file:{STACKABLE_LOG_CONFIG_DIR}/{config_file}",
+                config_file = ConfigFileName::Log4jProperties
+            ),
             LoggingFramework::LOGBACK => format!(
-                "-Dlogback.configurationFile={STACKABLE_LOG_CONFIG_DIR}/{LOGBACK_CONFIG_FILE}"
+                "-Dlogback.configurationFile={STACKABLE_LOG_CONFIG_DIR}/{config_file}",
+                config_file = ConfigFileName::LogbackXml
             ),
         },
     ];

rust/operator-binary/src/config/jvm.rs …or-binary/src/zk_controller/build/jvm.rsrust/operator-binary/src/config/jvm.rs renamed to rust/operator-binary/src/zk_controller/build/jvm.rs rust/operator-binary/src/config/jvm.rs renamed to rust/operator-binary/src/zk_controller/build/jvm.rs

@@ -13,12 +13,9 @@ use stackable_operator::{
     role_utils::RoleGroupRef,
 };
 
+use super::ConfigFileName;
 use crate::crd::{LoggingFramework, STACKABLE_LOG_DIR, v1alpha1};
 
-/// The logback config file name (when the product uses the LOGBACK framework).
-pub const LOGBACK_CONFIG_FILE: &str = "logback.xml";
-/// The log4j config file name (when the product uses the LOG4J framework).
-pub const LOG4J_CONFIG_FILE: &str = "log4j.properties";
 /// The file the ZooKeeper server logs are written to.
 pub const ZOOKEEPER_LOG_FILE: &str = "zookeeper.log4j.xml";
 
@@ -57,7 +54,7 @@ pub fn build(
         match framework {
             LoggingFramework::LOG4J => {
                 data.insert(
-                    LOG4J_CONFIG_FILE.to_string(),
+                    ConfigFileName::Log4jProperties.to_string(),
                     product_logging::framework::create_log4j_config(
                         &log_dir,
                         ZOOKEEPER_LOG_FILE,
@@ -69,7 +66,7 @@ pub fn build(
             }
             LoggingFramework::LOGBACK => {
                 data.insert(
-                    LOGBACK_CONFIG_FILE.to_string(),
+                    ConfigFileName::LogbackXml.to_string(),
                     product_logging::framework::create_logback_config(
                         &log_dir,
                         ZOOKEEPER_LOG_FILE,

rust/operator-binary/src/zk_controller/build/properties/logging.rs

@@ -14,4 +14,8 @@ pub enum ConfigFileName {
     ZooCfg,
     #[strum(serialize = "security.properties")]
     SecurityProperties,
+    #[strum(serialize = "log4j.properties")]
+    Log4jProperties,
+    #[strum(serialize = "logback.xml")]
+    LogbackXml,
 }