3ff4593b09
# 🔍 Description ## Issue References 🔗 As described. ## Describe Your Solution 🔧 Add docs for spark-3.4 and spark-3.5 as supported Spark profiles. ## Types of changes 🔖 - [ ] Bugfix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) ## Test Plan 🧪 #### Behavior Without This Pull Request ⚰️ No related docs. #### Behavior With This Pull Request 🎉 <img width="766" alt="image" src="https://github.com/apache/kyuubi/assets/1935105/a217b939-f97a-4176-b320-a047eb142609"> #### Related Unit Tests --- # Checklists ## 📝 Author Self Checklist - [x] My code follows the [style guidelines](https://kyuubi.readthedocs.io/en/master/contributing/code/style.html) of this project - [x] I have performed a self-review - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [x] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html) ## 📝 Committer Pre-Merge Checklist - [ ] Pull request title is okay. - [ ] No license issues. - [ ] Milestone correctly set? - [ ] Test coverage is ok - [ ] Assignees are selected. - [ ] Minimum number of approvals - [ ] No changes are requested **Be nice. Be informative.** Closes #5802 from bowenliang123/docs-scala-213. Closes #5802 d73420713 [liangbowen] add scala-2.13 profile to the docs of building from code Authored-by: liangbowen <liangbowen@gf.com.cn> Signed-off-by: wforget <643348094@qq.com>
109 lines
4.0 KiB
Markdown
109 lines
4.0 KiB
Markdown
<!--
|
|
- Licensed to the Apache Software Foundation (ASF) under one or more
|
|
- contributor license agreements. See the NOTICE file distributed with
|
|
- this work for additional information regarding copyright ownership.
|
|
- The ASF licenses this file to You under the Apache License, Version 2.0
|
|
- (the "License"); you may not use this file except in compliance with
|
|
- the License. You may obtain a copy of the License at
|
|
-
|
|
- http://www.apache.org/licenses/LICENSE-2.0
|
|
-
|
|
- Unless required by applicable law or agreed to in writing, software
|
|
- distributed under the License is distributed on an "AS IS" BASIS,
|
|
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
- See the License for the specific language governing permissions and
|
|
- limitations under the License.
|
|
-->
|
|
|
|
# Building From Source
|
|
|
|
## Building With Maven
|
|
|
|
**Kyuubi** is built based on [Apache Maven](https://maven.apache.org),
|
|
|
|
```bash
|
|
./build/mvn clean package -DskipTests
|
|
```
|
|
|
|
This results in the creation of all sub-modules of Kyuubi project without running any unit test.
|
|
|
|
If you want to test it manually, you can start Kyuubi directly from the Kyuubi project root by running
|
|
|
|
```bash
|
|
bin/kyuubi start
|
|
```
|
|
|
|
## Building A Submodule Individually
|
|
|
|
For instance, you can build the Kyuubi Common module using:
|
|
|
|
```bash
|
|
build/mvn clean package -pl kyuubi-common -DskipTests
|
|
```
|
|
|
|
## Building Submodules Individually
|
|
|
|
For instance, you can build the Kyuubi Common module using:
|
|
|
|
```bash
|
|
build/mvn clean package -pl kyuubi-common,kyuubi-ha -DskipTests
|
|
```
|
|
|
|
## Skipping Some Modules
|
|
|
|
For instance, you can build the Kyuubi modules without Kyuubi Codecov and Assembly modules using:
|
|
|
|
```bash
|
|
mvn clean install -pl '!dev/kyuubi-codecov,!kyuubi-assembly' -DskipTests
|
|
```
|
|
|
|
## Building Kyuubi Against Different Apache Spark Versions
|
|
|
|
Since v1.1.0, Kyuubi support building with different Spark profiles,
|
|
|
|
| Profile | Default | Since |
|
|
|-------------|---------|-------|
|
|
| -Pspark-3.1 | | 1.1.0 |
|
|
| -Pspark-3.2 | | 1.4.0 |
|
|
| -Pspark-3.3 | | 1.6.0 |
|
|
| -Pspark-3.4 | ✓ | 1.8.0 |
|
|
| -Pspark-3.5 | | 1.8.0 |
|
|
|
|
## Building Kyuubi Against Different Scala Versions
|
|
|
|
Since v1.8.0, Kyuubi support building with different Scala profile. Currently, Kyuubi supports building with Scala 2.12 and 2.13, while Scala 2.12 by default.
|
|
|
|
| Profile | Default | Since |
|
|
|--------------|---------|-------|
|
|
| (Scala 2.12) | ✓ | - |
|
|
| -Pscala-2.13 | | 1.8.0 |
|
|
|
|
Please activate `scala-2.13` profile when Scala 2.13 support is needed. The GA tests have covered integration test with the Kyuubi server, engines and related plugins, while the Flink engine and it's integration tests are not included for the reason that Flink does not support Scala 2.13 yet and will pull out client support for Scala.
|
|
|
|
For the Scala version for Spark engines, the server will look up the `SPARK_SCALA_VERSION` system environment variable first, and then the Scala version of the server compiled with if the former one not set. For the Scala version for other engines, the server will use the Scala version of the server compiled with.
|
|
|
|
## Building With Apache dlcdn Site
|
|
|
|
By default, we use `https://archive.apache.org/dist/` to download the built-in release packages of engines,
|
|
such as Spark or Flink.
|
|
But sometimes, you may find it hard to reach, or the download speed is too slow,
|
|
then you can define the `apache.archive.dist` by `-Pmirror-cdn` to accelerate to download speed.
|
|
For example,
|
|
|
|
```bash
|
|
build/mvn clean package -Pmirror-cdn
|
|
```
|
|
|
|
The profile migrates your download repo to the Apache officially suggested site - https://dlcdn.apache.org.
|
|
Note that, this site only holds the latest versions of Apache releases. You may fail if the specific version
|
|
defined by `spark.version` or `flink.version` is overdue.
|
|
|
|
## Building with the `fast` profile
|
|
|
|
The `fast` profile helps to significantly reduce build time, which is useful for development or compilation validation, by skipping running the tests, code style checks, building scaladoc, enforcer rules and downloading engine archives used for tests.
|
|
|
|
```bash
|
|
build/mvn clean package -Pfast
|
|
```
|
|
|