kyuubi/docs/develop_tools/building.md
Kent Yao 644b917a30
[KYUUBI #1970] Replace mirror-cn profile with Apache officially suggested dlcdn
### _Why are the changes needed?_

Replace `mirror-cn` profile with Apache officially suggested dlcdn.

mirror-cn is only suite for CN, while dlcdn is much wiser.

### _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

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #1970 from yaooqinn/cdn.

Closes #1970

a325f828 [Kent Yao] Repalce mirror-cn profile with Apache officially suggested dlcdn
a0756b4f [Kent Yao] Repalce mirror-cn profile with Apache officially suggested dlcdn

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Kent Yao <yao@apache.org>
2022-02-24 12:07:46 +08:00

91 lines
2.7 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>
![](../imgs/kyuubi_logo.png)
</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
## 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 offically 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.