5032901dfc
### _Why are the changes needed?_ Guidelines for Document and Code Contributions. - code style - documentation style - quick starts - sphinx-copybutton for copy button in code blocks - add kind:minor,help wanted,good first issue to doc issue template ### _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 <img width="1325" alt="image" src="https://user-images.githubusercontent.com/8326978/234193368-473e2a1d-2deb-4d91-901a-19cea58a489b.png"> - [x] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request Closes #4768 from yaooqinn/guide. Closes #4768 3a0bd395b [Kent Yao] Update docs/contributing/doc/build.rst 8fe4f6d14 [Kent Yao] Update docs/contributing/doc/build.rst a753bdde5 [Kent Yao] Guidelines for Document and Code contributions f8393fe8d [Kent Yao] Guidelines for Document and Code contributions 8f2d3ce82 [Kent Yao] Guidelines for Document and Code contributions 4f3a2128b [Kent Yao] Guidelines for Document and Code contributions Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Cheng Pan <chengpan@apache.org>
57 lines
2.4 KiB
Markdown
57 lines
2.4 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://kyuubi.apache.org/releases.html),
|
|
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
|
|
|
|
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,
|
|
|
|
```bash
|
|
./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
|
|
|
|
```bash
|
|
./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`.
|