fix: Do not hard-code the environment variable name "FILE_LOG_DIRECTORY"

Author: siegfriedweber

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

@@ -16,7 +16,8 @@ use stackable_operator::{
 use crate::{
     controller::{ValidatedCluster, ValidatedLogging},
     crd::{
-        AirflowExecutor, AirflowRole, HTTP_PORT, LOG_CONFIG_DIR, TEMPLATE_LOCATION, TEMPLATE_NAME,
+        AirflowExecutor, AirflowRole, FILE_LOG_DIRECTORY, FILE_LOG_MAX_FILES,
+        FILE_LOG_ROTATION_PERIOD, HTTP_PORT, LOG_CONFIG_DIR, TEMPLATE_LOCATION, TEMPLATE_NAME,
         authentication::{
             AirflowAuthenticationClassResolved, AirflowClientAuthenticationDetailsResolved,
         },
@@ -78,9 +79,6 @@ constant!(ADMIN_PASSWORD_SECRET_KEY: SecretKey = "adminUser.password");
 
 constant!(PYTHONPATH: EnvVarName = "PYTHONPATH");
 
-constant!(FILE_LOG_DIRECTORY: EnvVarName = "FILE_LOG_DIRECTORY");
-constant!(FILE_LOG_ROTATION_PERIOD: EnvVarName = "FILE_LOG_ROTATION_PERIOD");
-constant!(FILE_LOG_MAX_FILES: EnvVarName = "FILE_LOG_MAX_FILES");
 constant!(STACKABLE_POST_HOOK: EnvVarName = "_STACKABLE_POST_HOOK");
 
 /// Return environment variables to be applied to the statefulsets for the scheduler, webserver (and worker,
@@ -539,9 +537,6 @@ mod tests {
         let _ = *AIRFLOW_WEBSERVER_ENABLE_PROXY_FIX;
         let _ = *AIRFLOW_WEBSERVER_EXPOSE_CONFIG;
         let _ = *AIRFLOW_WEBSERVER_PROXY_FIX_X_FOR;
-        let _ = *FILE_LOG_DIRECTORY;
-        let _ = *FILE_LOG_MAX_FILES;
-        let _ = *FILE_LOG_ROTATION_PERIOD;
         let _ = *FORWARDED_ALLOW_IPS;
         let _ = *PYTHONPATH;
         let _ = *STACKABLE_POST_HOOK;

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

@@ -1,5 +1,6 @@
 use std::{collections::BTreeSet, ops::Deref, str::FromStr};
 
+use indoc::formatdoc;
 use serde::{Deserialize, Serialize};
 use snafu::{ResultExt, Snafu};
 use stackable_operator::{
@@ -38,6 +39,7 @@ use stackable_operator::{
     status::condition::{ClusterCondition, HasStatusCondition},
     utils::{COMMON_BASH_TRAP_FUNCTIONS, crds::raw_object_list_schema},
     v2::{
+        builder::pod::container::EnvVarName,
         config_overrides::KeyValueConfigOverrides,
         flask_config_writer::{FlaskAppConfigOptions, PythonType},
         product_logging::framework::STACKABLE_LOG_DIR,
@@ -84,6 +86,14 @@ pub const CONFIG_PATH: &str = "/stackable/app/config";
 pub const LOG_CONFIG_DIR: &str = "/stackable/app/log_config";
 pub const AIRFLOW_HOME: &str = "/stackable/airflow";
 
+// The `stackable-telemetry` variables which configure the file logs of the `containerdebug`
+// process. They are set on the Airflow container in `env_vars`, and the start command below
+// references the directory as a shell variable, so that an `envOverrides` entry for it takes
+// effect in both places.
+constant!(pub FILE_LOG_DIRECTORY: EnvVarName = "FILE_LOG_DIRECTORY");
+constant!(pub FILE_LOG_MAX_FILES: EnvVarName = "FILE_LOG_MAX_FILES");
+constant!(pub FILE_LOG_ROTATION_PERIOD: EnvVarName = "FILE_LOG_ROTATION_PERIOD");
+
 constant!(pub TEMPLATE_VOLUME_NAME: VolumeName = "airflow-executor-pod-template");
 pub const TEMPLATE_LOCATION: &str = "/templates";
 pub const TEMPLATE_NAME: &str = "airflow_executor_pod_template.yaml";
@@ -779,9 +789,11 @@ fn container_debug_command() -> String {
     // The log directory is created here, because `FILE_LOG_MAX_FILES` makes the telemetry library
     // prune old log files before it creates the first one, which complains about the directory not
     // existing yet.
-    format!(
-        "mkdir --parents \"$FILE_LOG_DIRECTORY\"\n\
-         containerdebug --output={STACKABLE_LOG_DIR}/containerdebug-state.json --loop &"
+    formatdoc!(
+        r#"
+        mkdir --parents "${file_log_directory}" || true
+        containerdebug --output={STACKABLE_LOG_DIR}/containerdebug-state.json --loop &"#,
+        file_log_directory = FILE_LOG_DIRECTORY.as_ref(),
     )
 }
 
@@ -1035,6 +1047,9 @@ mod tests {
         let _ = *WORKER_ROLE_NAME;
         let _ = *DAG_PROCESSOR_ROLE_NAME;
         let _ = *TRIGGERER_ROLE_NAME;
+        let _ = *FILE_LOG_DIRECTORY;
+        let _ = *FILE_LOG_MAX_FILES;
+        let _ = *FILE_LOG_ROTATION_PERIOD;
         let _ = *TEMPLATE_VOLUME_NAME;
         let _ = *LISTENER_PVC_NAME;
         let _ = *METRICS_CONTAINER_NAME;