[KYUUBI #3241 ][DOCS] Update Develop Tools / Building a Runnable Distribution

### _Why are the changes needed?_

To close #3241
* correct Kyuubi Release Page to https://kyuubi.apache.org/releases.html
* correct binary package name to apache-kyuubi-XXXX.tgz
* correct `buid/dist --help`

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [x] Add screenshots for manual tests if appropriate

- [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request
![kyuubi-distribution](https://user-images.githubusercontent.com/52876270/185336760-cfecbe9f-4a27-47ce-b803-d3d93fa92a92.jpg)

Closes #3265 from zwangsheng/doc/make-distribution.

Closes #3241

8600186c [zwangsheng] modify distribution

Authored-by: zwangsheng <2213335496@qq.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
(cherry picked from commit 05e4e8f8c1)
Signed-off-by: Cheng Pan <chengpan@apache.org>

2022-08-18 15:38:22 +08:00

2.5 KiB

Raw Permalink Blame History

Building a Runnable Distribution

To create a Kyuubi distribution like those distributed by Kyuubi Release Page, and that is laid out to be runnable, use ./build/dist in the project root directory.

For more information on usage, run ./build/dist --help

./build/dist - Tool for making binary distributions of Kyuubi

Usage:
+------------------------------------------------------------------------------------------------------+
| ./build/dist [--name <custom_name>] [--tgz] [--flink-provided] [--spark-provided] [--hive-provided]  |
|              [--mvn <maven_executable>] <maven build options>                                        |
+------------------------------------------------------------------------------------------------------+
name:           -  custom binary name, using project version if undefined
tgz:            -  whether to make a whole bundled package
flink-provided: -  whether to make a package without Flink binary
spark-provided: -  whether to make a package without Spark binary
hive-provided:  -  whether to make a package without Hive binary
mvn:            -  external maven executable location

For instance,

./build/dist --name custom-name --tgz

This results in a Kyuubi distribution named apache-kyuubi-{version}-bin-custom-name.tgz for you.

If you are planing to deploy Kyuubi where spark/flink/hive is provided, in other word, it's not required to bundle spark/flink/hive binary, use

./build/dist --tgz --spark-provided --flink-provided --hive-provided

Then you will get a Kyuubi distribution without spark/flink/hive binary named apache-kyuubi-{version}-bin.tgz.

2.5 KiB Raw Permalink Blame History

Building a Runnable Distribution

2.5 KiB

Raw Permalink Blame History