Skip to content

Commit

Permalink
[KYUUBI #5227] [DOCS] Added deploy mode info
Browse files Browse the repository at this point in the history
### _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

baf391b [Hanna Liashchuk]  fix DOC style
e46dfdd [Cheng Pan] Update docs/deployment/engine_on_kubernetes.md
0746a35 [hanna-liashchuk] upd
233bba0 [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]>
  • Loading branch information
3 people committed Sep 11, 2023
1 parent 60b7e8f commit 55feb2b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/deployment/engine_on_kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 55feb2b

Please sign in to comment.