e1921fc8c0
### _Why are the changes needed?_ make documentation style to fit official web site ### _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  - [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request Closes #2751 from yaooqinn/doc2. Closes #2751 b8123525 [Kent Yao] Switch Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Cheng Pan <chengpan@apache.org>
54 lines
2.2 KiB
Markdown
54 lines
2.2 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.
|
|
-->
|
|
|
|
|
|
# Building a Runnable Distribution
|
|
|
|
To create a Kyuubi distribution like those distributed by [Kyuubi Release Page](https://github.com/apache/incubator-kyuubi/releases),
|
|
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`
|
|
|
|
```logtalk
|
|
./build/dist - Tool for making binary distributions of Kyuubi Server
|
|
|
|
Usage:
|
|
+--------------------------------------------------------------------------------------+
|
|
| ./build/dist [--name <custom_name>] [--tgz] [--flink-provided] [--spark-provided] <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
|
|
```
|
|
|
|
For instance,
|
|
|
|
```bash
|
|
./build/dist --name custom-name --tgz
|
|
```
|
|
|
|
This results in a Kyuubi distribution named `kyuubi-{version}-bin-custom-name.tgz` for you.
|
|
|
|
If you are planing to deploy Kyuubi where `spark`/`flink` is provided, in other word, it's not required to bundle spark/flink binary, use
|
|
|
|
```bash
|
|
./build/dist --tgz --spark-provided --flink-provided
|
|
```
|
|
|
|
Then you will get a Kyuubi distribution without spark binary named `kyuubi-{version}-bin.tgz`.
|