5b49061d86
### _Why are the changes needed?_ Add Docs for kyuubi tools spark-block-cleaner. * Explain the parameters * Introduction to basic startup * Give an example ### _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.readthedocs.io/en/latest/tools/testing.html#running-tests) locally before make a pull request Closes #815 from zwangsheng/doc/spark_block_cleaner. Closes #815 1ec6795f [Binjie Yang] delete todo bbf4d6e2 [Binjie Yang] make it common 9cf3e159 [Binjie Yang] format 0803995a [Binjie Yang] straighten out the article f834b382 [Binjie Yang] refactor 25be318f [Binjie Yang] fix 7304e595 [Binjie Yang] docs for spark-block-cleaner Authored-by: Binjie Yang <2213335496@qq.com> Signed-off-by: ulysses-you <ulyssesyou18@gmail.com>
1.3 KiB
1.3 KiB
Building a Runnable Distribution
To create a Kyuubi distribution like those distributed by Kyuubi Release Page,
and that is laid out so as 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 Server
Usage:
+--------------------------------------------------------------------------------------+
| ./build/dist [--name <custom_name>] [--tgz] [--spark-provided] <maven build options> |
+--------------------------------------------------------------------------------------+
name: - custom binary name, using project version if undefined
tgz: - whether to make a whole bundled package
spark-provided: - whether to make a package without Spark binary
For instance,
./build/dist --name custom-name --tgz
This results a Kyuubi distribution named kyuubi-{version}-bin-custom-name.tar.gz for you.
If you are planing to deploy Kyuubi where spark is provided, in other word, it's not required to bundle spark binary, use
./build/dist --tgz --spark-provided
Then you will get a Kyuubi distribution without spark binary named kyuubi-{version}-bin-without-spark.tar.gz.