add doc page for app status

stackabletech · Sep 12, 2024 · 3a589de · 3a589de
1 parent 2629b75
commit 3a589de
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/modules/spark-k8s/pages/usage-guide/operations/applications.adoc b/docs/modules/spark-k8s/pages/usage-guide/operations/applications.adoc
@@ -0,0 +1,7 @@
+= Spark Applications
+
+Spark applications are submitted to the Spark Operator as SparkApplication resources. These resources are used to define the configuration of the Spark job, including the image to use, the main application file, and the number of executors to start.
+
+Upon creation, the application's status set to `Unknown`. As the operator creates the necessary resources, the status of the application transisions through different phases that reflect the phase of the driver Pod. A successful application will eventually reach the `Succeeded` phase.
+
+The operator will never reconcile an application once it has been created. To resubmit an application, a new SparkApplication resource must be created.
diff --git a/docs/modules/spark-k8s/partials/nav.adoc b/docs/modules/spark-k8s/partials/nav.adoc
@@ -11,6 +11,7 @@
 ** xref:spark-k8s:usage-guide/history-server.adoc[]
 ** xref:spark-k8s:usage-guide/examples.adoc[]
 ** xref:spark-k8s:usage-guide/operations/index.adoc[]
+*** xref:spark-k8s:usage-guide/operations/applications.adoc[]
 *** xref:spark-k8s:usage-guide/operations/pod-placement.adoc[]
 *** xref:spark-k8s:usage-guide/operations/pod-disruptions.adoc[]
 *** xref:spark-k8s:usage-guide/operations/graceful-shutdown.adoc[]