Go to file
wforget 408862af72
[KYUUBI #4814] Introduce Apache Atlas hook support in lineage plugin
### _Why are the changes needed?_

Implements AtlasLineageDispatcher to send lineage to Apache Atlas.

close #4814

Atlas Spark Model Definition: https://github.com/apache/atlas/blob/master/addons/models/1000-Hadoop/1100-spark_model.json

spark process:

![1](https://github.com/apache/kyuubi/assets/17894939/28e2c68c-0ffd-4f1d-b805-a7e964f85aab)

table lineage:

![2](https://github.com/apache/kyuubi/assets/17894939/76b3db6d-ed50-42e3-97cf-2f96d4e403df)

column lineage:

![3](https://github.com/apache/kyuubi/assets/17894939/41ae6ef8-acbf-43b9-ad05-42d669c5e950)

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

- [X] Add screenshots for manual tests if appropriate

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

Closes #4815 from wForget/KYUUBI-4814.

Closes #4814

3df8a7ec9 [wforget] comments
c58eae7c5 [wforget] comments
926bcf211 [wforget] comment
e0b4067c3 [wforget] comment
e4cc3e3f8 [wforget] comments
adc72b96f [Bowen Liang] Update extensions/spark/kyuubi-spark-lineage/src/main/scala/org/apache/kyuubi/plugin/lineage/dispatcher/atlas/AtlasEntityHelper.scala
e3bdd1c65 [Bowen Liang] Update extensions/spark/kyuubi-spark-lineage/src/main/scala/org/apache/kyuubi/plugin/lineage/dispatcher/atlas/AtlasEntityHelper.scala
baf1711ac [Bowen Liang] Update extensions/spark/kyuubi-spark-lineage/src/test/scala/org/apache/kyuubi/plugin/lineage/dispatcher/atlas/AtlasLineageDispatcherSuite.scala
61e79f3d5 [Bowen Liang] Update extensions/spark/kyuubi-spark-lineage/src/test/scala/org/apache/kyuubi/plugin/lineage/dispatcher/atlas/AtlasLineageDispatcherSuite.scala
541df3780 [Bowen Liang] Update extensions/spark/kyuubi-spark-lineage/src/test/scala/org/apache/kyuubi/plugin/lineage/dispatcher/atlas/AtlasLineageDispatcherSuite.scala
5dd310657 [wforget] fix
cea1e137d [wforget] fix
f028d4b09 [wforget] fix
0c9b4516b [wforget] fix
6f8113032 [wforget] add close atlas client shutdown hook
3f4d2a7db [wforget] add remote user
a0db58afc [wforget] comments
6dd3c66df [wforget] comments
f2b2a30dc [wforget] style
83eb1e481 [wforget] add atlas.column.lineage.enable configuration
0719a2b65 [wforget] doc
05f936005 [wforget] fix
d169b661d [wforget] fix
6da80d742 [wforget] fix
820ae5c5f [wforget] column lineages
dabe8173e [wforget] license
f22e044d2 [wforget] test
b948bce90 [wforget] fix and add test
0aef1be6b [wforget] fix
368b5ab3f [wforget] [KYUUBI-4814] Implements AtlasLineageDispatcher to send lineage to Apache Atlas

Lead-authored-by: wforget <643348094@qq.com>
Co-authored-by: Bowen Liang <bowenliang@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2023-06-06 17:47:19 +08:00
.github [KYUUBI #4909] [AUTHZ] Enable authz plugin tests for Spark 3.4 2023-06-01 11:46:00 +08:00
.idea
bin [KYUUBI #4849] Open modules to enable JDK 17 support 2023-05-22 09:53:49 +08:00
build [KYUUBI #4880] [BUILD] Skip compiling useless files when making distribution 2023-05-25 13:59:11 +08:00
charts/kyuubi [KYUUBI #4818] [K8S][HELM] Update default Kyuubi version to 1.7.1 2023-05-11 13:06:43 +08:00
conf [KYUUBI #4483] Enable REST frontend protocol by default 2023-03-09 02:15:47 +08:00
dev [KYUUBI #3420][UI] Kyuubi Server Proxy Engine UI 2023-06-06 15:17:40 +08:00
docker [KYUUBI #4601] Bump Hadoop 3.3.5 for playground 2023-03-26 18:44:37 +08:00
docs [KYUUBI #4814] Introduce Apache Atlas hook support in lineage plugin 2023-06-06 17:47:19 +08:00
extensions [KYUUBI #4814] Introduce Apache Atlas hook support in lineage plugin 2023-06-06 17:47:19 +08:00
externals [KYUUBI #4923] [ARROW] Update arguments of ArrowUtils#toArrowSchema function 2023-06-05 19:21:48 +08:00
integration-tests [KYUUBI #4681][Engine] Set thread CreateSparkTimeoutChecker daemon 2023-04-14 16:52:54 +08:00
kyuubi-assembly [KYUUBI #4852] Switch to Kyuubi Shaded Zookeeper 2023-05-21 20:49:00 +08:00
kyuubi-common [KYUUBI #4813] Add the fetchorientation parameter to the /v1/operations/:operationId/log interface 2023-06-06 09:41:24 +08:00
kyuubi-ctl [KYUUBI #4889] Admin command line supports list server command 2023-05-28 09:32:23 +08:00
kyuubi-events [KYUUBI #4905] Generalize util method for loading class from service loader 2023-05-31 20:37:26 +08:00
kyuubi-ha [KYUUBI #4870] Add kyuubi-util and kyuubi-util-scala modules 2023-05-22 22:13:56 +08:00
kyuubi-hive-beeline [KYUUBI #3887][FOLLOWUP] Fix kyuubiServerPrincipal logic in KyuubiCommands 2023-04-25 02:17:38 +08:00
kyuubi-hive-jdbc [KYUUBI #4852] Switch to Kyuubi Shaded Zookeeper 2023-05-21 20:49:00 +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 #4893] [MINOR] Prevent null collection for rest dto 2023-05-28 12:46:09 +08:00
kyuubi-server [KYUUBI #3420][UI] Kyuubi Server Proxy Engine UI 2023-06-06 15:17:40 +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 #4905] Generalize util method for loading class from service loader 2023-05-31 20:37:26 +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 #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
.gitattributes [KYUUBI #4287] [INFRA] Remove Travis 2023-02-09 19:50:07 +08:00
.gitignore Revert "[KYUUBI #4274] [INFRA] Introduce mvnd to speed up CI jobs of Dependency, Licence and Style Check" 2023-04-12 20:13:38 +08:00
.rat-excludes Revert "[KYUUBI #4274] [INFRA] Introduce mvnd to speed up CI jobs of Dependency, Licence and Style Check" 2023-04-12 20:13:38 +08:00
.readthedocs.yaml [KYUUBI #4800] Update readthedocs.yaml 2023-05-08 13:35:55 +08:00
.scalafmt.conf [KYUUBI #4908] Bump Scalafmt from 3.7.3 to 3.7.4 2023-05-31 17:58:14 +08:00
codecov.yml
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 #3420][UI] Kyuubi Server Proxy Engine UI 2023-06-06 15:17:40 +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 #4814] Introduce Apache Atlas hook support in lineage plugin 2023-06-06 17:47:19 +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.