f7e5e6a81b
<!-- Thanks for sending a pull request! Here are some tips for you: 1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html 2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'. 3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'. --> ### _Why are the changes needed?_ <!-- Please clarify why the changes are needed. For instance, 1. If you add a feature, you can talk about the use case of it. 2. If you fix a bug, you can clarify why it is a bug. --> Details see issue #1426 ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [ ] Add screenshots for manual tests if appropriate - [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/develop_tools/testing.html#running-tests) locally before make a pull request Closes #1427 from zhenjiaguo/building_doc_fix. Closes #1426 2c858fbb [zhenjiaguo] fix maven -pl option usage Authored-by: zhenjiaguo <zhenjia_guo@163.com> Signed-off-by: ulysses-you <ulyssesyou@apache.org>
95 lines
2.9 KiB
Markdown
95 lines
2.9 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.
|
|
-->
|
|
|
|
<div align=center>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
# Building Kyuubi
|
|
|
|
## Building Kyuubi with Apache Maven
|
|
|
|
**Kyuubi** is built based on [Apache Maven](http://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.0 | Yes | 1.0.0
|
|
-Pspark-3.1 | No | 1.1.0
|
|
|
|
|
|
## Defining the Apache Mirror for Spark or Flink
|
|
|
|
By default, we use `https://archive.apache.org/dist/spark/` to download the built-in Spark or
|
|
use `https://archive.apache.org/dist/flink/` to download the built-in Flink release package,
|
|
but if you find it hard to reach, or the downloading speed is too slow, you can define the `spark.archive.mirror`
|
|
or `flink.archive.mirror` property to a suitable Apache mirror site. For instance,
|
|
|
|
```bash
|
|
build/mvn clean package -Dspark.archive.mirror=https://mirrors.bfsu.edu.cn/apache/spark/spark-3.0.1
|
|
```
|
|
|
|
Visit [Apache Mirrors](http://www.apache.org/mirrors/) and choose a mirror based on your region.
|
|
|
|
Specifically for developers in China mainland, you can use the pre-defined profile named `mirror-cn`
|
|
which use `mirrors.bfsu.edu.cn` to speed up Spark Binary downloading. For instance,
|
|
|
|
```bash
|
|
build/mvn clean package -Pmirror-cn
|
|
```
|