refactor: use v2 JavaCommonConfig, delete local framework, move jvm.rs to controller/build

Author: maltesander

Cargo.lock

@@ -2,7 +2,34 @@
 //!
 //! [`ValidatedCluster`]: crate::controller::ValidatedCluster
 
+use snafu::Snafu;
+
+use crate::{crd::storage::NifiRepository, security::oidc};
+
 pub mod config_map;
 pub mod git_sync;
+pub mod jvm;
 pub mod properties;
 pub mod proxy_hosts;
+
+/// Errors that can occur while building the NiFi product configuration files.
+#[derive(Snafu, Debug)]
+#[snafu(visibility(pub(crate)))]
+pub enum Error {
+    #[snafu(display("invalid JVM config"))]
+    InvalidJVMConfig { source: jvm::Error },
+
+    #[snafu(display("failed to calculate storage quota for {repo} repository"))]
+    CalculateStorageQuota {
+        source: stackable_operator::memory::Error,
+        repo: NifiRepository,
+    },
+
+    #[snafu(display("failed to generate OIDC config"))]
+    GenerateOidcConfig { source: oidc::Error },
+
+    #[snafu(display(
+        "NiFi 1.x requires ZooKeeper (hint: upgrade to NiFi 2.x or set .spec.clusterConfig.zookeeperConfigMapName)"
+    ))]
+    Nifi1RequiresZookeeper,
+}

Cargo.nix

@@ -35,14 +35,14 @@ pub enum Error {
 
     #[snafu(display("failed to build bootstrap.conf"))]
     BootstrapConfig {
-        #[snafu(source(from(crate::config::Error, Box::new)))]
-        source: Box<crate::config::Error>,
+        #[snafu(source(from(crate::controller::build::Error, Box::new)))]
+        source: Box<crate::controller::build::Error>,
     },
 
     #[snafu(display("failed to prepare NiFi configuration for rolegroup {rolegroup}"))]
     BuildNifiProperties {
-        #[snafu(source(from(crate::config::Error, Box::new)))]
-        source: Box<crate::config::Error>,
+        #[snafu(source(from(crate::controller::build::Error, Box::new)))]
+        source: Box<crate::controller::build::Error>,
         rolegroup: RoleGroupRef<v1alpha1::NifiCluster>,
     },
 
@@ -94,9 +94,6 @@ pub fn build_rolegroup_config_map(
             role_group: rolegroup.role_group.clone(),
         })?;
 
-    // The raw role spec is only needed for JVM argument merging in `bootstrap_conf`.
-    let role = &cluster.nodes;
-
     let proxy_hosts = proxy_hosts::compute_proxy_hosts(cluster, cluster_info);
     let git_sync_resources =
         git_sync::build_git_sync_resources(cluster, rg).context(BuildGitSyncResourcesSnafu)?;
@@ -115,13 +112,8 @@ pub fn build_rolegroup_config_map(
         )
         .add_data(
             ConfigFileName::BootstrapConf.to_string(),
-            bootstrap_conf::build(
-                rg,
-                role,
-                &rolegroup.role_group,
-                Some(&cluster.cluster_config.authorization),
-            )
-            .context(BootstrapConfigSnafu)?,
+            bootstrap_conf::build(rg, Some(&cluster.cluster_config.authorization))
+                .context(BootstrapConfigSnafu)?,
         )
         .add_data(
             ConfigFileName::NifiProperties.to_string(),

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

@@ -4,7 +4,7 @@ use snafu::{ResultExt, Snafu};
 use stackable_operator::{crd::git_sync, k8s_openapi::api::core::v1::EnvVar};
 
 use crate::{
-    controller::{ValidatedCluster, validate::NifiRoleGroupConfig},
+    controller::{ValidatedCluster, ValidatedRoleGroupConfig},
     crd::Container,
     nifi_controller::LOG_VOLUME_NAME,
 };
@@ -22,7 +22,7 @@ type Result<T, E = Error> = std::result::Result<T, E>;
 /// rather than once for the whole cluster.
 pub fn build_git_sync_resources(
     cluster: &ValidatedCluster,
-    rg: &NifiRoleGroupConfig,
+    rg: &ValidatedRoleGroupConfig,
 ) -> Result<git_sync::v1alpha2::GitSyncResources> {
     let env_vars: Vec<EnvVar> = rg.env_overrides.clone().into();
     git_sync::v1alpha2::GitSyncResources::new(

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

@@ -1,12 +1,16 @@
+//! Builder for the NiFi JVM arguments used in `bootstrap.conf`.
+
 use snafu::{OptionExt, ResultExt, Snafu};
 use stackable_operator::{
     memory::{BinaryMultiple, MemoryQuantity},
-    role_utils::{self, JvmArgumentOverrides},
+    v2::jvm_argument_overrides::JvmArgumentOverrides,
 };
 
 use crate::{
-    config::{JVM_SECURITY_PROPERTIES_FILE, NIFI_CONFIG_DIRECTORY},
-    crd::{NifiConfig, NifiRoleType},
+    crd::{
+        NifiConfig,
+        constants::{JVM_SECURITY_PROPERTIES_FILE, NIFI_CONFIG_DIRECTORY},
+    },
     security::{
         authentication::{STACKABLE_SERVER_TLS_DIR, STACKABLE_TLS_STORE_PASSWORD},
         authorization::ResolvedNifiAuthorizationConfig,
@@ -25,18 +29,19 @@ pub enum Error {
     InvalidMemoryConfig {
         source: stackable_operator::memory::Error,
     },
-
-    #[snafu(display("failed to merge jvm argument overrides"))]
-    MergeJvmArgumentOverrides { source: role_utils::Error },
 }
 
-/// Build the merged JVM argument overrides used in the NiFi bootstrap.conf
+/// Build the effective JVM arguments for the NiFi bootstrap.conf.
+///
+/// The operator-generated arguments below form the base that the role <- role-group merged
+/// user overrides (`merged_jvm_argument_overrides`, produced by
+/// [`with_validated_config`](stackable_operator::v2::role_utils::with_validated_config)) are
+/// applied on top of.
 pub fn build_merged_jvm_config(
     merged_config: &NifiConfig,
-    role: &NifiRoleType,
-    role_group: &str,
+    merged_jvm_argument_overrides: &JvmArgumentOverrides,
     authorization_config: Option<&ResolvedNifiAuthorizationConfig>,
-) -> Result<JvmArgumentOverrides, Error> {
+) -> Result<Vec<String>, Error> {
     let heap_size = MemoryQuantity::try_from(
         merged_config
             .resources
@@ -52,7 +57,7 @@ pub fn build_merged_jvm_config(
         .format_for_java()
         .context(InvalidMemoryConfigSnafu)?;
 
-    let mut jvm_args = vec![
+    let mut operator_generated = vec![
         // Heap settings
         format!("-Xmx{java_heap}"),
         format!("-Xms{java_heap}"),
@@ -95,17 +100,15 @@ pub fn build_merged_jvm_config(
     // OPA Java SDK.
     if let Some(authz_config) = authorization_config {
         if authz_config.has_opa_tls() {
-            jvm_args.push(format!(
+            operator_generated.push(format!(
                 "-Djavax.net.ssl.trustStore={STACKABLE_SERVER_TLS_DIR}/truststore.p12"
             ));
-            jvm_args.push(format!(
+            operator_generated.push(format!(
                 "-Djavax.net.ssl.trustStorePassword={STACKABLE_TLS_STORE_PASSWORD}"
             ));
-            jvm_args.push("-Djavax.net.ssl.trustStoreType=pkcs12".to_owned());
+            operator_generated.push("-Djavax.net.ssl.trustStoreType=pkcs12".to_owned());
         }
     }
 
-    let operator_generated = JvmArgumentOverrides::new_with_only_additions(jvm_args);
-    role.get_merged_jvm_argument_overrides(role_group, &operator_generated)
-        .context(MergeJvmArgumentOverridesSnafu)
+    Ok(merged_jvm_argument_overrides.apply_to(operator_generated))
 }