Go to file
Cheng Pan 547e5ca617
[KYUUBI #4145] Change lock and polling seq_num path on service discovery
### _Why are the changes needed?_

This PR proposes to change the paths of distributed lock and seq_num(used for POLLING engine pool select policy) on the Service Discovery component. The reason is that namespace `${serverSpace}_${KYUUBI_VERSION}_${shareLevel}_${engineType}/` should be dedicated to engine registration, we'd better use the separated namespace for other functionalities.

- lock path
```
# before
${serverSpace}_${shareLevel}_${engineType}/lock/${user}/${subdomain}

# after
${serverSpace}_${KYUUBI_VERSION}_${shareLevel}_${engineType}_lock/${user}/${subdomain}
```

- seq_num
```
# before
${serverSpace}_${KYUUBI_VERSION}_${shareLevel}_${engineType}/seq_num/${user}/${poolName}

# after
${serverSpace}_${KYUUBI_VERSION}_${shareLevel}_${engineType}_seqNum/${user}/${poolName}
```

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

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4145 from pan3793/namespace.

Closes #4145

c912b3f66 [Cheng Pan] name
3326b9b95 [Cheng Pan] name
10083db0b [Cheng Pan] Change lock and polloing seq_num path on service discovery

Authored-by: Cheng Pan <chengpan@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2023-02-10 13:04:24 +08:00
.github [KYUUBI #4297] Daily publish master snapshot docker image 2023-02-10 12:23:48 +08:00
.idea
bin [KYUUBI #4078] [INFRA] Enable shellcheck on CI 2023-01-05 15:13:43 +08:00
build [KYUUBI #4288] Use eclipse-temurin:8-jdk-focal as default base image 2023-02-10 12:25:57 +08:00
charts/kyuubi [KYUUBI #4147] [K8S][HELM] Add configuration support for multiple frontends to helm chart 2023-02-06 10:11:00 +08:00
conf [KYUUBI #4165] [DOCS] Update the docs link 2023-01-16 10:52:01 +08:00
dev [KYUUBI #4286] Bump Jackson from 2.14.1 to 2.14.2 2023-02-10 07:39:22 +08:00
docker [KYUUBI #4288] Use eclipse-temurin:8-jdk-focal as default base image 2023-02-10 12:25:57 +08:00
docs [KYUUBI #4269] Add a GA Job For Documentation Verification 2023-02-09 12:53:47 +00:00
extensions [KYUUBI #4262] [AUTHZ] Change from DROP to ALTER as required privilege of the source table in AlterTableRenameCommand 2023-02-09 20:12:52 +08:00
externals [KYUUBI #4250] Bump Flink to 1.16.1 2023-02-09 20:10:13 +08:00
integration-tests [KYUUBI #4155] Reduce the application info call for batch 2023-01-16 07:44:15 +08:00
kyuubi-assembly [KYUUBI #3842] [Improvement] Support maven pom.xml code style check with spotless plugin 2022-11-23 22:08:00 +08:00
kyuubi-common [KYUUBI #4145] Change lock and polling seq_num path on service discovery 2023-02-10 13:04:24 +08:00
kyuubi-ctl [KYUUBI #4239] Remove duplicate buildConf methods and use KyuubiConf.buildConf directly 2023-02-03 16:57:12 +08:00
kyuubi-events [KYUUBI #3842] [Improvement] Support maven pom.xml code style check with spotless plugin 2022-11-23 22:08:00 +08:00
kyuubi-ha [KYUUBI #4145] Change lock and polling seq_num path on service discovery 2023-02-10 13:04:24 +08:00
kyuubi-hive-beeline [KYUUBI #4176] Eliminate unhelpful warning messages in Javac output of Java 11 2023-01-17 14:46:59 +08:00
kyuubi-hive-jdbc [KYUUBI #4176] Eliminate unhelpful warning messages in Javac output of Java 11 2023-01-17 14:46:59 +08:00
kyuubi-hive-jdbc-shaded [KYUUBI #4020] remove incubating from kyuubi source code 2023-01-04 09:43:20 +08:00
kyuubi-metrics [KYUUBI #4239] Remove duplicate buildConf methods and use KyuubiConf.buildConf directly 2023-02-03 16:57:12 +08:00
kyuubi-rest-client [KYUUBI #4221] REST client for creating batch with uploading resource file 2023-02-02 17:46:14 +08:00
kyuubi-server [KYUUBI #4145] Change lock and polling seq_num path on service discovery 2023-02-10 13:04:24 +08:00
kyuubi-zookeeper [KYUUBI #4239] Remove duplicate buildConf methods and use KyuubiConf.buildConf directly 2023-02-03 16:57:12 +08:00
licenses
licenses-binary [KYUUBI #4152] Enhance LDAP authentication 2023-02-03 05:48:02 +00:00
tools/spark-block-cleaner [KYUUBI #4288] Use eclipse-temurin:8-jdk-focal as default base image 2023-02-10 12:25:57 +08:00
.asf.yaml [KYUUBI #3631] Update project description 2022-10-14 21:36:54 +08:00
.dockerignore
.gitattributes [KYUUBI #4287] [INFRA] Remove Travis 2023-02-09 19:50:07 +08:00
.gitignore [KYUUBI #4152] Enhance LDAP authentication 2023-02-03 05:48:02 +00:00
.rat-excludes [KYUUBI #3968] Upgrading and migration script for Jdbc 2023-01-07 14:37:54 +08:00
.readthedocs.yml
.scalafmt.conf [KYUUBI #4206] Bump scalafmt from 3.6.1 to 3.7.1 2023-01-29 14:57:29 +08:00
codecov.yml
CONTRIBUTING.md [KYUUBI #4226] Fix word spelling typos in docs 2023-02-02 11:43:03 +08:00
LICENSE
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 #4286] Bump Jackson from 2.14.1 to 2.14.2 2023-02-10 07:39:22 +08:00
README.md [KYUUBI #4287] [INFRA] Remove Travis 2023-02-09 19:50:07 +08:00
scalastyle-config.xml

Apache Kyuubi

Kyuubi logo

License Release codecov GitHub Workflow Status Documentation Status GitHub top language Commit activity Average time to resolve an issue Percentage of issues still open

What is Kyuubi?

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

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.