Make SparkApplication.Spec.Suspend be a pointer

Signed-off-by: Shingo Omura <[email protected]>

Author: everpeace

api/v1beta2/sparkapplication_types.go

@@ -41,7 +41,7 @@ type SparkApplicationSpec struct {
 	// (i.e. the flag goes from false to true), the Spark operator will delete
 	// all active Pods associated with this SparkApplication.
 	// Users must design their Spark application to gracefully handle this.
-	Suspend bool `json:"suspend"`
+	Suspend *bool `json:"suspend,omitempty"`
 	// Type tells the type of the Spark application.
 	// +kubebuilder:validation:Enum={Java,Python,Scala,R}
 	Type SparkApplicationType `json:"type"`

api/v1beta2/zz_generated.deepcopy.go

@@ -12409,7 +12409,6 @@ spec:
                 - executor
                 - mainApplicationFile
                 - sparkVersion
-                - suspend
                 - type
                 type: object
               timeZone:

charts/spark-operator-chart/crds/sparkoperator.k8s.io_scheduledsparkapplications.yaml

@@ -12323,7 +12323,6 @@ spec:
             - executor
             - mainApplicationFile
             - sparkVersion
-            - suspend
             - type
             type: object
           status:

charts/spark-operator-chart/crds/sparkoperator.k8s.io_sparkapplications.yaml

@@ -12409,7 +12409,6 @@ spec:
                 - executor
                 - mainApplicationFile
                 - sparkVersion
-                - suspend
                 - type
                 type: object
               timeZone:

config/crd/bases/sparkoperator.k8s.io_scheduledsparkapplications.yaml

@@ -12323,7 +12323,6 @@ spec:
             - executor
             - mainApplicationFile
             - sparkVersion
-            - suspend
             - type
             type: object
           status:

config/crd/bases/sparkoperator.k8s.io_sparkapplications.yaml

@@ -34,6 +34,8 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/tools/record"
 	"k8s.io/client-go/util/retry"
+	"k8s.io/utils/ptr"
+
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/builder"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -197,7 +199,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
 		return r.handleSparkApplicationDeletion(ctx, req)
 	}
 
-	if app.Spec.Suspend {
+	if ptr.Deref(app.Spec.Suspend, false) {
 		if !util.IsTerminated(app) &&
 			app.Status.AppState.State != v1beta2.ApplicationStateSuspended &&
 			app.Status.AppState.State != v1beta2.ApplicationStateSuspending {
@@ -781,7 +783,7 @@ func (r *Reconciler) reconcileSuspendedSparkApplication(ctx context.Context, req
 				logger.Info("Successfully deleted resources associated with SparkApplication", "name", app.Name, "namespace", app.Namespace, "state", app.Status.AppState.State)
 				r.resetSparkApplicationStatus(app)
 				r.recordSparkApplicationEvent(app)
-				if !app.Spec.Suspend {
+				if !ptr.Deref(app.Spec.Suspend, false) {
 					app.Status.AppState = v1beta2.ApplicationState{
 						State: v1beta2.ApplicationStateResuming,
 					}

internal/controller/sparkapplication/controller.go

@@ -30,6 +30,8 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/tools/record"
+	"k8s.io/utils/ptr"
+
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
@@ -781,7 +783,7 @@ var _ = Describe("SparkApplication Controller", func() {
 		Context("Suspend", func() {
 			When("reconciling a new SparkApplication with Suspend=True", func() {
 				BeforeEach(func() {
-					app.Spec.Suspend = true
+					app.Spec.Suspend = ptr.To(true)
 					Expect(k8sClient.Create(ctx, app)).To(Succeed())
 				})
 				AfterEach(func() {
@@ -834,7 +836,7 @@ var _ = Describe("SparkApplication Controller", func() {
 					executorPod2.Status.Phase = corev1.PodRunning
 					Expect(k8sClient.Status().Update(ctx, executorPod2)).To(Succeed())
 
-					app.Spec.Suspend = true
+					app.Spec.Suspend = ptr.To(true)
 					Expect(k8sClient.Update(ctx, app)).To(Succeed())
 				})
 				AfterEach(func() {
@@ -879,7 +881,7 @@ var _ = Describe("SparkApplication Controller", func() {
 			})
 			When("reconciling a Terminated(Failed or Completed) SparkApplication with Suspend=true", func() {
 				BeforeEach(func() {
-					app.Spec.Suspend = true
+					app.Spec.Suspend = ptr.To(true)
 					Expect(k8sClient.Create(ctx, app)).To(Succeed())
 					app.Status.AppState.State = v1beta2.ApplicationStateFailed
 					Expect(k8sClient.Status().Update(ctx, app)).To(Succeed())
@@ -913,7 +915,7 @@ var _ = Describe("SparkApplication Controller", func() {
 			})
 			When("reconciling Resuming SparkApplication with Suspend=true", func() {
 				BeforeEach(func() {
-					app.Spec.Suspend = true
+					app.Spec.Suspend = ptr.To(true)
 					Expect(k8sClient.Create(ctx, app)).To(Succeed())
 					app.Status.AppState.State = v1beta2.ApplicationStateResuming
 					Expect(k8sClient.Status().Update(ctx, app)).To(Succeed())
@@ -948,7 +950,7 @@ var _ = Describe("SparkApplication Controller", func() {
 			When("reconciling a Suspending SparkApplication with Suspend=true", func() {
 				var driverPod *corev1.Pod
 				BeforeEach(func() {
-					app.Spec.Suspend = true
+					app.Spec.Suspend = ptr.To(true)
 					Expect(k8sClient.Create(ctx, app)).To(Succeed())
 
 					driverPod = createDriverPod(appName, appNamespace)
@@ -994,7 +996,7 @@ var _ = Describe("SparkApplication Controller", func() {
 		Context("Resume", func() {
 			When("reconciling Suspended SparkApplication with Suspend=false(resuming)", func() {
 				BeforeEach(func() {
-					app.Spec.Suspend = false
+					app.Spec.Suspend = ptr.To(false)
 					Expect(k8sClient.Create(ctx, app)).To(Succeed())
 					app.Status.AppState.State = v1beta2.ApplicationStateSuspended
 					Expect(k8sClient.Status().Update(ctx, app)).To(Succeed())
@@ -1029,7 +1031,7 @@ var _ = Describe("SparkApplication Controller", func() {
 			When("reconciling Suspending SparkApplication with Suspend=false(resuming)", func() {
 				var driverPod *corev1.Pod
 				BeforeEach(func() {
-					app.Spec.Suspend = false
+					app.Spec.Suspend = ptr.To(false)
 					Expect(k8sClient.Create(ctx, app)).To(Succeed())
 
 					driverPod = createDriverPod(appName, appNamespace)
@@ -1081,7 +1083,7 @@ var _ = Describe("SparkApplication Controller", func() {
 			})
 			When("reconciling Resuming SparkApplication with Suspend=false(resuming)", func() {
 				BeforeEach(func() {
-					app.Spec.Suspend = false
+					app.Spec.Suspend = ptr.To(false)
 					Expect(k8sClient.Create(ctx, app)).To(Succeed())
 					app.Status.AppState.State = v1beta2.ApplicationStateResuming
 					Expect(k8sClient.Status().Update(ctx, app)).To(Succeed())

internal/controller/sparkapplication/controller_test.go

@@ -33,6 +33,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/apimachinery/pkg/util/yaml"
+	"k8s.io/utils/ptr"
 
 	"github.com/kubeflow/spark-operator/v2/api/v1beta2"
 	"github.com/kubeflow/spark-operator/v2/pkg/common"
@@ -439,7 +440,7 @@ var _ = Describe("Example SparkApplication", func() {
 
 			By("Suspending Spark Application")
 			Expect(k8sClient.Get(ctx, key, app)).To(Succeed())
-			app.Spec.Suspend = true
+			app.Spec.Suspend = ptr.To(true)
 			Expect(k8sClient.Update(ctx, app)).To(Succeed())
 
 			By("Waiting for SparkApplication to Suspended")
@@ -451,7 +452,7 @@ var _ = Describe("Example SparkApplication", func() {
 
 			By("Resuming for SparkApplication")
 			Expect(k8sClient.Get(ctx, key, app)).To(Succeed())
-			app.Spec.Suspend = false
+			app.Spec.Suspend = ptr.To(false)
 			Expect(k8sClient.Update(ctx, app)).To(Succeed())
 
 			By("Waiting for SparkApplication to Running")