Go to file
Paul Lin b315123a6b
[KYUUBI #1652] Support Flink yarn application mode
### _Why are the changes needed?_
Flink yarn application mode is crucial for the production usage of Flink engine.

To test this PR locally, we should:

1) set `flink.execution.target=yarn-application` in `kyuubi-defaults.conf`.

### _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/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4604 from link3280/KYUUBI-1652.

Closes #1652

49b454f1e [Paul Lin] [KYUUBI #1652] Delay access to thrift services to stablize tests
b91b64bf6 [Paul Lin] Revert "[KYUUBI #1652] Avoid hadoop conf injecting into kyuubi conf"
c9f710b0f [Paul Lin] [KYUUBI #1652] Avoid hadoop conf injecting into kyuubi conf
cde8a5477 [Paul Lin] [KYUUBI #1652] Improve docs
edba0ec79 [Paul Lin] [KYUUBI #1652] Improve codestyle
e03e055ae [Paul Lin] [KYUUBI #1652] Update docs according to the comments
490559cd8 [Paul Lin] [KYUUBI #1652] Update docs
769d1a8fa [Paul Lin] [KYUUBI #1652] Move zookeeper to test scope
bafb3f5a4 [Paul Lin] [KYUUBI #1652] Fix flink-it test
dd40c72b8 [Paul Lin] [KYUUBI #1652] Update docs
36c993fc2 [Paul Lin] [KYUUBI #1652] Fix javax.activation not found in flink-it
2a751bdd6 [Paul Lin] [KYUUBI #1652] Introduce EmbeddedZookeeper in Flink yarn tests
0933b7082 [Paul Lin] [KYUUBI #1652] Fix spotless issue
b858f7df6 [Paul Lin] [KYUUBI #1652] Fix Flink submit timeout because failing to find hadoop conf
15801b598 [Paul Lin] [KYUUBI #1652] Replace unused jaxb
b210615e4 [Paul Lin] Update externals/kyuubi-flink-sql-engine/pom.xml
24b23da2c [Paul Lin] [KYUUBI #1652] Update jaxb scope to test
240efae1a [Paul Lin] [KYUUBI #1652] Update jaxb scope to runtime
0e9a508b6 [Paul Lin] [KYUUBI #1652] Update jaxb scope to runtime
b5dbd3346 [Paul Lin] [KYUUBI #1652] Fix jdk11 jaxb ClassNotFoundException
72ba3ee6d [Paul Lin] [KYUUBI #1652] Update tm memory to 1gb
4e10ea21f [Paul Lin] [KYUUBI #1652] Refactor flink engin tests
e9cec4a65 [Paul Lin] [KYUUBI #1652] Add flink-it tests
6eb9fd3ad [Paul Lin] [KYUUBI #1652] Fix ProcessBuilder tests
6aca061e6 [Paul Lin] [KYUUBI #1652] Fix ClassNotFoundException
7581a2a0d [Paul Lin] [KYUUBI #1652] Fix missing minicluster
412c34571 [Paul Lin] [KYUUBI #1652] Remove flink-yarn dependencies
0eafbd7b0 [Paul Lin] Update externals/kyuubi-flink-sql-engine/src/main/scala/org/apache/kyuubi/engine/flink/result/ResultSet.scala
ee2c64d04 [Paul Lin] [KYUUBI #1652] Add Flink YARN application tests
a72627393 [Paul Lin] [KYUUBI #1652] Avoid flink-yarn dependencies
a75cb2579 [Paul Lin] [KYUUBI #1652] Fix test issue
b7e173f30 [Paul Lin] [KYUUBI #1652] Replace file-based Kyuubi conf with cli args
693ad6529 [Paul Lin] [KYUUBI #1652] Removed unused imports
68e0081e1 [Paul Lin] Update kyuubi-server/src/main/scala/org/apache/kyuubi/engine/flink/FlinkProcessBuilder.scala
ba021de9d [Paul Lin] [KYUUBI #1652] Search flink-sql.* jars and add them to pipeline jars
0846babbd [Paul Lin] [KYUUBI #1652] Avoid Scala bug
56413fe83 [Paul Lin] [KYUUBI #1652] Improve tmp files cleanup
8bdb672c4 [Paul Lin] [KYUUBI #1652] Explicitly load Kyuubi conf on Flink engine start
0b6325000 [Paul Lin] [KYUUBI #1652] Fix test failures
0ba03e439 [Paul Lin] [KYUUBI #1652] Fix wrong Flink args
00f036b04 [Paul Lin] [KYUUBI #1652] Remove unused util methods
dfd2777ac [Paul Lin] [KYUUBI ##1652] Support Flink yarn application mode

Authored-by: Paul Lin <paullin3280@gmail.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2023-04-07 18:51:48 +08:00
.github [KYUUBI #4632] [CI] Add rule for labeler to tag module:ui 2023-03-30 19:48:15 +08:00
.idea [KYUUBI #870] [MISC] Migrate from NetEase to Apache 2021-07-28 21:31:46 +08:00
bin [KYUUBI #4494] bin/kyuubi should use exec to run Kyuubi server 2023-03-11 00:19:04 +08:00
build [KYUUBI #4647] Bump Maven from 3.8.7 to 3.9.1 and Mvnd from 0.9.0 to 1.0-m6 2023-04-03 11:45:10 +08:00
charts/kyuubi [KYUUBI #4606] [K8S][HELM] Add command and args configuration support 2023-03-26 21:01:59 +08:00
conf [KYUUBI #4483] Enable REST frontend protocol by default 2023-03-09 02:15:47 +08:00
dev [KYUUBI #4325] Support replace preparedStatement for Trino-jdbc 2023-03-30 20:37:55 +08:00
docker [KYUUBI #4601] Bump Hadoop 3.3.5 for playground 2023-03-26 18:44:37 +08:00
docs [KYUUBI #1652] Support Flink yarn application mode 2023-04-07 18:51:48 +08:00
extensions [KYUUBI #4585] Authz policy file generation 2023-04-07 16:16:36 +08:00
externals [KYUUBI #1652] Support Flink yarn application mode 2023-04-07 18:51:48 +08:00
integration-tests [KYUUBI #1652] Support Flink yarn application mode 2023-04-07 18:51:48 +08:00
kyuubi-assembly Bump 1.8.0-SNAPSHOT 2023-02-10 15:25:49 +08:00
kyuubi-common [KYUUBI #1652] Support Flink yarn application mode 2023-04-07 18:51:48 +08:00
kyuubi-ctl [KYUUBI #4657] Building rest client to kyuubi instance including original host urls 2023-04-04 16:19:45 +08:00
kyuubi-events Bump 1.8.0-SNAPSHOT 2023-02-10 15:25:49 +08:00
kyuubi-ha [KYUUBI #1652] Support Flink yarn application mode 2023-04-07 18:51:48 +08:00
kyuubi-hive-beeline [KYUUBI #4619] Fix beeline with -e When there are other SQL statements before the source statement, the source statement cannot be executed normally 2023-04-04 09:36:05 +08:00
kyuubi-hive-jdbc [KYUUBI #4325] Support replace preparedStatement for Trino-jdbc 2023-03-30 20:37:55 +08:00
kyuubi-hive-jdbc-shaded Bump 1.8.0-SNAPSHOT 2023-02-10 15:25:49 +08:00
kyuubi-metrics [KYUUBI #4563] [Improvement] Format error log output in case of metrics json file not found 2023-03-23 18:01:16 +08:00
kyuubi-rest-client [KYUUBI #4657] Building rest client to kyuubi instance including original host urls 2023-04-04 16:19:45 +08:00
kyuubi-server [KYUUBI #1652] Support Flink yarn application mode 2023-04-07 18:51:48 +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 [KYUUBI #4295] Introduce super-linter action for linting JSON, XML, ENV files and bash_exec 2023-03-18 21:54:45 +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 #4546] Fully exclude metrics dir from git 2023-03-17 12:31:36 +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 #3646][UI] Init Session Statistic Page 2023-03-24 11:43:15 +08: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 #4647] Bump Maven from 3.8.7 to 3.9.1 and Mvnd from 0.9.0 to 1.0-m6 2023-04-03 11:45:10 +08:00
README.md [KYUUBI #4655] [DOCS] Enrich docs for Kyuubi Hive JDBC driver 2023-04-03 18:51:27 +08:00
scalastyle-config.xml

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.