Skip to content

fix(docs): Update getting-started script pre-26.3.0 #667

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NickLarsenNZ merged 2 commits into from
Mar 12, 2026
Merged

fix(docs): Update getting-started script pre-26.3.0 #667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4acf647
docs(getting_started): Sleep until CRD is installed
NickLarsenNZ Mar 11, 2026
707bf93
wait for job to finish and remove doc references to the driver pod
razvan Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 25 additions & 10 deletions docs/modules/spark-k8s/examples/getting_started/getting_started.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,25 @@ exit 1
;;
esac

# TODO: Remove once https://github.com/stackabletech/issues/issues/828 has been
# implemented (see that issue for details).
until kubectl get crd sparkapplications.spark.stackable.tech >/dev/null 2>&1; do
echo "Waiting for CRDs to be installed"
sleep 1
done
until kubectl get crd sparkhistoryservers.spark.stackable.tech >/dev/null 2>&1; do
echo "Waiting for CRDs to be installed"
sleep 1
done
until kubectl get crd sparkconnectservers.spark.stackable.tech >/dev/null 2>&1; do
echo "Waiting for CRDs to be installed"
sleep 1
done
until kubectl get crd sparkapptemplates.spark.stackable.tech >/dev/null 2>&1; do
echo "Waiting for CRDs to be installed"
sleep 1
done

echo "Creating a Spark Application..."
# tag::install-sparkapp[]
kubectl apply -f application.yaml
Expand All @@ -54,16 +73,12 @@ sleep 15

echo "Waiting for job to complete ..."
# tag::wait-for-job[]
kubectl wait pods -l 'job-name=pyspark-pi' \
if kubectl wait pods -l 'job-name=pyspark-pi' \
--for jsonpath='{.status.phase}'=Succeeded \
--timeout 300s
# end::wait-for-job[]

result=$(kubectl logs -l 'spark-role=driver' --tail=-1 | grep "Pi is roughly")

if [ "$result" == "" ]; then
echo "Log result was not found!"
exit 1
--timeout 300s; then
echo "job succeeded"
else
echo "Job result:" "$result"
echo "job failed"
exit 1
fi
# end::wait-for-job[]
35 changes: 25 additions & 10 deletions docs/modules/spark-k8s/examples/getting_started/getting_started.sh.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,25 @@ exit 1
;;
esac

# TODO: Remove once https://github.com/stackabletech/issues/issues/828 has been
# implemented (see that issue for details).
until kubectl get crd sparkapplications.spark.stackable.tech >/dev/null 2>&1; do
echo "Waiting for CRDs to be installed"
sleep 1
done
until kubectl get crd sparkhistoryservers.spark.stackable.tech >/dev/null 2>&1; do
echo "Waiting for CRDs to be installed"
sleep 1
done
until kubectl get crd sparkconnectservers.spark.stackable.tech >/dev/null 2>&1; do
echo "Waiting for CRDs to be installed"
sleep 1
done
until kubectl get crd sparkapptemplates.spark.stackable.tech >/dev/null 2>&1; do
echo "Waiting for CRDs to be installed"
sleep 1
done

echo "Creating a Spark Application..."
# tag::install-sparkapp[]
kubectl apply -f application.yaml
Expand All @@ -54,16 +73,12 @@ sleep 15

echo "Waiting for job to complete ..."
# tag::wait-for-job[]
kubectl wait pods -l 'job-name=pyspark-pi' \
if kubectl wait pods -l 'job-name=pyspark-pi' \
--for jsonpath='{.status.phase}'=Succeeded \
--timeout 300s
# end::wait-for-job[]

result=$(kubectl logs -l 'spark-role=driver' --tail=-1 | grep "Pi is roughly")

if [ "$result" == "" ]; then
echo "Log result was not found!"
exit 1
--timeout 300s; then
echo "job succeeded"
else
echo "Job result:" "$result"
echo "job failed"
exit 1
fi
# end::wait-for-job[]
Binary file removed docs/modules/spark-k8s/images/getting_started/spark_log.png
View file
Open in desktop
Binary file not shown.
5 changes: 0 additions & 5 deletions docs/modules/spark-k8s/pages/getting_started/first_steps.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,3 @@ The initial job is persisted for several minutes before being removed.
The completed state looks like this:

image::getting_started/spark_complete.png[Completed job]

The driver logs can be inspected for more information about the results of the job.
In this case the result of our (approximate!) pi calculation can be found:

image::getting_started/spark_log.png[Driver log]
Loading