Go to file
Bowen Liang 8862767827 [KYUUBI #6034] Kyuubi Server HA&ZK get server from serverHosts support more strategy
# 🔍 Description
## Issue References 🔗

This pull request fixes #6034

## Describe Your Solution 🔧
Currently, use beeline to connect kyuubiServer with HA mode, the strategy only support random, this will lead to a high load on the machine. So i make this pr to support choose strategy.
[description]
First, we need know, beeline connect kyuubiServer dependency on kyuubi-hive-jdbc, it is isolated from the kyuubi cluster, so the code only support random choose serverHost from zk node /${namespace}. Because kyuubi-hive-jdbc is a stateless module, only run once, cannot store var about get serverHost from zk node.
[Solution]
This pr, we could implement a interface named ChooseServerStrategy to choose serverHost. I implement two strategy
1. poll: it will create a zk node named ${namespace}-counter, when a beeline client want connect kyuubiServer, the node will increment 1, use this value to take the remainder from serverHosts, like counter % serverHost.size, so we could get a order serverHost
2. random: random get serverHost from serverHosts
3. User Definied Class: implemented the ChooseServerStrategy, then put the jar to beeline-jars, it can use your strategy to choose serverHost

## Types of changes 🔖

- [ ] Bugfix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Test Plan 🧪
Test the Strategy in my test Cluster
#### Behavior Without This Pull Request ⚰️
![image](https://github.com/apache/kyuubi/assets/51512358/d65b14c1-1b02-4436-8843-27b2e55d27ce)
![image](https://github.com/apache/kyuubi/assets/51512358/0524a30c-c2c3-464e-8453-84f3f1a74fb1)
![image](https://github.com/apache/kyuubi/assets/51512358/12feb93e-b743-4a43-821d-454f3c1af336)

#### Behavior With This Pull Request 🎉

[Use Case]
1. poll: `bin/beeline -u 'jdbc:hive2://xxx:2181/;serviceDiscoveryMode=zooKeeper;zooKeeperNamespace=kyuubi;zooKeeperStrategy=poll?spark.yarn.queue=root.kylin;spark.app.name=testspark;spark.shuffle.useOldFetchProtocol=true' -n mfw_hadoop --verbose=true --showNestedErrs=true`
2. random: `bin/beeline -u 'jdbc:hive2://xxx:2181/;serviceDiscoveryMode=zooKeeper;zooKeeperNamespace=kyuubi;zooKeeperStrategy=random?spark.yarn.queue=root.kylin;spark.app.name=testspark;spark.shuffle.useOldFetchProtocol=true' -n mfw_hadoop --verbose=true --showNestedErrs=true` or `bin/beeline -u 'jdbc:hive2://xxx:2181/;serviceDiscoveryMode=zooKeeper;zooKeeperNamespace=kyuubi?spark.yarn.queue=root.kylin;spark.app.name=testspark;spark.shuffle.useOldFetchProtocol=true' -n mfw_hadoop --verbose=true --showNestedErrs=true`
3. YourStrategy: `bin/beeline -u 'jdbc:hive2://xxx:2181/;serviceDiscoveryMode=zooKeeper;zooKeeperNamespace=kyuubi;zooKeeperStrategy=xxx.xxx.xxx.XxxChooseServerStrategy?spark.yarn.queue=root.kylin;spark.app.name=testspark;spark.shuffle.useOldFetchProtocol=true' -n mfw_hadoop --verbose=true --showNestedErrs=true`

[Result: The Cluster have two Server (221,233)]
1. poll:
1.1. zkNode: counterValue
![image](https://github.com/apache/kyuubi/assets/51512358/5cbd15f9-bba4-4b23-bbfb-d61ed46f931f)

1.2. result:
![image](https://github.com/apache/kyuubi/assets/51512358/5a867167-8b06-49ed-aa44-b70726f3ae97)
![image](https://github.com/apache/kyuubi/assets/51512358/404b05e8-c828-458c-a9c4-97a323bf6ce7)
![image](https://github.com/apache/kyuubi/assets/51512358/3182e92b-6976-4931-a899-5e0d89cd2ac2)
![image](https://github.com/apache/kyuubi/assets/51512358/a55450ff-49cf-4b4a-9b90-91dd02982aa5)

2. random:
![image](https://github.com/apache/kyuubi/assets/51512358/d65b14c1-1b02-4436-8843-27b2e55d27ce)
![image](https://github.com/apache/kyuubi/assets/51512358/0524a30c-c2c3-464e-8453-84f3f1a74fb1)
![image](https://github.com/apache/kyuubi/assets/51512358/12feb93e-b743-4a43-821d-454f3c1af336)

3. YourStrategy(the test case only get the first serverHost):
![image](https://github.com/apache/kyuubi/assets/51512358/2e6395c2-6496-4516-9cf6-90abc921de7f)
![image](https://github.com/apache/kyuubi/assets/51512358/72975513-48d2-4f41-8a95-95cde0302c5b)
![image](https://github.com/apache/kyuubi/assets/51512358/487951fd-de45-4e1c-861a-94e0e5564e37)

#### Related Unit Tests

There is no Unit Tests.
---

# Checklist 📝

- [ ] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html)

**Be nice. Be informative.**

Closes #6213 from davidyuan1223/ha_zk_support_more_strategy.

Closes #6034

961d3e989 [Bowen Liang] rename ServerStrategyFactory to ServerSelectStrategyFactory
353f94059 [Bowen Liang] repeat
8822ad471 [Bowen Liang] repeat
619339402 [Bowen Liang] nit
e94f9e909 [Bowen Liang] nit
40f427ae5 [Bowen Liang] rename StrategyFactory to StrategyFactoryServerStrategyFactory
7668f99cc [Bowen Liang] test name
e194ea62f [Bowen Liang] remove ZooKeeperHiveClientException from method signature of chooseServer
265965e5d [Bowen Liang] polling
b39c56700 [Bowen Liang] style
1ab79b494 [Bowen Liang] strategyName
8f8ca28f2 [Bowen Liang] nit
228bf1091 [Bowen Liang] rename parameter zooKeeperStrategy to serverSelectStrategy
125c82358 [Bowen Liang] rename ChooseServerStrategy to ServerSelectStrategy
b4aeb3dbd [Bowen Liang] repeat testing on pollingChooseStrategy
465548005 [davidyuan] update
09a84f1f9 [david yuan] remove the distirbuted lock
93f4a2699 [davidyuan] remove reset
7b0c1b811 [davidyuan] fix var not valid and counter getAndIncrement
c95382a23 [davidyuan] fix var not valid and counter getAndIncrement
9ed2cac85 [david yuan] remove test comment
8eddd7682 [davidyuan] Add Strategy Unit Test Case and fix the polling strategy counter begin with 0
73952f878 [davidyuan] Kyuubi Server HA&ZK get server from serverHosts support more strategy
97b959776 [davidyuan] Kyuubi Server HA&ZK get server from serverHosts support more strategy
ee5a9ad68 [davidyuan] Kyuubi Server HA&ZK get server from serverHosts support more strategy
6a0445357 [davidyuan] Kyuubi Server HA&ZK get server from serverHosts support more strategy
1892f148d [davidyuan] add common method to get session level config
7c0c6058d [yuanfuyuan] fix_4186

Lead-authored-by: Bowen Liang <liangbowen@gf.com.cn>
Co-authored-by: davidyuan <yuanfuyuan@mafengwo.com>
Co-authored-by: davidyuan <davidyuan1223@gmail.com>
Co-authored-by: david yuan <davidyuan1223@gmail.com>
Co-authored-by: yuanfuyuan <1406957364@qq.com>
Signed-off-by: Bowen Liang <liangbowen@gf.com.cn>
2024-10-23 16:57:09 +08:00
.github [KYUUBI #6775] Bump Github actions action/cache and actions/dependency-review-action v4 2024-10-23 14:32:16 +08:00
.idea [KYUUBI #5252] [MINOR] Remove incubator link 2023-09-05 14:01:40 +08:00
bin [KYUUBI #6609] Bump Spark 3.5.2 2024-08-14 20:57:06 +08:00
build [KYUUBI #6762] [BUILD] cleanup dockerfile warnings 2024-10-22 13:38:02 +08:00
charts/kyuubi [KYUUBI #6620] [K8S][HELM] Update default Kyuubi version to 1.9.2 2024-08-16 10:57:22 +00:00
conf [KYUUBI #6268] Specify logDir for RollingFile filePattern 2024-04-09 17:27:56 +08:00
dev [KYUUBI #6742] Bump Jetty from 9.4.54 to 9.4.56 2024-10-17 21:33:03 +08:00
docker [KYUUBI #6762] [BUILD] cleanup dockerfile warnings 2024-10-22 13:38:02 +08:00
docs [KYUUBI #6368] Flink engine supports user impersonation 2024-10-21 17:32:39 +08:00
extensions [KYUUBI #6754][AUTHZ] Improve the performance of Ranger access requests deduplication 2024-10-21 21:17:51 +08:00
externals [KYUUBI #6368] Flink engine supports user impersonation 2024-10-21 17:32:39 +08:00
integration-tests [KYUUBI #6609] Bump Spark 3.5.2 2024-08-14 20:57:06 +08:00
kyuubi-assembly [RELEASE] Bump 1.10.0-SNAPSHOT 2024-03-13 14:24:49 +08:00
kyuubi-common [KYUUBI #6368] Flink engine supports user impersonation 2024-10-21 17:32:39 +08:00
kyuubi-ctl [KYUUBI #6680] Format the kyuubi-ctl batch command output 2024-09-14 12:54:44 -07:00
kyuubi-events [KYUUBI #6290] Add custom exception serialization for SparkOperationEvent 2024-04-11 19:29:41 +08:00
kyuubi-ha [KYUUBI #6034] Kyuubi Server HA&ZK get server from serverHosts support more strategy 2024-10-23 16:57:09 +08:00
kyuubi-hive-beeline Revert "[KYUUBI #6526] Kyuubi BeeLine wrongly process JDBC URL that contains --" 2024-07-08 16:39:11 +08:00
kyuubi-hive-jdbc [KYUUBI #6034] Kyuubi Server HA&ZK get server from serverHosts support more strategy 2024-10-23 16:57:09 +08:00
kyuubi-hive-jdbc-shaded [KYUUBI #6391] Bump Arrow from 15.0.2 to 16.0.0 2024-05-20 19:26:15 +08:00
kyuubi-metrics [KYUUBI #6392] Support javax.servlet and jakarta.servlet co-exist 2024-05-20 21:09:30 +08:00
kyuubi-rest-client [KYUUBI #6727] replace immutable empty list and map in BatchRequest initialization 2024-10-15 17:02:13 +08:00
kyuubi-server [KYUUBI #6772] Fix ProcessBuilder to properly handle Java opts as a list 2024-10-23 13:28:58 +08:00
kyuubi-util [KYUUBI #6499] Rewrite some utility methods in Java 2024-06-25 09:59:03 +08:00
kyuubi-util-scala [KYUUBI #6772] Fix ProcessBuilder to properly handle Java opts as a list 2024-10-23 13:28:58 +08:00
kyuubi-zookeeper [KYUUBI #6499] Rewrite some utility methods in Java 2024-06-25 09:59:03 +08:00
licenses
licenses-binary [KYUUBI #6392] Support javax.servlet and jakarta.servlet co-exist 2024-05-20 21:09:30 +08:00
python [KYUUBI #6485] Fix the Presto TABLE NOT FOUND error message that failed to match 2024-08-12 08:38:09 +00:00
.asf.yaml [KYUUBI #5342] Add label hacktoberfest to project 2023-09-28 12:13:16 +08:00
.dockerignore
.gitattributes [KYUUBI #5335] Set markdown file EOL 2023-09-27 22:02:09 +08:00
.gitignore [KYUUBI #6587] Periodically expire temp files and operation logs on server to avoid memeory leak by Files.deleteOnExit 2024-08-28 17:13:27 +08:00
.rat-excludes [KYUUBI #5686][FOLLOWUP] Rename pyhive to python 2024-04-09 20:30:02 +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 #5501] Update codecov token and fix codecov reporting on PRs 2023-10-26 14:57:36 +08:00
CONTRIBUTING.md [KYUUBI #6068] Remove community section from user docs 2024-02-21 05:20:42 +00:00
LICENSE [KYUUBI #5484] Remove legacy Web UI 2023-10-25 13:36:00 +08:00
LICENSE-binary [KYUUBI #6458] Remove commons-logging from binary release 2024-06-11 11:32:30 +08:00
NOTICE [KYUUBI #6434] Add footnote about pyhive origin 2024-06-24 10:30:51 +08:00
NOTICE-binary [KYUUBI #6458] Remove commons-logging from binary release 2024-06-11 11:32:30 +08:00
pom.xml [KYUUBI #6368] Flink engine supports user impersonation 2024-10-21 17:32:39 +08:00
README.md [KYUUBI #5432] Fix typo in README.md 2023-10-16 22:03:57 +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, etc.

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.