Skip to content

Commit

Permalink
[KYUUBI #3241][DOCS] Update `Develop Tools / Building a Runnable Dist…
Browse files Browse the repository at this point in the history
…ribution`

### _Why are the changes needed?_

To close #3241
* correct Kyuubi Release Page to https://kyuubi.apache.org/releases.html
* correct binary package name to apache-kyuubi-XXXX.tgz
* correct `buid/dist --help`

### _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

- [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request
![kyuubi-distribution](https://user-images.githubusercontent.com/52876270/185336760-cfecbe9f-4a27-47ce-b803-d3d93fa92a92.jpg)

Closes #3265 from zwangsheng/doc/make-distribution.

Closes #3241

8600186 [zwangsheng] modify distribution

Authored-by: zwangsheng <2213335496@qq.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
  • Loading branch information
zwangsheng authored and pan3793 committed Aug 18, 2022
1 parent 77b036f commit 05e4e8f
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions docs/develop_tools/distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,25 @@

# Building a Runnable Distribution

To create a Kyuubi distribution like those distributed by [Kyuubi Release Page](https://github.com/apache/incubator-kyuubi/releases),
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 Server
./build/dist - Tool for making binary distributions of Kyuubi
Usage:
+--------------------------------------------------------------------------------------+
| ./build/dist [--name <custom_name>] [--tgz] [--flink-provided] [--spark-provided] <maven build options> |
+--------------------------------------------------------------------------------------+
+------------------------------------------------------------------------------------------------------+
| ./build/dist [--name <custom_name>] [--tgz] [--flink-provided] [--spark-provided] [--hive-provided] |
| [--mvn <maven_executable>] <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
hive-provided: - whether to make a package without Hive binary
mvn: - external maven executable location
```

For instance,
Expand All @@ -42,12 +45,12 @@ For instance,
./build/dist --name custom-name --tgz
```

This results in a Kyuubi distribution named `kyuubi-{version}-bin-custom-name.tgz` for you.
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` is provided, in other word, it's not required to bundle spark/flink binary, use
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
./build/dist --tgz --spark-provided --flink-provided --hive-provided
```

Then you will get a Kyuubi distribution without spark binary named `kyuubi-{version}-bin.tgz`.
Then you will get a Kyuubi distribution without spark/flink/hive binary named `apache-kyuubi-{version}-bin.tgz`.

0 comments on commit 05e4e8f

Please sign in to comment.