Go to file
Kent Yao 10d0aecde1
[KYUUBI #5701] Enhance the PR Template to make PR desc informative
# 🔍 Description

## Issue References 🔗

This pull request fixes #5701

## Describe Your Solution 🔧

This PR updates the PR template to ensure that PR authors provide informative PR descriptions for reviewers to speed up the review process.

It's also suitable for improving our code quality.

Besides, `docs/contributing/code/style.rst` is also changed to add a link to the doc style so that we can keep the PR template neat.

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

#### Behavior Without This Pull Request ⚰️

See the screenshot below.
![image](https://github.com/apache/kyuubi/assets/8326978/94a71e97-a573-47d9-8f44-f84b0f38db72)

#### Behavior With This Pull Request 🎉

It's able to check it from the description of this PR directly.

#### Related Unit Tests

No

---

# Checklists
## 📝 Author Self Checklist

- [x] My code follows the [style guidelines](https://kyuubi.readthedocs.io/en/master/contributing/code/style.html) of this project
- [x] I have performed a self-review
- [ ] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [x] New and existing unit tests pass locally with my changes
- [x] This patch was authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html)

## 📝 Committer Pre-Merge Checklist

- [x] Pull request title is okay.
- [x] No license issues.
- [x] Milestone correctly set?
- [x] Test coverage is ok
- [x] Assignees are selected.
- [x] Minimum number of approvals
- [x] No changes are requested

**Be nice. Be informative.**

Closes #5702 from yaooqinn/pr.

Closes #5701

19bdea9a4 [Kent Yao] not
d7d9d8cfa [Kent Yao] Enhance PR Template to make PR desc informative
be026e4a6 [Kent Yao] Enhance PR Template to make PR desc informative

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Kent Yao <yao@apache.org>
2023-11-15 18:36:47 +08:00
.github [KYUUBI #5701] Enhance the PR Template to make PR desc informative 2023-11-15 18:36:47 +08:00
.idea
bin [KYUUBI #4849] Open modules to enable JDK 17 support 2023-05-22 09:53:49 +08:00
build [KYUUBI #5637] [INFRA] Add known contributor translation 2023-11-08 09:42:48 +08:00
charts/kyuubi [KYUUBI #5641] [K8S][HELM] Bump Kyuubi 1.8.0 in Helm charts 2023-11-08 12:39:31 +08:00
conf [KYUUBI #5528] Remove duplicate properties tag and respect KYUUBI_LOG_DIR 2023-10-26 13:58:57 +08:00
dev [KYUUBI #5395] Bump netty from 4.1.93.Final to 4.1.100.Final 2023-11-13 19:40:56 +08:00
docker [KYUUBI #5640] Upgrade playground to Kyuubi 1.8.0 and Spark 3.4.1 2023-11-08 10:44:20 +08:00
docs [KYUUBI #5701] Enhance the PR Template to make PR desc informative 2023-11-15 18:36:47 +08:00
extensions [KYUUBI #5677][AUTHZ] Typeof expression miss column information 2023-11-15 12:37:43 +08:00
externals [KYUUBI #5582] JDBC Engine supports configurable default fetchSize 2023-11-15 12:15:05 +08:00
integration-tests [KYUUBI #5375] JDBC Engine supports PostgreSQL 2023-11-08 19:42:49 +08:00
kyuubi-assembly Bump 1.9.0-SNAPSHOT 2023-09-04 14:23:12 +08:00
kyuubi-common [KYUUBI #5582] JDBC Engine supports configurable default fetchSize 2023-11-15 12:15:05 +08:00
kyuubi-ctl Revert "[KYUUBI #4994][REST] Support listing all engines" 2023-11-03 00:25:18 +08:00
kyuubi-events [KYUUBI #5365] Don't use Log4j2's extended throwable conversion pattern in default logging configurations 2023-10-11 21:41:22 +08:00
kyuubi-ha [KYUUBI #5365] Don't use Log4j2's extended throwable conversion pattern in default logging configurations 2023-10-11 21:41:22 +08:00
kyuubi-hive-beeline
kyuubi-hive-jdbc [KYUUBI #5564] Support to config ticket cache location in JDBC URL 2023-11-03 00:35:27 +08:00
kyuubi-hive-jdbc-shaded
kyuubi-metrics [KYUUBI #5381] Change the default metrics reporter to Prometheus 2023-10-16 11:46:56 +08:00
kyuubi-rest-client [KYUUBI #5696] [REST] Return remote session id and remote operation id 2023-11-15 13:02:50 +08:00
kyuubi-server [KYUUBI #5696] [REST] Return remote session id and remote operation id 2023-11-15 13:02:50 +08:00
kyuubi-util
kyuubi-util-scala [KYUUBI #5660] [TEST] Ensure SPI provider file content sorted in alphabet order 2023-11-10 13:44:36 +08:00
kyuubi-zookeeper [KYUUBI #5412] Resolve the relative zk configuration dir based on KYUUBI_HOME 2023-10-27 10:48:22 +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
.asf.yaml [KYUUBI #5342] Add label hacktoberfest to project 2023-09-28 12:13:16 +08:00
.dockerignore [KYUUBI #972] [LICENSE] Exclude binary/doc files from source release 2021-08-22 16:31:36 +08:00
.gitattributes [KYUUBI #5335] Set markdown file EOL 2023-09-27 22:02:09 +08:00
.gitignore [KYUUBI #5637] [INFRA] Add known contributor translation 2023-11-08 09:42:48 +08:00
.rat-excludes [KYUUBI #5484] Remove legacy Web UI 2023-10-25 13:36:00 +08:00
.readthedocs.yaml
.scalafmt.conf
codecov.yml [KYUUBI #5501] Update codecov token and fix codecov reporting on PRs 2023-10-26 14:57:36 +08:00
CONTRIBUTING.md
LICENSE [KYUUBI #5484] Remove legacy Web UI 2023-10-25 13:36:00 +08:00
LICENSE-binary [KYUUBI #5671] Bump axios from 0.27.2 to 1.6.0 in /kyuubi-server/web-ui 2023-11-13 19:32:54 +08:00
NOTICE
NOTICE-binary
pom.xml [KYUUBI #5395] Bump netty from 4.1.93.Final to 4.1.100.Final 2023-11-13 19:40:56 +08:00
README.md [KYUUBI #5432] Fix typo in README.md 2023-10-16 22:03:57 +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.

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.