Improve the field documentation of 'SparkApplication.Spec.Suspend' to make it more descriptive

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

Author: everpeace

api/v1beta2/sparkapplication_types.go

@@ -35,9 +35,9 @@ type SparkApplicationSpec struct {
 	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
 	// Important: Run "make generate" to regenerate code after modifying this file
 
-	// Suspend specifies whether the Spark operator should create Pods or not.
-	// If a SparkApplication is created with suspend set to true, no Pods are created
-	// by the Spark operator. If a SparkApplication is suspended after creation
+	// Suspend indicates whether the SparkApplication should be suspended.
+	// When true, the controller skips submitting the Spark job.
+	// If a SparkApplication is suspended after creation
 	// (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.

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

@@ -10572,9 +10572,9 @@ spec:
                     type: string
                   suspend:
                     description: |-
-                      Suspend specifies whether the Spark operator should create Pods or not.
-                      If a SparkApplication is created with suspend set to true, no Pods are created
-                      by the Spark operator. If a SparkApplication is suspended after creation
+                      Suspend indicates whether the SparkApplication should be suspended.
+                      When true, the controller skips submitting the Spark job.
+                      If a SparkApplication is suspended after creation
                       (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.

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

@@ -10493,9 +10493,9 @@ spec:
                 type: string
               suspend:
                 description: |-
-                  Suspend specifies whether the Spark operator should create Pods or not.
-                  If a SparkApplication is created with suspend set to true, no Pods are created
-                  by the Spark operator. If a SparkApplication is suspended after creation
+                  Suspend indicates whether the SparkApplication should be suspended.
+                  When true, the controller skips submitting the Spark job.
+                  If a SparkApplication is suspended after creation
                   (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.

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

@@ -10572,9 +10572,9 @@ spec:
                     type: string
                   suspend:
                     description: |-
-                      Suspend specifies whether the Spark operator should create Pods or not.
-                      If a SparkApplication is created with suspend set to true, no Pods are created
-                      by the Spark operator. If a SparkApplication is suspended after creation
+                      Suspend indicates whether the SparkApplication should be suspended.
+                      When true, the controller skips submitting the Spark job.
+                      If a SparkApplication is suspended after creation
                       (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.

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

@@ -10493,9 +10493,9 @@ spec:
                 type: string
               suspend:
                 description: |-
-                  Suspend specifies whether the Spark operator should create Pods or not.
-                  If a SparkApplication is created with suspend set to true, no Pods are created
-                  by the Spark operator. If a SparkApplication is suspended after creation
+                  Suspend indicates whether the SparkApplication should be suspended.
+                  When true, the controller skips submitting the Spark job.
+                  If a SparkApplication is suspended after creation
                   (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.

docs/api-docs.md

@@ -244,9 +244,9 @@ bool
 </em>
 </td>
 <td>
-<p>Suspend specifies whether the Spark operator should create Pods or not.
-If a SparkApplication is created with suspend set to true, no Pods are created
-by the Spark operator. If a SparkApplication is suspended after creation
+<p>Suspend indicates whether the SparkApplication should be suspended.
+When true, the controller skips submitting the Spark job.
+If a SparkApplication is suspended after creation
 (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.</p>
@@ -2359,9 +2359,9 @@ bool
 </em>
 </td>
 <td>
-<p>Suspend specifies whether the Spark operator should create Pods or not.
-If a SparkApplication is created with suspend set to true, no Pods are created
-by the Spark operator. If a SparkApplication is suspended after creation
+<p>Suspend indicates whether the SparkApplication should be suspended.
+When true, the controller skips submitting the Spark job.
+If a SparkApplication is suspended after creation
 (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.</p>