This is an automated email from the ASF dual-hosted git repository.
chengpan pushed a commit to branch branch-1.8
in repository https://gitbox.apache.org/repos/asf/kyuubi.git
The following commit(s) were added to refs/heads/branch-1.8 by this push:
new 53d0b0873 [KYUUBI #5227] [DOCS] Added deploy mode info
53d0b0873 is described below
commit 53d0b087365c185366f0fafb4555d6c2794bfd6e
Author: Hanna Liashchuk <[email protected]>
AuthorDate: Mon Sep 11 11:46:18 2023 +0000
[KYUUBI #5227] [DOCS] Added deploy mode info
### _Why are the changes needed?_
<img width="1080" alt="image"
src="https://github.com/apache/kyuubi/assets/3898450/cc118574-c752-449a-9b20-04d2cc59b118";>
### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including
negative and positive cases if possible
- [x] Add screenshots for manual tests if appropriate
- [ ] [Run
test](https://kyuubi.readthedocs.io/en/master/contributing/code/testing.html#running-tests)
locally before make a pull request
### _Was this patch authored or co-authored using generative AI tooling?_
No
Closes #5227 from hanna-liashchuk/patch-2.
Closes #5227
baf391ba9 [Hanna Liashchuk] fix DOC style
e46dfddc3 [Cheng Pan] Update docs/deployment/engine_on_kubernetes.md
0746a350a [hanna-liashchuk] upd
233bba00b [hanna-liashchuk] Added deploy mode info
Lead-authored-by: Hanna Liashchuk <[email protected]>
Co-authored-by: hanna-liashchuk
<[email protected]>
Co-authored-by: Cheng Pan <[email protected]>
Signed-off-by: Cheng Pan <[email protected]>
(cherry picked from commit 55feb2b58c05912cc5158c8677ed48b2a0f7bf68)
Signed-off-by: Cheng Pan <[email protected]>
---
docs/deployment/engine_on_kubernetes.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/docs/deployment/engine_on_kubernetes.md
b/docs/deployment/engine_on_kubernetes.md
index 44fca1602..a8f7c6ca0 100644
--- a/docs/deployment/engine_on_kubernetes.md
+++ b/docs/deployment/engine_on_kubernetes.md
@@ -36,6 +36,17 @@ Spark on Kubernetes config master by using a special format.
You can use cmd `kubectl cluster-info` to get api-server host and port.
+### Deploy Mode
+
+One of the main advantages of the Kyuubi server compared to other interactive
Spark clients is that it supports cluster deploy mode.
+It is highly recommended to run Spark in k8s in cluster mode.
+
+The minimum required configurations are:
+
+* spark.submit.deployMode (cluster)
+* spark.kubernetes.file.upload.path (path on s3 or hdfs)
+* spark.kubernetes.authenticate.driver.serviceAccountName ([viz
ServiceAccount](#serviceaccount))
+
### Docker Image
Spark ships a `./bin/docker-image-tool.sh` script to build and publish the
Docker images for running Spark applications on Kubernetes.
