Skip to content

Commit

Permalink
doc: Document CometPlugin to start Comet in cluster mode (#836)
Browse files Browse the repository at this point in the history
* Documenting CometPlugin

Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com>
  • Loading branch information
comphead and viirya authored Aug 19, 2024
1 parent 3cff826 commit 27ab86b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/source/user-guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,3 +152,6 @@ To enable columnar shuffle which supports all partitioning and basic complex typ
```
--conf spark.comet.exec.shuffle.mode=jvm
```

### Memory tuning
In addition to Apache Spark memory configuration parameters the Comet introduces own parameters to configure memory allocation for native execution. More [Comet Memory Tuning](./tuning.md)
11 changes: 11 additions & 0 deletions docs/source/user-guide/tuning.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,17 @@ Comet will allocate at least `spark.comet.memory.overhead.min` memory.

If both `spark.comet.memoryOverhead` and `spark.comet.memory.overhead.factor` are set, the former will be used.

## Memory Tuning using CometPlugin
Configuring memory for Spark and Comet might be a tedious task as it requires to tune Spark executor overhead memory and Comet memory overhead configs. Comet provides a Spark plugin `CometPlugin` which can be set up to your Spark application to help memory settings.

For users running the Comet in clusters like Kubernetes or YARN, `CometPlugin` can also make the resource manager respect correctly Comet memory parameters `spark.comet.memory*`.
it is needed to pass to the starting command line additional Spark configuration parameter `--conf spark.plugins=org.apache.spark.CometPlugin`

The resource managers respects Apache Spark memory configuration before starting the containers.

The `CometPlugin` plugin overrides `spark.executor.memoryOverhead` adding up the Comet memory configuration.


## Shuffle

Comet provides Comet shuffle features that can be used to improve the performance of your queries.
Expand Down

0 comments on commit 27ab86b

Please sign in to comment.