Skip to content

Commit

Permalink
[CELEBORN-1486][FOLLOWUP] Update document link of Get Started With Ve…
Browse files Browse the repository at this point in the history
…lox and Get Started With ClickHouse in glutensupport.md

### What changes were proposed in this pull request?

Update document link of `Get Started With Velox` and `Get Started With ClickHouse` in `glutensupport.md`. Meanwhile, replace `gluten-celeborn-package-xx-SNAPSHOT.jar` with `(The bundled Gluten Jar. Make sure -Pceleborn is specified when it is built.)`, which refers to apache/incubator-gluten#6692.

### Why are the changes needed?

The document link of `Get Started With Velox` and `Get Started With ClickHouse` could not access, which has already changed the url.

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

No.

Closes #2762 from SteNicholas/CELEBORN-1486.

Authored-by: SteNicholas <[email protected]>
Signed-off-by: mingji <[email protected]>
  • Loading branch information
SteNicholas authored and FMX committed Sep 26, 2024
1 parent 8a38235 commit 5c32ba7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/developers/glutensupport.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ license: |

[Gluten](https://github.com/apache/incubator-gluten) with velox backend supports Celeborn as remote shuffle service. Below introduction is used to enable this feature.

First refer to [Get Started With Velox](https://gluten.apache.org/docs/velox/getting-started) to build Gluten with velox backend.
First refer to [Get Started With Velox](https://gluten.apache.org/docs/getting-started/velox-backend) to build Gluten with velox backend.

When compiling the Gluten Java module, it's required to enable `celeborn` profile, as follows:

Expand All @@ -32,13 +32,13 @@ mvn clean package -Pbackends-velox -Pspark-3.3 -Pceleborn -DskipTests
Then add the Gluten and Spark Celeborn Client packages to your Spark application's classpath(usually add them into `$SPARK_HOME/jars`).

- Celeborn: `celeborn-client-spark-3-shaded_2.12-[celebornVersion].jar`
- Gluten: `gluten-velox-bundle-spark3.x_2.12-xx-xx-SNAPSHOT.jar`, `gluten-thirdparty-lib-xx.jar`
- Gluten: `gluten-velox-bundle-spark3.x_2.12-xx-xx-SNAPSHOT.jar` (The bundled Gluten Jar. Make sure -Pceleborn is specified when it is built.)

## ClickHouse Backend

[Gluten](https://github.com/apache/incubator-gluten) with clickhouse backend supports Celeborn as remote shuffle service. Below introduction is used to enable this feature.

First refer to [Get Started With ClickHouse](https://gluten.apache.org/docs/clickhouse/getting-started) to build Gluten with clickhouse backend.
First refer to [Get Started With ClickHouse](https://gluten.apache.org/docs/getting-started/clickhouse-backend) to build Gluten with clickhouse backend.

When compiling the Gluten Java module, it's required to enable `celeborn` profile, as follows:

Expand Down

0 comments on commit 5c32ba7

Please sign in to comment.