refactor: move jvm from config to build

Author: maltesander

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

@@ -1054,13 +1054,9 @@ mod test {
             role_group: tested_rolegroup_name.to_string(),
         };
 
-        let rg_configmap = build_rolegroup_config_map(
-            &cluster,
-            &DruidRole::Historical,
-            &rolegroup_ref,
-            &rg,
-        )
-        .expect("build rolegroup config map");
+        let rg_configmap =
+            build_rolegroup_config_map(&cluster, &DruidRole::Historical, &rolegroup_ref, &rg)
+                .expect("build rolegroup config map");
 
         let druid_segment_cache_property = rg_configmap
             .data

rust/operator-binary/src/controller.rs

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

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

@@ -37,10 +37,6 @@ use crate::{
     crd::{DruidRole, build_recommended_labels, build_string_list, v1alpha1},
 };
 
-// jvm.config is built by `config::jvm`, not a properties builder, so it is not part
-// of `ConfigFileName`.
-const JVM_CONFIG: &str = "jvm.config";
-
 // Druid `runtime.properties` config-property keys assembled into the rolegroup ConfigMap here.
 const EXTENSIONS_LOADLIST: &str = "druid.extensions.loadList";
 const ZOOKEEPER_CONNECTION_STRING: &str = "druid.zk.service.host";
@@ -237,7 +233,7 @@ pub fn build_rolegroup_config_map(
 
     // ----- jvm.config -----
     // Precomputed during validation; see `DruidRoleGroupConfig::jvm_config`.
-    cm_conf_data.insert(JVM_CONFIG.to_string(), rg.jvm_config.clone());
+    cm_conf_data.insert(ConfigFileName::JvmConfig.to_string(), rg.jvm_config.clone());
 
     // ----- security.properties -----
     {

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

@@ -5,15 +5,12 @@ use stackable_operator::{
     role_utils::{GenericRoleConfig, JavaCommonConfig, JvmArgumentOverrides, Role},
 };
 
+use super::properties::ConfigFileName;
 use crate::crd::{
     DruidConfigOverrides, DruidRole, RW_CONFIG_DIRECTORY, STACKABLE_TRUST_STORE,
     STACKABLE_TRUST_STORE_PASSWORD,
 };
 
-// File names not exported from crd/mod.rs (see ConfigFileName for the properties-builder files).
-const SECURITY_PROPERTIES_FILE: &str = "security.properties";
-const LOG4J2_CONFIG_FILE: &str = "log4j2.properties";
-
 #[derive(Snafu, Debug)]
 pub enum Error {
     #[snafu(display("failed to format memory quantity {value:?} for Java"))]
@@ -55,15 +52,17 @@ pub fn construct_jvm_args<T>(
     if let Some(direct_memory) = direct_memory_str {
         jvm_args.push(format!("-XX:MaxDirectMemorySize={direct_memory}"));
     }
+    let security_properties_file = ConfigFileName::SecurityProperties;
+    let log4j2_config_file = ConfigFileName::Log4j2Properties;
     jvm_args.extend([
         "-XX:+ExitOnOutOfMemoryError".to_owned(),
         "-XX:+UseG1GC".to_owned(),
-        format!("-Djava.security.properties={RW_CONFIG_DIRECTORY}/{SECURITY_PROPERTIES_FILE}"),
+        format!("-Djava.security.properties={RW_CONFIG_DIRECTORY}/{security_properties_file}"),
         "-Duser.timezone=UTC".to_owned(),
         "-Dfile.encoding=UTF-8".to_owned(),
         "-Djava.io.tmpdir=/tmp".to_owned(),
         "-Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager".to_owned(),
-        format!("-Dlog4j.configurationFile={RW_CONFIG_DIRECTORY}/{LOG4J2_CONFIG_FILE}"),
+        format!("-Dlog4j.configurationFile={RW_CONFIG_DIRECTORY}/{log4j2_config_file}"),
         format!("-Djavax.net.ssl.trustStore={STACKABLE_TRUST_STORE}"),
         format!("-Djavax.net.ssl.trustStorePassword={STACKABLE_TRUST_STORE_PASSWORD}"),
         "-Djavax.net.ssl.trustStoreType=pkcs12".to_owned(),

rust/operator-binary/src/config/jvm.rs …rator-binary/src/controller/build/jvm.rsrust/operator-binary/src/config/jvm.rs renamed to rust/operator-binary/src/controller/build/jvm.rs rust/operator-binary/src/config/jvm.rs renamed to rust/operator-binary/src/controller/build/jvm.rs

@@ -6,8 +6,6 @@ pub mod security_properties;
 
 /// The names of the operator-written Druid config files assembled into the rolegroup ConfigMap.
 #[derive(Clone, Copy, Debug, strum::Display)]
-// The shared `Properties` suffix mirrors the actual on-disk file names; it is not redundant naming.
-#[allow(clippy::enum_variant_names)]
 pub enum ConfigFileName {
     #[strum(serialize = "runtime.properties")]
     RuntimeProperties,
@@ -17,4 +15,9 @@ pub enum ConfigFileName {
     /// but it is still an operator-written file assembled into the rolegroup ConfigMap.
     #[strum(serialize = "log4j2.properties")]
     Log4j2Properties,
+    /// `jvm.config` is rendered from JVM argument overrides by [`super::jvm`] rather than a
+    /// properties builder, but it is still an operator-written file assembled into the rolegroup
+    /// ConfigMap.
+    #[strum(serialize = "jvm.config")]
+    JvmConfig,
 }

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

@@ -29,9 +29,11 @@ use strum::IntoEnumIterator;
 
 use crate::{
     authentication::DruidAuthenticationConfig,
-    config::jvm::construct_jvm_args,
     controller::{
-        build::properties::{ConfigFileName, runtime_properties, security_properties},
+        build::{
+            jvm::construct_jvm_args,
+            properties::{ConfigFileName, runtime_properties, security_properties},
+        },
         dereference::DereferencedObjects,
     },
     crd::{
@@ -63,7 +65,9 @@ pub enum Error {
     },
 
     #[snafu(display("failed to get JVM config"))]
-    GetJvmConfig { source: crate::config::jvm::Error },
+    GetJvmConfig {
+        source: crate::controller::build::jvm::Error,
+    },
 
     #[snafu(display("failed to derive Druid memory settings from resources"))]
     DeriveMemorySettings { source: crate::crd::resource::Error },
@@ -215,8 +219,9 @@ fn key_value_overrides(
     let raw = match file {
         ConfigFileName::RuntimeProperties => overrides.runtime_properties.overrides.clone(),
         ConfigFileName::SecurityProperties => overrides.security_properties.overrides.clone(),
-        // log4j2.properties is rendered by the logging framework and accepts no key/value overrides.
-        ConfigFileName::Log4j2Properties => BTreeMap::new(),
+        // log4j2.properties is rendered by the logging framework, and jvm.config is rendered from
+        // JVM argument overrides; neither is assembled from key/value overrides here.
+        ConfigFileName::Log4j2Properties | ConfigFileName::JvmConfig => BTreeMap::new(),
     };
     raw.into_iter()
         .map(|(k, v)| (k, v.unwrap_or_default()))

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

@@ -38,7 +38,6 @@ use crate::{
 };
 
 mod authentication;
-mod config;
 mod controller;
 mod crd;
 mod extensions;