refactor: adopt upstream RoleGroupConfig, carry optional replicas

Author: maltesander

Cargo.lock

@@ -1,7 +1,7 @@
 use snafu::{ResultExt, Snafu};
 use stackable_operator::builder::pod::PodBuilder;
 
-use crate::crd::v1alpha1;
+use crate::zk_controller::validate::ValidatedZookeeperConfig;
 
 #[derive(Debug, Snafu)]
 pub enum Error {
@@ -12,7 +12,7 @@ pub enum Error {
 }
 
 pub fn add_graceful_shutdown_config(
-    merged_config: &v1alpha1::ZookeeperConfig,
+    merged_config: &ValidatedZookeeperConfig,
     pod_builder: &mut PodBuilder,
 ) -> Result<(), Error> {
     // This must be always set by the merge mechanism, as we provide a default value,

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

@@ -3,10 +3,8 @@ use stackable_operator::memory::{BinaryMultiple, MemoryQuantity};
 
 use super::properties::ConfigFileName;
 use crate::{
-    crd::{
-        JMX_METRICS_PORT, STACKABLE_CONFIG_DIR, STACKABLE_LOG_CONFIG_DIR, v1alpha1::ZookeeperConfig,
-    },
-    zk_controller::validate::ValidatedRoleGroupConfig,
+    crd::{JMX_METRICS_PORT, STACKABLE_CONFIG_DIR, STACKABLE_LOG_CONFIG_DIR},
+    zk_controller::validate::{ValidatedZookeeperConfig, ZookeeperRoleGroupConfig},
 };
 
 const JAVA_HEAP_FACTOR: f32 = 0.8;
@@ -23,7 +21,7 @@ pub enum Error {
 }
 
 /// All JVM arguments.
-fn construct_jvm_args(rolegroup_config: &ValidatedRoleGroupConfig) -> Vec<String> {
+fn construct_jvm_args(rolegroup_config: &ZookeeperRoleGroupConfig) -> Vec<String> {
     let jvm_args = vec![
         format!(
             "-Djava.security.properties={STACKABLE_CONFIG_DIR}/{}",
@@ -40,12 +38,15 @@ fn construct_jvm_args(rolegroup_config: &ValidatedRoleGroupConfig) -> Vec<String
 
     // Apply the already-merged (role + role group) JVM argument overrides on top of the
     // operator-generated base arguments.
-    rolegroup_config.jvm_argument_overrides.apply_to(jvm_args)
+    rolegroup_config
+        .product_specific_common_config
+        .jvm_argument_overrides
+        .apply_to(jvm_args)
 }
 
 /// Arguments that go into `SERVER_JVMFLAGS`, so *not* the heap settings (which you can get using
 /// [`construct_zk_server_heap_env`]).
-pub fn construct_non_heap_jvm_args(rolegroup_config: &ValidatedRoleGroupConfig) -> String {
+pub fn construct_non_heap_jvm_args(rolegroup_config: &ZookeeperRoleGroupConfig) -> String {
     let mut jvm_args = construct_jvm_args(rolegroup_config);
     jvm_args.retain(|arg| !is_heap_jvm_argument(arg));
 
@@ -54,7 +55,9 @@ pub fn construct_non_heap_jvm_args(rolegroup_config: &ValidatedRoleGroupConfig)
 
 /// This will be put into `ZK_SERVER_HEAP`, which is just the heap size in megabytes (*without* the `m`
 /// unit prepended).
-pub fn construct_zk_server_heap_env(merged_config: &ZookeeperConfig) -> Result<String, Error> {
+pub fn construct_zk_server_heap_env(
+    merged_config: &ValidatedZookeeperConfig,
+) -> Result<String, Error> {
     let heap_size_in_mb = (MemoryQuantity::try_from(
         merged_config
             .resources
@@ -89,7 +92,7 @@ mod tests {
     };
 
     /// The validated, merged config for the `default` server role group.
-    fn server_default(zk: &ZookeeperCluster) -> ValidatedRoleGroupConfig {
+    fn server_default(zk: &ZookeeperCluster) -> ZookeeperRoleGroupConfig {
         let default_group = RoleGroupName::from_str("default").expect("valid role group name");
         validated_cluster(zk)
             .role_group_configs

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

@@ -2,7 +2,7 @@
 
 use std::collections::BTreeMap;
 
-use crate::zk_controller::validate::ValidatedRoleGroupConfig;
+use crate::zk_controller::validate::ZookeeperRoleGroupConfig;
 
 const NETWORKADDRESS_CACHE_TTL: &str = "networkaddress.cache.ttl";
 const NETWORKADDRESS_CACHE_NEGATIVE_TTL: &str = "networkaddress.cache.negative.ttl";
@@ -14,7 +14,7 @@ const DEFAULT_NETWORKADDRESS_CACHE_NEGATIVE_TTL: &str = "0";
 ///
 /// The entire file is operator-injected (the values formerly came from
 /// `product-config`'s `properties.yaml`), plus any user `configOverrides`.
-pub fn build(rolegroup_config: &ValidatedRoleGroupConfig) -> BTreeMap<String, String> {
+pub fn build(rolegroup_config: &ZookeeperRoleGroupConfig) -> BTreeMap<String, String> {
     let mut security_properties = BTreeMap::new();
 
     // Operator-injected defaults (former properties.yaml recommended values).

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

@@ -1,9 +1,4 @@
 //! Builder for `zoo.cfg` (the main ZooKeeper properties file).
-//!
-//! The operator-injected defaults seeded here used to live in
-//! `deploy/config-spec/properties.yaml` and were injected by the `product-config`
-//! crate during validation. They are reproduced here so the rendered config is
-//! byte-identical to the previous implementation.
 
 use std::collections::BTreeMap;
 
@@ -14,7 +9,7 @@ use crate::{
         METRICS_PROVIDER_HTTP_PORT, METRICS_PROVIDER_HTTP_PORT_KEY, STACKABLE_DATA_DIR,
         security::ZookeeperSecurity, v1alpha1::ZookeeperConfig,
     },
-    zk_controller::validate::{ValidatedCluster, ValidatedRoleGroupConfig},
+    zk_controller::validate::{ValidatedCluster, ZookeeperRoleGroupConfig},
 };
 
 const ADMIN_SERVER_PORT_KEY: &str = "admin.serverPort";
@@ -36,7 +31,7 @@ const DEFAULT_TICK_TIME: &str = "3000";
 /// 5. `configOverrides` for `zoo.cfg`
 pub fn build(
     cluster: &ValidatedCluster,
-    rolegroup_config: &ValidatedRoleGroupConfig,
+    rolegroup_config: &ZookeeperRoleGroupConfig,
 ) -> BTreeMap<String, String> {
     let security = &cluster.cluster_config.zookeeper_security;
     let config = &rolegroup_config.config;
@@ -115,7 +110,7 @@ impl ValidatedCluster {
     /// Defined here (in the build layer) rather than in `validate` so that resolving the port —
     /// which renders the full `zoo.cfg` via [`build`] — does not invert the validate → build
     /// dependency direction.
-    pub fn metrics_http_port(&self, rolegroup_config: &ValidatedRoleGroupConfig) -> Port {
+    pub fn metrics_http_port(&self, rolegroup_config: &ZookeeperRoleGroupConfig) -> Port {
         build(self, rolegroup_config)
             .get(METRICS_PROVIDER_HTTP_PORT_KEY)
             .and_then(|port| port.parse::<u16>().ok())

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

@@ -20,7 +20,7 @@ use stackable_operator::{
 
 use crate::zk_controller::{
     build::properties::{ConfigFileName, product_logging, security_properties, zoo_cfg},
-    validate::{ValidatedCluster, ValidatedRoleGroupConfig},
+    validate::{ValidatedCluster, ZookeeperRoleGroupConfig},
 };
 
 #[derive(Snafu, Debug)]
@@ -51,7 +51,7 @@ type Result<T, E = Error> = std::result::Result<T, E>;
 pub fn build_server_rolegroup_config_map(
     cluster: &ValidatedCluster,
     role_group_name: &RoleGroupName,
-    rolegroup_config: &ValidatedRoleGroupConfig,
+    rolegroup_config: &ZookeeperRoleGroupConfig,
 ) -> Result<ConfigMap> {
     let mut data: BTreeMap<String, String> = BTreeMap::new();
 
@@ -78,7 +78,7 @@ pub fn build_server_rolegroup_config_map(
 
     // logback.xml
     if let Some(logback) =
-        product_logging::build_logback_config(&rolegroup_config.logging.zookeeper_container)
+        product_logging::build_logback_config(&rolegroup_config.config.logging.zookeeper_container)
     {
         data.insert(ConfigFileName::LogbackXml.to_string(), logback);
     }

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

@@ -10,7 +10,7 @@ use crate::{
         ZOOKEEPER_ELECTION_PORT, ZOOKEEPER_ELECTION_PORT_NAME, ZOOKEEPER_LEADER_PORT,
         ZOOKEEPER_LEADER_PORT_NAME,
     },
-    zk_controller::validate::{ValidatedCluster, ValidatedRoleGroupConfig},
+    zk_controller::validate::{ValidatedCluster, ZookeeperRoleGroupConfig},
 };
 
 /// The rolegroup [`Service`] is a headless service that allows internal access to the instances of a certain rolegroup
@@ -64,7 +64,7 @@ pub(crate) fn build_server_rolegroup_headless_service(
 pub(crate) fn build_server_rolegroup_metrics_service(
     cluster: &ValidatedCluster,
     role_group_name: &RoleGroupName,
-    rolegroup_config: &ValidatedRoleGroupConfig,
+    rolegroup_config: &ZookeeperRoleGroupConfig,
 ) -> Service {
     let metrics_port = cluster.metrics_http_port(rolegroup_config);
     let metadata = cluster

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

@@ -33,7 +33,6 @@ use stackable_operator::{
     product_logging::{
         self,
         framework::{create_vector_shutdown_file_command, remove_vector_shutdown_file_command},
-        spec::{ContainerLogConfig, ContainerLogConfigChoice},
     },
     utils::COMMON_BASH_TRAP_FUNCTIONS,
     v2::{
@@ -64,7 +63,7 @@ use crate::{
             jvm::{construct_non_heap_jvm_args, construct_zk_server_heap_env},
             properties::{self, ConfigFileName},
         },
-        validate::{ValidatedCluster, ValidatedRoleGroupConfig},
+        validate::{ValidatedCluster, ZookeeperRoleGroupConfig},
     },
 };
 
@@ -154,10 +153,9 @@ fn build_role_listener_pvc(
 pub fn build_server_rolegroup_statefulset(
     cluster: &ValidatedCluster,
     role_group_name: &RoleGroupName,
-    rolegroup_config: &ValidatedRoleGroupConfig,
+    rolegroup_config: &ZookeeperRoleGroupConfig,
 ) -> Result<StatefulSet> {
     let merged_config = &rolegroup_config.config;
-    let logging = &merged_config.logging;
     let resource_names = cluster.resource_names(role_group_name);
     let resolved_product_image = &cluster.image;
     let zookeeper_security = &cluster.cluster_config.zookeeper_security;
@@ -226,9 +224,8 @@ pub fn build_server_rolegroup_statefulset(
 
     let mut args = Vec::new();
 
-    if let Some(ContainerLogConfig {
-        choice: Some(ContainerLogConfigChoice::Automatic(log_config)),
-    }) = logging.containers.get(&v1alpha1::Container::Prepare)
+    if let ValidatedContainerLogConfigChoice::Automatic(log_config) =
+        &rolegroup_config.config.logging.prepare_container
     {
         args.push(product_logging::framework::capture_shell_output(
             STACKABLE_LOG_DIR,
@@ -391,7 +388,7 @@ pub fn build_server_rolegroup_statefulset(
 
     // Use the user-provided custom log ConfigMap if one is configured, otherwise fall back to the
     // rolegroup's own ConfigMap. This branches on the *validated* logging choice.
-    let log_config_map = match &rolegroup_config.logging.zookeeper_container {
+    let log_config_map = match &rolegroup_config.config.logging.zookeeper_container {
         ValidatedContainerLogConfigChoice::Custom(config_map) => config_map.to_string(),
         ValidatedContainerLogConfigChoice::Automatic(_) => {
             resource_names.role_group_config_map().to_string()
@@ -411,7 +408,7 @@ pub fn build_server_rolegroup_statefulset(
     // The static `vector.yaml` (in the rolegroup ConfigMap, mounted as the `config` volume) is
     // parameterised at runtime via env vars that the v2 `vector_container` injects. The validated
     // Vector log config is built up-front in the validate step.
-    if let Some(vector_log_config) = &rolegroup_config.logging.vector_container {
+    if let Some(vector_log_config) = &rolegroup_config.config.logging.vector_container {
         let config_volume_name = VolumeName::from_str(CONFIG_VOLUME_NAME)
             .expect("CONFIG_VOLUME_NAME is a valid volume name");
         let log_volume_name =
@@ -442,7 +439,9 @@ pub fn build_server_rolegroup_statefulset(
 
     let statefulset_spec = StatefulSetSpec {
         pod_management_policy: Some("Parallel".to_string()),
-        replicas: Some(i32::from(rolegroup_config.replicas)),
+        // `None` (no replica count specified) leaves `.spec.replicas` unset so a
+        // HorizontalPodAutoscaler can manage the replica count.
+        replicas: rolegroup_config.replicas.map(i32::from),
         selector: LabelSelector {
             match_labels: Some(cluster.role_group_selector(role_group_name).into()),
             ..LabelSelector::default()