refactor: deprecate application spec.mode

Author: razvan

CHANGELOG.md

@@ -33,7 +33,7 @@ All notable changes to this project will be documented in this file.
 ### Deprecated
 
 - `SparkApplication`/`SparkApplicationTemplate` `spec.job` is deprecated and ignored since `v1alpha2` (renamed to `deprecatedJob` in that version). The driver `Job` is now built from `spec.driver` ([#711]).
-- `SparkApplication`/`SparkApplicationTemplate` `spec.mode` is deprecated and ignored: the operator always runs the driver in client mode internally ([#711]).
+- `SparkApplication`/`SparkApplicationTemplate` `spec.mode` is deprecated and ignored (renamed to `deprecatedMode` in `v1alpha2`): the operator always runs the driver in client mode internally. `mode` is now optional in `v1alpha1` as well ([#711]).
 
 [#674]: https://github.com/stackabletech/spark-k8s-operator/pull/674
 [#679]: https://github.com/stackabletech/spark-k8s-operator/pull/679

extra/crds.yaml

@@ -241,6 +241,19 @@ spec:
                     type: object
                     x-kubernetes-preserve-unknown-fields: true
                 type: object
+              deprecatedMode:
+                default: cluster
+                description: |-
+                  Deprecated and ignored.
+
+                  Since v1alpha2 the operator no longer runs a separate `spark-submit` process. The driver
+                  is launched directly as a Kubernetes Job running in client mode, so the deploy mode is
+                  always client internally. This field is kept for backwards compatibility but has no
+                  effect.
+                enum:
+                - cluster
+                - client
+                type: string
               deps:
                 default:
                   excludePackages: []
@@ -1977,18 +1990,6 @@ spec:
                 description: The main class - i.e. entry point - for JVM artifacts.
                 nullable: true
                 type: string
-              mode:
-                description: |-
-                  Deprecated and ignored.
-
-                  Since v1alpha2 the operator no longer runs a separate `spark-submit` process. The driver
-                  is launched directly as a Kubernetes Job running in client mode, so the deploy mode is
-                  always client internally. This field is kept for backwards compatibility but has no
-                  effect.
-                enum:
-                - cluster
-                - client
-                type: string
               s3connection:
                 description: |-
                   Configure an S3 connection that the SparkApplication has access to.
@@ -2226,7 +2227,6 @@ spec:
                 type: array
             required:
             - mainApplicationFile
-            - mode
             - sparkImage
             type: object
           status:
@@ -4233,6 +4233,7 @@ spec:
                 nullable: true
                 type: string
               mode:
+                default: cluster
                 description: |-
                   Deprecated and ignored.
 
@@ -4481,7 +4482,6 @@ spec:
                 type: array
             required:
             - mainApplicationFile
-            - mode
             - sparkImage
             type: object
           status:
@@ -7140,6 +7140,19 @@ spec:
                     type: object
                     x-kubernetes-preserve-unknown-fields: true
                 type: object
+              deprecatedMode:
+                default: cluster
+                description: |-
+                  Deprecated and ignored.
+
+                  Since v1alpha2 the operator no longer runs a separate `spark-submit` process. The driver
+                  is launched directly as a Kubernetes Job running in client mode, so the deploy mode is
+                  always client internally. This field is kept for backwards compatibility but has no
+                  effect.
+                enum:
+                - cluster
+                - client
+                type: string
               deps:
                 default:
                   excludePackages: []
@@ -8876,18 +8889,6 @@ spec:
                 description: The main class - i.e. entry point - for JVM artifacts.
                 nullable: true
                 type: string
-              mode:
-                description: |-
-                  Deprecated and ignored.
-
-                  Since v1alpha2 the operator no longer runs a separate `spark-submit` process. The driver
-                  is launched directly as a Kubernetes Job running in client mode, so the deploy mode is
-                  always client internally. This field is kept for backwards compatibility but has no
-                  effect.
-                enum:
-                - cluster
-                - client
-                type: string
               s3connection:
                 description: |-
                   Configure an S3 connection that the SparkApplication has access to.
@@ -9125,7 +9126,6 @@ spec:
                 type: array
             required:
             - mainApplicationFile
-            - mode
             - sparkImage
             type: object
         required:
@@ -11096,6 +11096,7 @@ spec:
                 nullable: true
                 type: string
               mode:
+                default: cluster
                 description: |-
                   Deprecated and ignored.
 
@@ -11344,7 +11345,6 @@ spec:
                 type: array
             required:
             - mainApplicationFile
-            - mode
             - sparkImage
             type: object
         required:

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

@@ -222,7 +222,12 @@ pub mod versioned {
         /// is launched directly as a Kubernetes Job running in client mode, so the deploy mode is
         /// always client internally. This field is kept for backwards compatibility but has no
         /// effect.
-        pub mode: SparkMode,
+        #[versioned(deprecated(
+            since = "v1alpha2",
+            note = "the operator always runs the driver in client mode; this field is ignored"
+        ))]
+        #[serde(default)]
+        pub deprecated_mode: SparkMode,
 
         /// The main class - i.e. entry point - for JVM artifacts.
         #[serde(default, skip_serializing_if = "Option::is_none")]

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

@@ -88,10 +88,13 @@ pub enum SparkContainer {
     Vector,
     Tls,
 }
-#[derive(Clone, Debug, Deserialize, Display, JsonSchema, PartialEq, Serialize)]
+#[derive(Clone, Debug, Default, Deserialize, Display, JsonSchema, PartialEq, Serialize)]
 #[serde(rename_all = "lowercase")]
 #[strum(serialize_all = "lowercase")]
 pub enum SparkMode {
+    // Deprecated and ignored: the operator always runs the driver in client mode. The default only
+    // exists so the deprecated `mode` field can be optional.
+    #[default]
     Cluster,
     Client,
 }

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

@@ -37,7 +37,7 @@ pub fn deep_merge(base: &SparkApplication, overlay: &SparkApplication) -> SparkA
     // Merge spec fields
     let spec = super::v1alpha2::SparkApplicationSpec {
         // Scalar fields: overlay takes precedence
-        mode: overlay.spec.mode.clone(),
+        deprecated_mode: overlay.spec.deprecated_mode.clone(),
         main_application_file: overlay.spec.main_application_file.clone(),
 
         // Option fields: overlay if Some, otherwise base