history: move listenerclass to role config

Author: maltesander

deploy/helm/spark-k8s-operator/crds/crds.yaml

@@ -1379,9 +1379,6 @@ spec:
                         cleaner:
                           nullable: true
                           type: boolean
-                        listenerClass:
-                          nullable: true
-                          type: string
                         logging:
                           default:
                             containers: {}
@@ -1556,11 +1553,16 @@ spec:
                       x-kubernetes-preserve-unknown-fields: true
                     roleConfig:
                       default:
+                        listenerClass: cluster-internal
                         podDisruptionBudget:
                           enabled: true
                           maxUnavailable: null
                       description: This is a product-agnostic RoleConfig, which is sufficient for most of the products.
                       properties:
+                        listenerClass:
+                          default: cluster-internal
+                          description: This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) is used to expose the history server.
+                          type: string
                         podDisruptionBudget:
                           default:
                             enabled: true
@@ -1628,9 +1630,6 @@ spec:
                               cleaner:
                                 nullable: true
                                 type: boolean
-                              listenerClass:
-                                nullable: true
-                                type: string
                               logging:
                                 default:
                                   containers: {}

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

@@ -32,7 +32,10 @@ use stackable_operator::{
 use strum::{Display, EnumIter};
 
 use crate::{
-    crd::{affinity::history_affinity, constants::*, logdir::ResolvedLogDir},
+    crd::{
+        affinity::history_affinity, constants::*, history::v1alpha1::SparkHistoryServerRoleConfig,
+        logdir::ResolvedLogDir,
+    },
     history::config::jvm::construct_history_jvm_args,
 };
 
@@ -62,7 +65,6 @@ pub enum Error {
 
 #[versioned(version(name = "v1alpha1"))]
 pub mod versioned {
-
     /// A Spark cluster history server component. This resource is managed by the Stackable operator
     /// for Apache Spark. Find more information on how to use it in the
     /// [operator documentation](DOCS_BASE_URL_PLACEHOLDER/spark-k8s/usage-guide/history-server).
@@ -85,6 +87,7 @@ pub mod versioned {
         ///
         /// This was previously used to hold the listener configuration, which has since moved
         /// to the role configuration.
+        // TODO: remove?
         #[serde(default)]
         pub cluster_config: v1alpha1::SparkHistoryServerClusterConfig,
 
@@ -101,17 +104,32 @@ pub mod versioned {
         pub spark_conf: BTreeMap<String, String>,
 
         /// A history server node role definition.
-        pub nodes: Role<HistoryConfigFragment, GenericRoleConfig, JavaCommonConfig>,
+        pub nodes: Role<HistoryConfigFragment, SparkHistoryServerRoleConfig, JavaCommonConfig>,
     }
 
     #[derive(Clone, Deserialize, Debug, Default, Eq, JsonSchema, PartialEq, Serialize)]
     #[serde(rename_all = "camelCase")]
     pub struct SparkHistoryServerClusterConfig {}
+
+    // TODO: move generic version to op-rs?
+    #[derive(Clone, Debug, Deserialize, JsonSchema, PartialEq, Serialize)]
+    #[serde(rename_all = "camelCase")]
+    pub struct SparkHistoryServerRoleConfig {
+        #[serde(flatten)]
+        pub common: GenericRoleConfig,
+
+        /// This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html)
+        /// is used to expose the history server.
+        #[serde(default = "default_listener_class")]
+        pub listener_class: String,
+    }
 }
 
 impl v1alpha1::SparkHistoryServer {
     /// Returns a reference to the role. Raises an error if the role is not defined.
-    pub fn role(&self) -> &Role<HistoryConfigFragment, GenericRoleConfig, JavaCommonConfig> {
+    pub fn role(
+        &self,
+    ) -> &Role<HistoryConfigFragment, SparkHistoryServerRoleConfig, JavaCommonConfig> {
         &self.spec.nodes
     }
 
@@ -130,6 +148,11 @@ impl v1alpha1::SparkHistoryServer {
             .cloned()
     }
 
+    /// Return the listener class of the role config.
+    pub fn node_listener_class(&self) -> &str {
+        self.spec.nodes.role_config.listener_class.as_str()
+    }
+
     pub fn merged_config(
         &self,
         rolegroup_ref: &RoleGroupRef<Self>,
@@ -188,7 +211,7 @@ impl v1alpha1::SparkHistoryServer {
             String,
             (
                 Vec<PropertyNameKind>,
-                Role<HistoryConfigFragment, GenericRoleConfig, JavaCommonConfig>,
+                Role<HistoryConfigFragment, SparkHistoryServerRoleConfig, JavaCommonConfig>,
             ),
         > = vec![(
             HISTORY_ROLE_NAME.to_string(),
@@ -340,9 +363,6 @@ pub struct HistoryConfig {
     /// This can be shortened by the `maxCertificateLifetime` setting on the SecretClass issuing the TLS certificate.
     #[fragment_attrs(serde(default))]
     pub requested_secret_lifetime: Option<Duration>,
-
-    #[serde(default)]
-    pub listener_class: String,
 }
 
 impl HistoryConfig {
@@ -366,7 +386,6 @@ impl HistoryConfig {
             logging: product_logging::spec::default_logging(),
             affinity: history_affinity(cluster_name),
             requested_secret_lifetime: Some(Self::DEFAULT_HISTORY_SECRET_LIFETIME),
-            listener_class: Some(default_listener_class()),
         }
     }
 }
@@ -403,6 +422,15 @@ impl Configuration for HistoryConfigFragment {
     }
 }
 
+impl Default for v1alpha1::SparkHistoryServerRoleConfig {
+    fn default() -> Self {
+        v1alpha1::SparkHistoryServerRoleConfig {
+            listener_class: default_listener_class(),
+            common: Default::default(),
+        }
+    }
+}
+
 fn default_listener_class() -> String {
     "cluster-internal".to_owned()
 }

rust/operator-binary/src/history/config/jvm.rs

@@ -1,15 +1,13 @@
 use snafu::{ResultExt, Snafu};
-use stackable_operator::role_utils::{
-    self, GenericRoleConfig, JavaCommonConfig, JvmArgumentOverrides, Role,
-};
+use stackable_operator::role_utils::{self, JavaCommonConfig, JvmArgumentOverrides, Role};
 
 use crate::crd::{
     constants::{
         JVM_SECURITY_PROPERTIES_FILE, LOG4J2_CONFIG_FILE, METRICS_PORT,
         STACKABLE_TLS_STORE_PASSWORD, STACKABLE_TRUST_STORE, VOLUME_MOUNT_PATH_CONFIG,
         VOLUME_MOUNT_PATH_LOG_CONFIG,
     },
-    history::HistoryConfigFragment,
+    history::{HistoryConfigFragment, v1alpha1::SparkHistoryServerRoleConfig},
     logdir::ResolvedLogDir,
 };
 
@@ -21,7 +19,7 @@ pub enum Error {
 
 /// JVM arguments that go into `SPARK_HISTORY_OPTS`
 pub fn construct_history_jvm_args(
-    role: &Role<HistoryConfigFragment, GenericRoleConfig, JavaCommonConfig>,
+    role: &Role<HistoryConfigFragment, SparkHistoryServerRoleConfig, JavaCommonConfig>,
     role_group: &str,
     logdir: &ResolvedLogDir,
 ) -> Result<String, Error> {

rust/operator-binary/src/history/history_controller.rs

@@ -333,7 +333,7 @@ pub async fn reconcile(
                 shs,
                 &resolved_product_image,
                 &rgr,
-                merged_config.listener_class.to_string(),
+                shs.node_listener_class().to_string(),
             )?;
             cluster_resources
                 .add(client, rg_group_listener)
@@ -343,7 +343,7 @@ pub async fn reconcile(
 
         let role_config = &shs.spec.nodes.role_config;
         add_pdbs(
-            &role_config.pod_disruption_budget,
+            &role_config.common.pod_disruption_budget,
             shs,
             client,
             &mut cluster_resources,