19150ca292
<!--
Thanks for sending a pull request!
Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->
### _Why are the changes needed?_
<!--
Please clarify why the changes are needed. For instance,
1. If you add a feature, you can talk about the use case of it.
2. If you fix a bug, you can clarify why it is a bug.
-->
### _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
- [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/develop_tools/testing.html#running-tests) locally before make a pull request
Closes #951 from pan3793/license.
Closes #951
4629eecd [Cheng Pan] Fix
c45a0784 [Cheng Pan] nit
b9a46b42 [Cheng Pan] pin license header at first line
80d1a71b [Cheng Pan] nit
b2a46e4c [Cheng Pan] Update
f6acaaf8 [Cheng Pan] minor
ef99183f [Cheng Pan] Add license header on all docs
Authored-by: Cheng Pan <chengpan@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
(cherry picked from commit a76c344042)
Signed-off-by: Cheng Pan <chengpan@apache.org>
58 lines
2.1 KiB
Markdown
58 lines
2.1 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.
|
|
-->
|
|
|
|
<div align=center>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
# 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 so as 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] [--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,
|
|
|
|
```bash
|
|
./build/dist --name custom-name --tgz
|
|
```
|
|
|
|
This results a Kyuubi distribution named `kyuubi-{version}-bin-custom-name.tgz` 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
|
|
|
|
```bash
|
|
./build/dist --tgz --spark-provided
|
|
```
|
|
|
|
Then you will get a Kyuubi distribution without spark binary named `kyuubi-{version}-bin.tgz`.
|