fix: consolidate hard coded constants

Author: maltesander

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

@@ -5,7 +5,7 @@ use std::collections::BTreeMap;
 use snafu::{ResultExt, ensure};
 use stackable_operator::memory::MemoryQuantity;
 
-use super::format_properties;
+use super::{ConfigFileName, format_properties};
 use crate::{
     controller::{
         ValidatedCluster, ValidatedRoleGroupConfig,
@@ -14,7 +14,13 @@ use crate::{
         },
     },
     crd::{
-        HTTPS_PORT, constants::NIFI_PYTHON_WORKING_DIRECTORY, storage::NifiRepository, v1alpha1,
+        HTTPS_PORT,
+        constants::{
+            NIFI_CONFIG_DIRECTORY, NIFI_PYTHON_EXTENSIONS_DIRECTORY,
+            NIFI_PYTHON_FRAMEWORK_DIRECTORY, NIFI_PYTHON_WORKING_DIRECTORY,
+        },
+        storage::NifiRepository,
+        v1alpha1,
     },
     security::{
         authentication::{
@@ -71,7 +77,7 @@ pub fn build(
     );
     properties.insert(
         "nifi.flow.configuration.archive.dir".to_string(),
-        "/stackable/nifi/conf/archive/".to_string(),
+        format!("{NIFI_CONFIG_DIRECTORY}/archive/"),
     );
     properties.insert(
         "nifi.flow.configuration.archive.max.time".to_string(),
@@ -110,11 +116,14 @@ pub fn build(
 
     properties.insert(
         "nifi.authorizer.configuration.file".to_string(),
-        "/stackable/nifi/conf/authorizers.xml".to_string(),
+        format!("{NIFI_CONFIG_DIRECTORY}/{}", ConfigFileName::Authorizers),
     );
     properties.insert(
         "nifi.login.identity.provider.configuration.file".to_string(),
-        "/stackable/nifi/conf/login-identity-providers.xml".to_string(),
+        format!(
+            "{NIFI_CONFIG_DIRECTORY}/{}",
+            ConfigFileName::LoginIdentityProviders
+        ),
     );
     properties.insert(
         "nifi.templates.directory".to_string(),
@@ -536,7 +545,7 @@ pub fn build(
     // Java processes.
     properties.insert(
         "nifi.python.framework.source.directory".to_string(),
-        "/stackable/nifi/python/framework/".to_string(),
+        NIFI_PYTHON_FRAMEWORK_DIRECTORY.to_string(),
     );
 
     // The working directory where NiFi should store artifacts;
@@ -552,7 +561,7 @@ pub fn build(
     // (docs/modules/nifi/pages/usage_guide/custom-components.adoc), so do not change it!
     properties.insert(
         "nifi.python.extensions.source.directory.default".to_string(),
-        "/stackable/nifi/python/extensions/".to_string(),
+        NIFI_PYTHON_EXTENSIONS_DIRECTORY.to_string(),
     );
 
     for (i, git_folder) in git_sync_resources

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

@@ -60,6 +60,8 @@ use crate::{
 
 const REPORTING_TASK_CERT_VOLUME_NAME: &str = "tls";
 const REPORTING_TASK_CERT_VOLUME_MOUNT: &str = "/stackable/cert";
+/// Path (inside the image) of the script that registers the NiFi 1.x reporting task.
+const REPORTING_TASK_SCRIPT_PATH: &str = "/stackable/python/create_nifi_reporting_task.py";
 stackable_operator::constant!(REPORTING_TASK_CONTAINER_NAME: ContainerName = "reporting-task");
 
 #[derive(Snafu, Debug)]
@@ -256,7 +258,7 @@ fn build_reporting_task_job(
     };
 
     let args = [
-        "/stackable/python/create_nifi_reporting_task.py".to_string(),
+        REPORTING_TASK_SCRIPT_PATH.to_string(),
         format!("-n {nifi_connect_url}"),
         user_name_command,
         format!("-p \"$(cat {admin_password_file})\""),

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

@@ -133,6 +133,10 @@ const LOG_CONFIG_VOLUME_NAME: &str = "log-config";
 /// git-sync container, see [`crate::controller::build::git_sync`]).
 pub(crate) const LOG_VOLUME_NAME: &str = "log";
 
+/// `emptyDir` for the Python working directory, mounted into the NiFi container at
+/// [`NIFI_PYTHON_WORKING_DIRECTORY`].
+const PYTHON_WORKING_DIR_VOLUME_NAME: &str = "nifi-python-working-directory";
+
 // Container names. These must match the corresponding (kebab-cased) `crate::crd::Container`
 // variants, which key the per-container logging config.
 stackable_operator::constant!(PREPARE_CONTAINER_NAME: ContainerName = "prepare");
@@ -471,12 +475,14 @@ pub(crate) async fn build_node_rolegroup_statefulset(
             .context(AddVolumeMountSnafu)?;
     }
 
-    let volume_name = "nifi-python-working-directory".to_string();
     pod_builder
-        .add_empty_dir_volume(&volume_name, None)
+        .add_empty_dir_volume(PYTHON_WORKING_DIR_VOLUME_NAME, None)
         .context(AddVolumeSnafu)?;
     container_nifi
-        .add_volume_mount(&volume_name, NIFI_PYTHON_WORKING_DIRECTORY)
+        .add_volume_mount(
+            PYTHON_WORKING_DIR_VOLUME_NAME,
+            NIFI_PYTHON_WORKING_DIRECTORY,
+        )
         .context(AddVolumeMountSnafu)?;
 
     container_nifi
@@ -553,15 +559,15 @@ pub(crate) async fn build_node_rolegroup_statefulset(
         .image_pull_secrets_from_product_image(resolved_product_image)
         .add_init_container(container_prepare.build())
         .affinity(&merged_config.affinity)
-        // One volume for the NiFi configuration. A script will later on edit (e.g. nodename)
-        // and copy the whole content to the <NIFI_HOME>/conf folder.
-        .add_volume(stackable_operator::k8s_openapi::api::core::v1::Volume {
-            name: "config".to_string(),
+        // The rolegroup `ConfigMap` mounted as-is (it also carries `vector.yaml`); read by the
+        // Vector sidecar via [`VECTOR_LOG_CONFIG_VOLUME_NAME`].
+        .add_volume(Volume {
+            name: VECTOR_LOG_CONFIG_VOLUME_NAME.to_string(),
             config_map: Some(ConfigMapVolumeSource {
                 name: resource_names.role_group_config_map().to_string(),
-                ..Default::default()
+                ..ConfigMapVolumeSource::default()
             }),
-            ..Default::default()
+            ..Volume::default()
         })
         .context(AddVolumeSnafu)?
         .add_volume(Volume {

rust/operator-binary/src/crd/constants.rs

@@ -3,6 +3,8 @@
 
 pub const NIFI_CONFIG_DIRECTORY: &str = "/stackable/nifi/conf";
 pub const NIFI_PYTHON_WORKING_DIRECTORY: &str = "/nifi-python-working-directory";
+pub const NIFI_PYTHON_FRAMEWORK_DIRECTORY: &str = "/stackable/nifi/python/framework/";
+pub const NIFI_PYTHON_EXTENSIONS_DIRECTORY: &str = "/stackable/nifi/python/extensions/";
 pub const NIFI_PVC_STORAGE_DIRECTORY: &str = "/stackable/data";
 
 pub const JVM_SECURITY_PROPERTIES_FILE: &str = "security.properties";