fafd017df5
### _Why are the changes needed?_ ``` Usage: +----------------------------------------------------------------------------------------------+ | ./build/dist [--name <custom_name>] [--tgz] [--web-ui] [--flink-provided] [--hive-provided] | | [--spark-provided] [--mvn <maven_executable>] <maven build options> | +----------------------------------------------------------------------------------------------+ name: - custom binary name, using project version if undefined tgz: - whether to make a whole bundled package web-ui: - whether to include web ui flink-provided: - whether to make a package without Flink binary hive-provided: - whether to make a package without Hive binary spark-provided: - whether to make a package without Spark binary mvn: - external maven executable location ``` ### _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 Create binary artifacts using `build/dist --tgz --web-ui` and run, then open `http://0.0.0.0:10099/ui` <img width="1401" alt="image" src="https://user-images.githubusercontent.com/26535726/220753103-ce801f12-f394-4ece-92a4-1902e93c62c7.png"> - [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request Closes #4397 from pan3793/webui-build. Closes #4397 97901d63e [Cheng Pan] doc 37d5e2ad3 [Cheng Pan] mirror-cdn c5751dd5b [Cheng Pan] remove unused dep d308defb7 [Cheng Pan] nit 9abca4705 [Cheng Pan] nit c1d184afd [Cheng Pan] nit 7091d5bf5 [Cheng Pan] regex f0ac16b3c [Cheng Pan] [BUILD] `build/dist` support --web-ui Authored-by: Cheng Pan <chengpan@apache.org> Signed-off-by: Cheng Pan <chengpan@apache.org>
2.4 KiB
2.4 KiB
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] [--web-ui] [--flink-provided] [--hive-provided] |
| [--spark-provided] [--mvn <maven_executable>] <maven build options> |
+----------------------------------------------------------------------------------------------+
name: - custom binary name, using project version if undefined
tgz: - whether to make a whole bundled package
web-ui: - whether to include web ui
flink-provided: - whether to make a package without Flink binary
hive-provided: - whether to make a package without Hive binary
spark-provided: - whether to make a package without Spark 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.