|
| 1 | +use snafu::{OptionExt, ResultExt, Snafu}; |
| 2 | +use stackable_operator::{ |
| 3 | + memory::{BinaryMultiple, MemoryQuantity}, |
| 4 | + role_utils::{self, GenericRoleConfig, JavaCommonConfig, JvmArgumentOverrides, Role}, |
| 5 | +}; |
| 6 | + |
| 7 | +use crate::crd::{ |
| 8 | + v1alpha1::{ZookeeperCluster, ZookeeperConfig, ZookeeperConfigFragment}, |
| 9 | + LoggingFramework, JVM_SECURITY_PROPERTIES_FILE, LOG4J_CONFIG_FILE, LOGBACK_CONFIG_FILE, |
| 10 | + METRICS_PORT, STACKABLE_CONFIG_DIR, STACKABLE_LOG_CONFIG_DIR, |
| 11 | +}; |
| 12 | + |
| 13 | +const JAVA_HEAP_FACTOR: f32 = 0.8; |
| 14 | + |
| 15 | +#[derive(Snafu, Debug)] |
| 16 | +pub enum Error { |
| 17 | + #[snafu(display("invalid memory resource configuration - missing default or value in crd?"))] |
| 18 | + MissingMemoryResourceConfig, |
| 19 | + |
| 20 | + #[snafu(display("invalid memory config"))] |
| 21 | + InvalidMemoryConfig { |
| 22 | + source: stackable_operator::memory::Error, |
| 23 | + }, |
| 24 | + |
| 25 | + #[snafu(display("failed to merge jvm argument overrides"))] |
| 26 | + MergeJvmArgumentOverrides { source: role_utils::Error }, |
| 27 | +} |
| 28 | + |
| 29 | +/// All JVM arguments. |
| 30 | +fn construct_jvm_args( |
| 31 | + zk: &ZookeeperCluster, |
| 32 | + role: &Role<ZookeeperConfigFragment, GenericRoleConfig, JavaCommonConfig>, |
| 33 | + role_group: &str, |
| 34 | +) -> Result<Vec<String>, Error> { |
| 35 | + let logging_framework = zk.logging_framework(); |
| 36 | + |
| 37 | + let jvm_args = vec![ |
| 38 | + format!("-Djava.security.properties={STACKABLE_CONFIG_DIR}/{JVM_SECURITY_PROPERTIES_FILE}"), |
| 39 | + format!("-javaagent:/stackable/jmx/jmx_prometheus_javaagent.jar={METRICS_PORT}:/stackable/jmx/server.yaml"), |
| 40 | + match logging_framework { |
| 41 | + LoggingFramework::LOG4J => format!("-Dlog4j.configuration=file:{STACKABLE_LOG_CONFIG_DIR}/{LOG4J_CONFIG_FILE}"), |
| 42 | + LoggingFramework::LOGBACK => format!("-Dlogback.configurationFile={STACKABLE_LOG_CONFIG_DIR}/{LOGBACK_CONFIG_FILE}"), |
| 43 | + }, |
| 44 | + ]; |
| 45 | + |
| 46 | + let operator_generated = JvmArgumentOverrides::new_with_only_additions(jvm_args); |
| 47 | + let merged = role |
| 48 | + .get_merged_jvm_argument_overrides(role_group, &operator_generated) |
| 49 | + .context(MergeJvmArgumentOverridesSnafu)?; |
| 50 | + Ok(merged |
| 51 | + .effective_jvm_config_after_merging() |
| 52 | + // Sorry for the clone, that's how operator-rs is currently modelled :P |
| 53 | + .clone()) |
| 54 | +} |
| 55 | + |
| 56 | +/// Arguments that go into `SERVER_JVMFLAGS`, so *not* the heap settings (which you can get using |
| 57 | +/// [`construct_zk_server_heap_env`]). |
| 58 | +pub fn construct_non_heap_jvm_args( |
| 59 | + zk: &ZookeeperCluster, |
| 60 | + role: &Role<ZookeeperConfigFragment, GenericRoleConfig, JavaCommonConfig>, |
| 61 | + role_group: &str, |
| 62 | +) -> Result<String, Error> { |
| 63 | + let mut jvm_args = construct_jvm_args(zk, role, role_group)?; |
| 64 | + jvm_args.retain(|arg| !is_heap_jvm_argument(arg)); |
| 65 | + |
| 66 | + Ok(jvm_args.join(" ")) |
| 67 | +} |
| 68 | + |
| 69 | +/// This will be put into `ZK_SERVER_HEAP`, which is just the heap size in megabytes (*without* the `m` |
| 70 | +/// unit prepended). |
| 71 | +pub fn construct_zk_server_heap_env(merged_config: &ZookeeperConfig) -> Result<String, Error> { |
| 72 | + let heap_size_in_mb = (MemoryQuantity::try_from( |
| 73 | + merged_config |
| 74 | + .resources |
| 75 | + .memory |
| 76 | + .limit |
| 77 | + .as_ref() |
| 78 | + .context(MissingMemoryResourceConfigSnafu)?, |
| 79 | + ) |
| 80 | + .context(InvalidMemoryConfigSnafu)? |
| 81 | + * JAVA_HEAP_FACTOR) |
| 82 | + .scale_to(BinaryMultiple::Mebi); |
| 83 | + |
| 84 | + Ok((heap_size_in_mb.value.floor() as u32).to_string()) |
| 85 | +} |
| 86 | + |
| 87 | +fn is_heap_jvm_argument(jvm_argument: &str) -> bool { |
| 88 | + let lowercase = jvm_argument.to_lowercase(); |
| 89 | + |
| 90 | + lowercase.starts_with("-xms") || lowercase.starts_with("-xmx") |
| 91 | +} |
| 92 | + |
| 93 | +#[cfg(test)] |
| 94 | +mod tests { |
| 95 | + use super::*; |
| 96 | + use crate::crd::{v1alpha1::ZookeeperConfig, ZookeeperRole}; |
| 97 | + |
| 98 | + #[test] |
| 99 | + fn test_construct_jvm_arguments_defaults() { |
| 100 | + let input = r#" |
| 101 | + apiVersion: zookeeper.stackable.tech/v1alpha1 |
| 102 | + kind: ZookeeperCluster |
| 103 | + metadata: |
| 104 | + name: simple-zookeeper |
| 105 | + spec: |
| 106 | + image: |
| 107 | + productVersion: "3.9.2" |
| 108 | + servers: |
| 109 | + roleGroups: |
| 110 | + default: |
| 111 | + replicas: 1 |
| 112 | + "#; |
| 113 | + let (zookeeper, merged_config, role, rolegroup) = construct_boilerplate(input); |
| 114 | + let non_heap_jvm_args = construct_non_heap_jvm_args(&zookeeper, &role, &rolegroup).unwrap(); |
| 115 | + let zk_server_heap_env = construct_zk_server_heap_env(&merged_config).unwrap(); |
| 116 | + |
| 117 | + assert_eq!( |
| 118 | + non_heap_jvm_args, |
| 119 | + "-Djava.security.properties=/stackable/config/security.properties \ |
| 120 | + -javaagent:/stackable/jmx/jmx_prometheus_javaagent.jar=9505:/stackable/jmx/server.yaml \ |
| 121 | + -Dlogback.configurationFile=/stackable/log_config/logback.xml" |
| 122 | + ); |
| 123 | + assert_eq!(zk_server_heap_env, "409"); |
| 124 | + } |
| 125 | + |
| 126 | + #[test] |
| 127 | + fn test_construct_jvm_argument_overrides() { |
| 128 | + let input = r#" |
| 129 | + apiVersion: zookeeper.stackable.tech/v1alpha1 |
| 130 | + kind: ZookeeperCluster |
| 131 | + metadata: |
| 132 | + name: simple-zookeeper |
| 133 | + spec: |
| 134 | + image: |
| 135 | + productVersion: "3.9.2" |
| 136 | + servers: |
| 137 | + config: |
| 138 | + resources: |
| 139 | + memory: |
| 140 | + limit: 42Gi |
| 141 | + jvmArgumentOverrides: |
| 142 | + add: |
| 143 | + - -Dhttps.proxyHost=proxy.my.corp |
| 144 | + - -Dhttps.proxyPort=8080 |
| 145 | + - -Djava.net.preferIPv4Stack=true |
| 146 | + roleGroups: |
| 147 | + default: |
| 148 | + replicas: 1 |
| 149 | + jvmArgumentOverrides: |
| 150 | + # We need more memory! |
| 151 | + removeRegex: |
| 152 | + - -Xmx.* |
| 153 | + - -Dhttps.proxyPort=.* |
| 154 | + add: |
| 155 | + - -Xmx40000m |
| 156 | + - -Dhttps.proxyPort=1234 |
| 157 | + "#; |
| 158 | + let (zookeeper, merged_config, role, rolegroup) = construct_boilerplate(input); |
| 159 | + let non_heap_jvm_args = construct_non_heap_jvm_args(&zookeeper, &role, &rolegroup).unwrap(); |
| 160 | + let zk_server_heap_env = construct_zk_server_heap_env(&merged_config).unwrap(); |
| 161 | + |
| 162 | + assert_eq!( |
| 163 | + non_heap_jvm_args, |
| 164 | + "-Djava.security.properties=/stackable/config/security.properties \ |
| 165 | + -javaagent:/stackable/jmx/jmx_prometheus_javaagent.jar=9505:/stackable/jmx/server.yaml \ |
| 166 | + -Dlogback.configurationFile=/stackable/log_config/logback.xml \ |
| 167 | + -Dhttps.proxyHost=proxy.my.corp \ |
| 168 | + -Djava.net.preferIPv4Stack=true \ |
| 169 | + -Dhttps.proxyPort=1234" |
| 170 | + ); |
| 171 | + assert_eq!(zk_server_heap_env, "34406"); |
| 172 | + } |
| 173 | + |
| 174 | + fn construct_boilerplate( |
| 175 | + zookeeper_cluster: &str, |
| 176 | + ) -> ( |
| 177 | + ZookeeperCluster, |
| 178 | + ZookeeperConfig, |
| 179 | + Role<ZookeeperConfigFragment, GenericRoleConfig, JavaCommonConfig>, |
| 180 | + String, |
| 181 | + ) { |
| 182 | + let zookeeper: ZookeeperCluster = |
| 183 | + serde_yaml::from_str(zookeeper_cluster).expect("illegal test input"); |
| 184 | + |
| 185 | + let zookeeper_role = ZookeeperRole::Server; |
| 186 | + let rolegroup_ref = zookeeper.server_rolegroup_ref("default"); |
| 187 | + let merged_config = zookeeper |
| 188 | + .merged_config(&zookeeper_role, &rolegroup_ref) |
| 189 | + .unwrap(); |
| 190 | + let role = zookeeper.spec.servers.clone().unwrap(); |
| 191 | + |
| 192 | + (zookeeper, merged_config, role, "default".to_owned()) |
| 193 | + } |
| 194 | +} |
0 commit comments