Go to file
Cheng Pan fafd017df5
[KYUUBI #4397] [BUILD] build/dist supports --web-ui
### _Why are the changes needed?_

```
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

```

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

Create binary artifacts using `build/dist --tgz --web-ui` and run, then open `http://0.0.0.0:10099/ui`

<img width="1401" alt="image" src="https://user-images.githubusercontent.com/26535726/220753103-ce801f12-f394-4ece-92a4-1902e93c62c7.png">

- [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4397 from pan3793/webui-build.

Closes #4397

97901d63e [Cheng Pan] doc
37d5e2ad3 [Cheng Pan] mirror-cdn
c5751dd5b [Cheng Pan] remove unused dep
d308defb7 [Cheng Pan] nit
9abca4705 [Cheng Pan] nit
c1d184afd [Cheng Pan] nit
7091d5bf5 [Cheng Pan] regex
f0ac16b3c [Cheng Pan] [BUILD] `build/dist` support --web-ui

Authored-by: Cheng Pan <chengpan@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2023-02-23 11:45:58 +08:00
.github [KYUUBI #4338][FOLLOWUP] Fix K8s integration tests 2023-02-19 16:31:26 +08:00
.idea [KYUUBI #870] [MISC] Migrate from NetEase to Apache 2021-07-28 21:31:46 +08:00
bin [KYUUBI #4397] [BUILD] build/dist supports --web-ui 2023-02-23 11:45:58 +08:00
build [KYUUBI #4397] [BUILD] build/dist supports --web-ui 2023-02-23 11:45:58 +08:00
charts/kyuubi [KYUUBI #4313] [K8S][HELM] Comment license in helm chart NOTES 2023-02-12 18:42:36 +08:00
conf [KYUUBI #4165] [DOCS] Update the docs link 2023-01-16 10:52:01 +08:00
dev [KYUUBI #4357] Bump Jersey from 2.38 to 2.39 2023-02-19 16:33:26 +08:00
docker [KYUUBI #4338] Bump Spark from 3.3.1 to 3.3.2 2023-02-19 00:06:57 +08:00
docs [KYUUBI #4397] [BUILD] build/dist supports --web-ui 2023-02-23 11:45:58 +08:00
extensions [KYUUBI #4391] Improve code for hive-connector FileWriterFactory 2023-02-21 17:24:53 +08:00
externals [KYUUBI #4392] [ARROW] Assign a new execution id for arrow-based result 2023-02-22 23:00:30 +08:00
integration-tests [KYUUBI #4338][FOLLOWUP] Fix K8s integration tests 2023-02-19 16:31:26 +08:00
kyuubi-assembly Bump 1.8.0-SNAPSHOT 2023-02-10 15:25:49 +08:00
kyuubi-common [KYUUBI #3957][FOLLOWUP] Rename the config prefix from kyuubi.server.batch.limit to kyuubi.server.limit.batch 2023-02-23 09:21:34 +08:00
kyuubi-ctl [KYUUBI #4360] Support to refresh the unlimited users for session limiter 2023-02-18 00:54:11 +08:00
kyuubi-events Bump 1.8.0-SNAPSHOT 2023-02-10 15:25:49 +08:00
kyuubi-ha Bump 1.8.0-SNAPSHOT 2023-02-10 15:25:49 +08:00
kyuubi-hive-beeline [KYUUBI #4305][Bug] Backport HIVE-15820: comment at the head of beeline -e 2023-02-16 17:05:18 +08:00
kyuubi-hive-jdbc [KYUUBI #4216] Support to transfer client version for kyuubi hive jdbc and rest client sdk 2023-02-20 11:18:21 +08:00
kyuubi-hive-jdbc-shaded Bump 1.8.0-SNAPSHOT 2023-02-10 15:25:49 +08:00
kyuubi-metrics [KYUUBI #4344] Expose exec pool work queue size metrics 2023-02-17 10:12:09 +08:00
kyuubi-rest-client [KYUUBI #4216] Support to transfer client version for kyuubi hive jdbc and rest client sdk 2023-02-20 11:18:21 +08:00
kyuubi-server [KYUUBI #4397] [BUILD] build/dist supports --web-ui 2023-02-23 11:45:58 +08:00
kyuubi-zookeeper Bump 1.8.0-SNAPSHOT 2023-02-10 15:25:49 +08:00
licenses [KYUUBI #2115] Update license and enhance collect_licenses script 2022-03-14 19:45:40 +08:00
licenses-binary [KYUUBI #4152] Enhance LDAP authentication 2023-02-03 05:48:02 +00:00
tools/spark-block-cleaner Bump 1.8.0-SNAPSHOT 2023-02-10 15:25:49 +08:00
.asf.yaml [KYUUBI #3631] Update project description 2022-10-14 21:36:54 +08:00
.dockerignore [KYUUBI #972] [LICENSE] Exclude binary/doc files from source release 2021-08-22 16:31:36 +08:00
.gitattributes [KYUUBI #4287] [INFRA] Remove Travis 2023-02-09 19:50:07 +08:00
.gitignore [KYUUBI #4397] [BUILD] build/dist supports --web-ui 2023-02-23 11:45:58 +08:00
.rat-excludes [KYUUBI #4397] [BUILD] build/dist supports --web-ui 2023-02-23 11:45:58 +08:00
.readthedocs.yml [KYUUBI #951] [LICENSE] Add license header on all docs 2021-08-19 09:53:52 +08:00
.scalafmt.conf [KYUUBI #4206] Bump scalafmt from 3.6.1 to 3.7.1 2023-01-29 14:57:29 +08:00
codecov.yml [KYUUBI #951] [LICENSE] Add license header on all docs 2021-08-19 09:53:52 +08:00
CONTRIBUTING.md [KYUUBI #4226] Fix word spelling typos in docs 2023-02-02 11:43:03 +08:00
LICENSE [KYUUBI #2115] Update license and enhance collect_licenses script 2022-03-14 19:45:40 +08:00
LICENSE-binary [KYUUBI #4152] Enhance LDAP authentication 2023-02-03 05:48:02 +00:00
NOTICE [KYUUBI #4020] remove incubating from kyuubi source code 2023-01-04 09:43:20 +08:00
NOTICE-binary [KYUUBI #4020] remove incubating from kyuubi source code 2023-01-04 09:43:20 +08:00
pom.xml [KYUUBI #4397] [BUILD] build/dist supports --web-ui 2023-02-23 11:45:58 +08:00
README.md [KYUUBI #4312] [DOCS] Include **/README.md in markdown style check 2023-02-14 02:23:32 +08:00
scalastyle-config.xml [KYUUBI #563] [TEST] Bump scalatest 3.2.8 2021-04-22 20:45:43 +08:00

Kyuubi logo

Project - Documentation - Who's using

Apache Kyuubi

Apache Kyuubi™ is a distributed and multi-tenant gateway to provide serverless SQL on data warehouses and lakehouses.

https://kyuubi.apache.org/

What is Kyuubi?

Kyuubi provides a pure SQL gateway through Thrift JDBC/ODBC interface for end-users to manipulate large-scale data with pre-programmed and extensible Spark SQL engines. This "out-of-the-box" model minimizes the barriers and costs for end-users to use Spark at the client side. At the server-side, Kyuubi server and engines' multi-tenant architecture provides the administrators a way to achieve computing resource isolation, data security, high availability, high client concurrency, etc.

  • A HiveServer2-like API
  • Multi-tenant Spark Support
  • Running Spark in a serverless way

Target Users

Kyuubi's goal is to make it easy and efficient for anyone to use Spark(maybe other engines soon) and facilitate users to handle big data like ordinary data. Here, anyone means that users do not need to have a Spark technical background but a human language, SQL only. Sometimes, SQL skills are unnecessary when integrating Kyuubi with Apache Superset, which supports rich visualizations and dashboards.

In typical big data production environments with Kyuubi, there should be system administrators and end-users.

  • System administrators: A small group consists of Spark experts responsible for Kyuubi deployment, configuration, and tuning.
  • End-users: Focus on business data of their own, not where it stores, how it computes.

Additionally, the Kyuubi community will continuously optimize the whole system with various features, such as History-Based Optimizer, Auto-tuning, Materialized View, SQL Dialects, Functions, e.t.c.

Usage scenarios

Port workloads from HiveServer2 to Spark SQL

In typical big data production environments, especially secured ones, all bundled services manage access control lists to restricting access to authorized users. For example, Hadoop YARN divides compute resources into queues. With Queue ACLs, it can identify and control which users/groups can take actions on particular queues. Similarly, HDFS ACLs control access of HDFS files by providing a way to set different permissions for specific users/groups.

Apache Spark is a unified analytics engine for large-scale data processing. It provides a Distributed SQL Engine, a.k.a, the Spark Thrift Server(STS), designed to be seamlessly compatible with HiveServer2 and get even better performance.

HiveServer2 can identify and authenticate a caller, and then if the caller also has permissions for the YARN queue and HDFS files, it succeeds. Otherwise, it fails. However, on the one hand, STS is a single Spark application. The user and queue to which STS belongs are uniquely determined at startup. Consequently, STS cannot leverage cluster managers such as YARN and Kubernetes for resource isolation and sharing or control the access for callers by the single user inside the whole system. On the other hand, the Thrift Server is coupled in the Spark driver's JVM process. This coupled architecture puts a high risk on server stability and makes it unable to handle high client concurrency or apply high availability such as load balancing as it is stateful.

Kyuubi extends the use of STS in a multi-tenant model based on a unified interface and relies on the concept of multi-tenancy to interact with cluster managers to finally gain the ability of resources sharing/isolation and data security. The loosely coupled architecture of the Kyuubi server and engine dramatically improves the client concurrency and service stability of the service itself.

DataLake/LakeHouse Support

The vision of Kyuubi is to unify the portal and become an easy-to-use data lake management platform. Different kinds of workloads, such as ETL processing and BI analytics, can be supported by one platform, using one copy of data, with one SQL interface.

  • Logical View support via Kyuubi DataLake Metadata APIs
  • Multiple Catalogs support
  • SQL Standard Authorization support for DataLake(coming)

Cloud Native Support

Kyuubi can deploy its engines on different kinds of Cluster Managers, such as, Hadoop YARN, Kubernetes, etc.

The Kyuubi Ecosystem(present and future)

The figure below shows our vision for the Kyuubi Ecosystem. Some of them have been realized, some in development, and others would not be possible without your help.

Online Documentation

Since Kyuubi 1.3.0-incubating, the Kyuubi online documentation is hosted by https://kyuubi.apache.org/. You can find the latest Kyuubi documentation on this web page. For 1.2 and earlier versions, please check the Readthedocs directly.

Quick Start

Ready? Getting Started with Kyuubi.

Contributing

Contributor over time

Contributor over time

Aside

The project took its name from a character of a popular Japanese manga - Naruto. The character is named Kyuubi Kitsune/Kurama, which is a nine-tailed fox in mythology. Kyuubi spread the power and spirit of fire, which is used here to represent the powerful Apache Spark. Its nine tails stand for end-to-end multi-tenancy support of this project.

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.