refactor: use VolumeName and Port types

Author: maltesander

rust/operator-binary/src/airflow_controller.rs

@@ -354,7 +354,7 @@ pub async fn reconcile_airflow(
                 &validated_cluster.image,
                 &Vec::<EnvVar>::from(validated_rg_config.env_overrides.clone()),
                 &airflow.volume_mounts(),
-                LOG_VOLUME_NAME,
+                LOG_VOLUME_NAME.as_ref(),
                 &validated_rg_config
                     .config
                     .logging
@@ -484,7 +484,7 @@ async fn build_executor_template(
         &validated_cluster.image,
         &env_vars_from_overrides(&common_config.env_overrides),
         &airflow.volume_mounts(),
-        LOG_VOLUME_NAME,
+        LOG_VOLUME_NAME.as_ref(),
         &merged_executor_config
             .logging
             .for_container(&Container::GitSync),

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

@@ -134,11 +134,11 @@ pub fn build_executor_template_config_map(
         ))
         .add_volume_mounts(cluster.volume_mounts())
         .context(AddVolumeMountSnafu)?
-        .add_volume_mount(CONFIG_VOLUME_NAME, CONFIG_PATH)
+        .add_volume_mount(&*CONFIG_VOLUME_NAME, CONFIG_PATH)
         .context(AddVolumeMountSnafu)?
-        .add_volume_mount(LOG_CONFIG_VOLUME_NAME, LOG_CONFIG_DIR)
+        .add_volume_mount(&*LOG_CONFIG_VOLUME_NAME, LOG_CONFIG_DIR)
         .context(AddVolumeMountSnafu)?
-        .add_volume_mount(LOG_VOLUME_NAME, STACKABLE_LOG_DIR)
+        .add_volume_mount(&*LOG_VOLUME_NAME, STACKABLE_LOG_DIR)
         .context(AddVolumeMountSnafu)?;
 
     add_git_sync_resources(

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

@@ -14,12 +14,15 @@ use stackable_operator::{
         builder::pod::container::EnvVarSet,
         product_logging::framework::{VectorContainerLogConfig, vector_container},
         role_group_utils::ResourceNames,
-        types::kubernetes::{ContainerName, VolumeName},
+        types::kubernetes::ContainerName,
     },
 };
 
-use crate::crd::authentication::{
-    AirflowAuthenticationClassResolved, AirflowClientAuthenticationDetailsResolved,
+use crate::{
+    controller_commons::{CONFIG_VOLUME_NAME, LOG_VOLUME_NAME},
+    crd::authentication::{
+        AirflowAuthenticationClassResolved, AirflowClientAuthenticationDetailsResolved,
+    },
 };
 
 #[derive(Snafu, Debug)]
@@ -112,10 +115,6 @@ pub(crate) fn add_git_sync_resources(
 }
 
 stackable_operator::constant!(VECTOR_CONTAINER_NAME: ContainerName = "vector");
-// Typed volume names required by the v2 `vector_container`. Their values match the `&str`
-// constants in `controller_commons` used elsewhere to build the same volumes.
-stackable_operator::constant!(CONFIG_VOLUME_NAME_TYPED: VolumeName = "config");
-stackable_operator::constant!(LOG_VOLUME_NAME_TYPED: VolumeName = "log");
 
 /// Builds the Vector log-collection sidecar container from the up-front-validated logging config.
 pub(crate) fn build_logging_container(
@@ -128,8 +127,8 @@ pub(crate) fn build_logging_container(
         resolved_product_image,
         vector_log_config,
         resource_names,
-        &CONFIG_VOLUME_NAME_TYPED,
-        &LOG_VOLUME_NAME_TYPED,
+        &CONFIG_VOLUME_NAME,
+        &LOG_VOLUME_NAME,
         EnvVarSet::new(),
     )
 }

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

@@ -6,7 +6,7 @@ use stackable_operator::{
             meta::ownerreference_from_resource,
             service::{Scheme, Scraping, prometheus_annotations, prometheus_labels},
         },
-        types::{common::Port, operator::RoleGroupName},
+        types::operator::RoleGroupName,
     },
 };
 
@@ -69,7 +69,7 @@ pub fn build_rolegroup_metrics_service(
                 &Scraping::Enabled,
                 &Scheme::Http,
                 "/metrics",
-                &Port(METRICS_PORT),
+                &METRICS_PORT,
             ))
             .build(),
         spec: Some(ServiceSpec {

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

@@ -197,26 +197,27 @@ pub fn build_server_rolegroup_statefulset(
         .add_volume_mounts(volume_mounts)
         .context(AddVolumeMountSnafu)?;
     airflow_container
-        .add_volume_mount(CONFIG_VOLUME_NAME, CONFIG_PATH)
+        .add_volume_mount(&*CONFIG_VOLUME_NAME, CONFIG_PATH)
         .context(AddVolumeMountSnafu)?;
     airflow_container
-        .add_volume_mount(LOG_CONFIG_VOLUME_NAME, LOG_CONFIG_DIR)
+        .add_volume_mount(&*LOG_CONFIG_VOLUME_NAME, LOG_CONFIG_DIR)
         .context(AddVolumeMountSnafu)?;
     airflow_container
-        .add_volume_mount(LOG_VOLUME_NAME, STACKABLE_LOG_DIR)
+        .add_volume_mount(&*LOG_VOLUME_NAME, STACKABLE_LOG_DIR)
         .context(AddVolumeMountSnafu)?;
 
     if let AirflowExecutor::KubernetesExecutors { .. } = executor {
         airflow_container
-            .add_volume_mount(TEMPLATE_VOLUME_NAME, TEMPLATE_LOCATION)
+            .add_volume_mount(&*TEMPLATE_VOLUME_NAME, TEMPLATE_LOCATION)
             .context(AddVolumeMountSnafu)?;
     }
 
     // for roles with an http endpoint
     if let Some(http_port) = airflow_role.get_http_port() {
+        let http_port = i32::from(http_port);
         let probe = Probe {
             tcp_socket: Some(TCPSocketAction {
-                port: IntOrString::Int(http_port.into()),
+                port: IntOrString::Int(http_port),
                 ..TCPSocketAction::default()
             }),
             initial_delay_seconds: Some(60),
@@ -226,7 +227,7 @@ pub fn build_server_rolegroup_statefulset(
         };
         airflow_container.readiness_probe(probe.clone());
         airflow_container.liveness_probe(probe);
-        airflow_container.add_container_port(HTTP_PORT_NAME, http_port.into());
+        airflow_container.add_container_port(HTTP_PORT_NAME, http_port);
     }
 
     let mut pvcs: Option<Vec<PersistentVolumeClaim>> = None;
@@ -249,7 +250,7 @@ pub fn build_server_rolegroup_statefulset(
         pvcs = Some(vec![pvc]);
 
         airflow_container
-            .add_volume_mount(LISTENER_VOLUME_NAME, LISTENER_VOLUME_DIR)
+            .add_volume_mount(&*LISTENER_VOLUME_NAME, LISTENER_VOLUME_DIR)
             .context(AddVolumeMountSnafu)?;
     }
 
@@ -326,7 +327,7 @@ pub fn build_server_rolegroup_statefulset(
 
     if let AirflowExecutor::KubernetesExecutors { .. } = executor {
         pb.add_volume(
-            VolumeBuilder::new(TEMPLATE_VOLUME_NAME)
+            VolumeBuilder::new(&*TEMPLATE_VOLUME_NAME)
                 .with_config_map(validated_cluster.executor_template_configmap_name())
                 .build(),
         )

rust/operator-binary/src/controller_commons.rs

@@ -1,3 +1,5 @@
+use std::str::FromStr;
+
 use stackable_operator::{
     builder::pod::volume::VolumeBuilder,
     k8s_openapi::api::core::v1::{ConfigMapVolumeSource, EmptyDirVolumeSource, Volume},
@@ -8,13 +10,14 @@ use stackable_operator::{
             CustomContainerLogConfig,
         },
     },
+    v2::types::kubernetes::VolumeName,
 };
 
 use crate::crd::MAX_LOG_FILES_SIZE;
 
-pub const CONFIG_VOLUME_NAME: &str = "config";
-pub const LOG_CONFIG_VOLUME_NAME: &str = "log-config";
-pub const LOG_VOLUME_NAME: &str = "log";
+stackable_operator::constant!(pub CONFIG_VOLUME_NAME: VolumeName = "config");
+stackable_operator::constant!(pub LOG_CONFIG_VOLUME_NAME: VolumeName = "log-config");
+stackable_operator::constant!(pub LOG_VOLUME_NAME: VolumeName = "log");
 
 pub fn create_volumes(
     config_map_name: &str,
@@ -23,12 +26,12 @@ pub fn create_volumes(
     let mut volumes = Vec::new();
 
     volumes.push(
-        VolumeBuilder::new(CONFIG_VOLUME_NAME)
+        VolumeBuilder::new(&*CONFIG_VOLUME_NAME)
             .with_config_map(config_map_name)
             .build(),
     );
     volumes.push(Volume {
-        name: LOG_VOLUME_NAME.into(),
+        name: LOG_VOLUME_NAME.to_string(),
         empty_dir: Some(EmptyDirVolumeSource {
             medium: None,
             size_limit: Some(product_logging::framework::calculate_log_volume_size_limit(
@@ -46,7 +49,7 @@ pub fn create_volumes(
     }) = log_config
     {
         volumes.push(Volume {
-            name: LOG_CONFIG_VOLUME_NAME.into(),
+            name: LOG_CONFIG_VOLUME_NAME.to_string(),
             config_map: Some(ConfigMapVolumeSource {
                 name: config_map.into(),
                 ..ConfigMapVolumeSource::default()
@@ -55,7 +58,7 @@ pub fn create_volumes(
         });
     } else {
         volumes.push(Volume {
-            name: LOG_CONFIG_VOLUME_NAME.into(),
+            name: LOG_CONFIG_VOLUME_NAME.to_string(),
             config_map: Some(ConfigMapVolumeSource {
                 name: config_map_name.into(),
                 ..ConfigMapVolumeSource::default()

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

@@ -40,7 +40,10 @@ use stackable_operator::{
         config_overrides::KeyValueConfigOverrides,
         flask_config_writer::{FlaskAppConfigOptions, PythonType},
         role_utils::GenericCommonConfig,
-        types::kubernetes::{ConfigMapName, ListenerClassName, ListenerName, SecretName},
+        types::{
+            common::Port,
+            kubernetes::{ConfigMapName, ListenerClassName, ListenerName, SecretName, VolumeName},
+        },
     },
     versioned::versioned,
 };
@@ -76,17 +79,17 @@ pub const LOG_CONFIG_DIR: &str = "/stackable/app/log_config";
 pub const AIRFLOW_HOME: &str = "/stackable/airflow";
 pub const AIRFLOW_CONFIG_FILENAME: &str = "webserver_config.py";
 
-pub const TEMPLATE_VOLUME_NAME: &str = "airflow-executor-pod-template";
+stackable_operator::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";
 
-pub const LISTENER_VOLUME_NAME: &str = "listener";
+stackable_operator::constant!(pub LISTENER_VOLUME_NAME: VolumeName = "listener");
 pub const LISTENER_VOLUME_DIR: &str = "/stackable/listener";
 
 pub const HTTP_PORT_NAME: &str = "http";
-pub const HTTP_PORT: u16 = 8080;
+pub const HTTP_PORT: Port = Port(8080);
 pub const METRICS_PORT_NAME: &str = "metrics";
-pub const METRICS_PORT: u16 = 9102;
+pub const METRICS_PORT: Port = Port(9102);
 
 const DEFAULT_AIRFLOW_GRACEFUL_SHUTDOWN_TIMEOUT: Duration = Duration::from_minutes_unchecked(2);
 const DEFAULT_WORKER_GRACEFUL_SHUTDOWN_TIMEOUT: Duration = Duration::from_minutes_unchecked(5);
@@ -719,7 +722,7 @@ impl AirflowRole {
 
     /// Will be used to expose service ports and - by extension - which roles should be
     /// created as services.
-    pub fn get_http_port(&self) -> Option<u16> {
+    pub fn get_http_port(&self) -> Option<Port> {
         match &self {
             AirflowRole::Webserver => Some(HTTP_PORT),
             AirflowRole::Scheduler => None,