Go to file
liangbowen ab1c46d431 [KYUUBI #5154] [Doc] Move configuration docs to the top level
### _Why are the changes needed?_

- Move the configuration docs to the top level of docs, which is most commonly used and referenced
- update relevant doc links

![image](https://github.com/apache/kyuubi/assets/1935105/a1dd35cc-d37f-4294-9fed-b275956c2cc5)

### _How was this patch tested?_
- [x] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

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

Closes #5154 from bowenliang123/config-doc-first.

Closes #5154

b49ed3f8b [liangbowen] nit
db7f0d14d [liangbowen] update doc links
f8fd697a2 [liangbowen] move config docs to the top level
7448e4487 [liangbowen] change title of settings doc
40214ddd8 [liangbowen] move config doc in the front of deployment

Authored-by: liangbowen <liangbowen@gf.com.cn>
Signed-off-by: liangbowen <liangbowen@gf.com.cn>
2023-08-11 18:23:08 +08:00
.github [KYUUBI #5113] Remove dummy Spark Kudu connector module 2023-08-01 17:05:42 +08:00
.idea [KYUUBI #870] [MISC] Migrate from NetEase to Apache 2021-07-28 21:31:46 +08:00
bin [KYUUBI #4849] Open modules to enable JDK 17 support 2023-05-22 09:53:49 +08:00
build [KYUUBI #4187][FOLLOWUP] Windows build-info script supports revision time 2023-07-10 12:27:22 +08:00
charts/kyuubi [KYUUBI #5154] [Doc] Move configuration docs to the top level 2023-08-11 18:23:08 +08:00
conf [KYUUBI #5154] [Doc] Move configuration docs to the top level 2023-08-11 18:23:08 +08:00
dev [KYUUBI #5116] Bump Hadoop 3.3.6 2023-08-01 17:07:43 +08:00
docker [KYUUBI #5154] [Doc] Move configuration docs to the top level 2023-08-11 18:23:08 +08:00
docs [KYUUBI #5154] [Doc] Move configuration docs to the top level 2023-08-11 18:23:08 +08:00
extensions [KYUUBI #4925] Add default catalog using spark_catalog with the lineage result 2023-08-09 18:28:32 +08:00
externals [KYUUBI #5148] Improve spark.driver.host assignment in Spark on K8s client mode 2023-08-10 00:49:53 +08:00
integration-tests [KYUUBI #4940] Implement Kyuubi UDF in Hive engine 2023-08-01 17:07:07 +08:00
kyuubi-assembly [KYUUBI #4852] Switch to Kyuubi Shaded Zookeeper 2023-05-21 20:49:00 +08:00
kyuubi-common [KYUUBI #5120] [JDBC] Allow using session's user and password for connecting database in JDBC engine 2023-08-07 13:33:50 +08:00
kyuubi-ctl [KYUUBI #5063] Support to filter batch with batch name 2023-07-19 15:44:57 +08:00
kyuubi-events [KYUUBI #4959] [MINOR] Code improvements for Scala 2023-06-16 21:20:17 +08:00
kyuubi-ha [KYUUBI #5130] Allow setting Zookeeper SPN using Kyuubi configuration 2023-08-03 19:29:02 +08:00
kyuubi-hive-beeline [KYUUBI #5129] KyuubiBeeline should redirect JDK logging 2023-08-03 19:27:31 +08:00
kyuubi-hive-jdbc [KYUUBI #5117] [Minor] Code improvements for Java and Scala code 2023-08-01 11:36:18 +08:00
kyuubi-hive-jdbc-shaded [KYUUBI #4852] Switch to Kyuubi Shaded Zookeeper 2023-05-21 20:49:00 +08:00
kyuubi-metrics [KYUUBI #4812] [MINOR] Generalize case transformation method for string type config entry 2023-05-25 10:58:31 +08:00
kyuubi-rest-client [KYUUBI #5117] [Minor] Code improvements for Java and Scala code 2023-08-01 11:36:18 +08:00
kyuubi-server [KYUUBI #5154] [Doc] Move configuration docs to the top level 2023-08-11 18:23:08 +08:00
kyuubi-util [KYUUBI #4870] Add kyuubi-util and kyuubi-util-scala modules 2023-05-22 22:13:56 +08:00
kyuubi-util-scala [KYUUBI #5149] [Improvement] Correct error message of ReflectUtils's invokeAs when method not found 2023-08-10 11:40:14 +08:00
kyuubi-zookeeper [KYUUBI #4852] Switch to Kyuubi Shaded Zookeeper 2023-05-21 20:49:00 +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 [KYUUBI #4879] Refactor and promote relection utils and cleanup similar reflection methods 2023-06-06 18:59:18 +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 #4950] Migrate Kyuubi embedded database from Derby to SQLite 2023-06-12 21:01:51 +08:00
.rat-excludes [KYUUBI #5135] [Minor] Exclude web-ui coverage reports in rat plugins 2023-08-07 18:14:01 +08:00
.readthedocs.yaml [KYUUBI #4800] Update readthedocs.yaml 2023-05-08 13:35:55 +08:00
.scalafmt.conf [KYUUBI #5007] Bump Scalafmt from 3.7.4 to 3.7.5 2023-06-30 11:34:36 +08:00
codecov.yml [KYUUBI #951] [LICENSE] Add license header on all docs 2021-08-19 09:53:52 +08:00
CONTRIBUTING.md [KYUUBI #5146] [DOC] Fix link of IntelliJ IDEA Setup Guide 2023-08-09 16:39:44 +08:00
LICENSE [KYUUBI #2115] Update license and enhance collect_licenses script 2022-03-14 19:45:40 +08:00
LICENSE-binary [KYUUBI #4950] Migrate Kyuubi embedded database from Derby to SQLite 2023-06-12 21:01:51 +08:00
NOTICE [KYUUBI #4020] remove incubating from kyuubi source code 2023-01-04 09:43:20 +08:00
NOTICE-binary [KYUUBI #4852] Switch to Kyuubi Shaded Zookeeper 2023-05-21 20:49:00 +08:00
pom.xml [KYUUBI #5116] Bump Hadoop 3.3.6 2023-08-01 17:07:43 +08:00
README.md [KYUUBI #4737] Restore Project & Community Status in README.md 2023-04-20 17:44:15 +08:00
scalastyle-config.xml [KYUUBI #4852] Switch to Kyuubi Shaded Zookeeper 2023-05-21 20:49:00 +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.

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 Documentation Status

Quick Start

Ready? Getting Started with Kyuubi.

Contributing

Project & Community Status

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.