From 62cce7e45ac95b94579b95987264538c13bd2645 Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Wed, 8 Nov 2023 11:06:02 +0100 Subject: [PATCH 1/4] docs: Document graceful shutdown --- CHANGELOG.md | 1 + .../pages/usage-guide/operations/graceful-shutdown.adoc | 6 ++++++ docs/modules/spark-k8s/partials/nav.adoc | 8 +++++--- 3 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 docs/modules/spark-k8s/pages/usage-guide/operations/graceful-shutdown.adoc diff --git a/CHANGELOG.md b/CHANGELOG.md index e40838dc..f7368c88 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ All notable changes to this project will be documented in this file. - Support PodDisruptionBudgets for HistoryServer ([#288]). - Support for versions 3.4.1, 3.5.0 ([#291]). - History server now exports metrics via jmx exporter (port 18081) ([#291]). +- Document graceful shutdown ([#XXX]). ### Changed diff --git a/docs/modules/spark-k8s/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/spark-k8s/pages/usage-guide/operations/graceful-shutdown.adoc new file mode 100644 index 00000000..85ff1826 --- /dev/null +++ b/docs/modules/spark-k8s/pages/usage-guide/operations/graceful-shutdown.adoc @@ -0,0 +1,6 @@ += Graceful shutdown + +Normally you can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[]. + +However, the spark-k8s operator does not implement any graceful shutdown mechanisms, as the driver and executor Pods are created by Spark itself. +So it's Spark responsibility to handle the shutdown and recovery of Pods. diff --git a/docs/modules/spark-k8s/partials/nav.adoc b/docs/modules/spark-k8s/partials/nav.adoc index 8da19979..27878122 100644 --- a/docs/modules/spark-k8s/partials/nav.adoc +++ b/docs/modules/spark-k8s/partials/nav.adoc @@ -9,7 +9,9 @@ ** xref:spark-k8s:usage-guide/s3.adoc[] ** 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/pod-placement.adoc[] -* xref:spark-k8s:usage-guide/operations/pod-disruptions.adoc[] +** xref:spark-k8s:usage-guide/operations/index.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/pod-disruptions.adoc[] +*** xref:spark-k8s:usage-guide/operations/graceful-shutdown.adoc[] * xref:spark-k8s:crd-reference.adoc[] From a403ff1bf4b0b2be9390a280caa6ea2d359f6f5c Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Wed, 8 Nov 2023 11:08:01 +0100 Subject: [PATCH 2/4] changelog --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f7368c88..57b1b93a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,7 +11,7 @@ All notable changes to this project will be documented in this file. - Support PodDisruptionBudgets for HistoryServer ([#288]). - Support for versions 3.4.1, 3.5.0 ([#291]). - History server now exports metrics via jmx exporter (port 18081) ([#291]). -- Document graceful shutdown ([#XXX]). +- Document graceful shutdown ([#306]). ### Changed @@ -44,6 +44,7 @@ All notable changes to this project will be documented in this file. [#291]: https://github.com/stackabletech/spark-k8s-operator/pull/291 [#297]: https://github.com/stackabletech/spark-k8s-operator/pull/297 [#302]: https://github.com/stackabletech/spark-k8s-operator/pull/302 +[#306]: https://github.com/stackabletech/spark-k8s-operator/pull/306 ## [23.7.0] - 2023-07-14 From 5b318c20a41b38f9e7e5eaec5296772563e54bb2 Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Wed, 8 Nov 2023 11:15:50 +0100 Subject: [PATCH 3/4] wording --- .../pages/usage-guide/operations/graceful-shutdown.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/spark-k8s/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/spark-k8s/pages/usage-guide/operations/graceful-shutdown.adoc index 85ff1826..980e08aa 100644 --- a/docs/modules/spark-k8s/pages/usage-guide/operations/graceful-shutdown.adoc +++ b/docs/modules/spark-k8s/pages/usage-guide/operations/graceful-shutdown.adoc @@ -2,5 +2,5 @@ Normally you can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[]. -However, the spark-k8s operator does not implement any graceful shutdown mechanisms, as the driver and executor Pods are created by Spark itself. +However, the spark-k8s operator does not implement any graceful shutdown mechanism, as the driver and executor Pods are created by Spark itself. So it's Spark responsibility to handle the shutdown and recovery of Pods. From 2256e473b4afb28e151ee44a29caabf6b50f680c Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Wed, 8 Nov 2023 12:04:38 +0100 Subject: [PATCH 4/4] remove duplicated nav entry --- docs/modules/spark-k8s/partials/nav.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/modules/spark-k8s/partials/nav.adoc b/docs/modules/spark-k8s/partials/nav.adoc index 27878122..f3f55794 100644 --- a/docs/modules/spark-k8s/partials/nav.adoc +++ b/docs/modules/spark-k8s/partials/nav.adoc @@ -12,6 +12,5 @@ ** xref:spark-k8s:usage-guide/operations/index.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/pod-disruptions.adoc[] *** xref:spark-k8s:usage-guide/operations/graceful-shutdown.adoc[] * xref:spark-k8s:crd-reference.adoc[]