Go to file
Kent Yao d516a5d360 [KYUUBI #6068] Remove community section from user docs
# 🔍 Description
## Issue References 🔗

## Describe Your Solution 🔧

The content of the community section is a bylaw, which is settled on the website.

This PR removes it and moves the release guide into the contributing fold for the moment.

The release guide is also bylaw which is suite better in website repo.

## Types of changes 🔖

- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] 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 ⚰️

#### Behavior With This Pull Request 🎉

#### Related Unit Tests

---

# Checklist 📝

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

**Be nice. Be informative.**

Closes #6068 from yaooqinn/community.

Closes #6068

8e18da63f [Kent Yao] Remove community section from user docs

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2024-02-21 05:20:42 +00:00
.github [KYUUBI #6047] [CI] Free up disk space 2024-02-05 12:12:15 +08:00
.idea [KYUUBI #5252] [MINOR] Remove incubator link 2023-09-05 14:01:40 +08:00
bin [KYUUBI #5987] Always export KYUUBI_HOME in load-kyuubi-env.sh 2024-01-22 21:32:22 +08:00
build [KYUUBI #6061] Delete svn staging dir before checking out 2024-02-20 10:08:34 +08:00
charts/kyuubi [KYUUBI #6006][HELM] Support additional labels for service monitor 2024-01-29 13:49:08 +08:00
conf [KYUUBI #5729] Use G1GC as Java option example in kyuubi-env template 2023-11-22 15:44:14 +08:00
dev [KYUUBI #5674] Add PostgreSQL as backend database for kyuubi metadata 2024-01-30 13:15:35 +08:00
docker [KYUUBI #5944] Introduce Prometheus and Grafana for Kyuubi Playground 2024-01-15 13:49:00 +08:00
docs [KYUUBI #6068] Remove community section from user docs 2024-02-21 05:20:42 +00:00
extensions [KYUUBI #5991] Error on reading Atlas properties composed of multi values 2024-02-06 22:00:53 +08:00
externals [KYUUBI #5952] Disconnect connections without running operations after engine maxlife time graceful period 2024-02-06 18:16:46 -08:00
integration-tests [KYUUBI #6043][TEST][GLUTEN] Gluten-it gluten package add arch suffix 2024-02-10 18:39:01 +08:00
kyuubi-assembly [KYUUBI #5783] Switch to kyuubi-relocated-hive-service-rpc 2023-12-07 19:55:10 +08:00
kyuubi-common [KYUUBI #6058] Make Jetty server stop timeout configurable 2024-02-17 00:38:44 +08:00
kyuubi-ctl [KYUUBI #5833] Rename service registered endpoint key from serviceUri to serverUri 2023-12-08 17:55:25 +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 #6048] Assign serviceNode and add volatile for variables 2024-02-08 09:35:20 +08:00
kyuubi-hive-beeline [KYUUBI #5918] Kyuubi BeeLine should check the relocated TTransportException 2023-12-27 21:46:48 +08:00
kyuubi-hive-jdbc [KYUUBI #6036] JDBC driver conditional sets fetchSize on opening session 2024-01-31 21:09:36 +08:00
kyuubi-hive-jdbc-shaded [KYUUBI #5953] [LICENSE] Update NOTICE 2024-01-10 19:29:01 +08:00
kyuubi-metrics [KYUUBI #5381] Change the default metrics reporter to Prometheus 2023-10-16 11:46:56 +08:00
kyuubi-rest-client [KYUUBI #6053] [K8S] Show more details for pod/container status in application error 2024-02-07 20:55:11 -08:00
kyuubi-server [KYUUBI #6066] Fix PostgreSQL metastore migration script failure if indexes already exist 2024-02-20 23:05:30 +08:00
kyuubi-util Bump 1.9.0-SNAPSHOT 2023-09-04 14:23:12 +08:00
kyuubi-util-scala [KYUUBI #5800] [KYUUBI#5467] Integrate Intel Gluten with Spark engine 2023-12-07 10:47:00 +08:00
kyuubi-zookeeper [KYUUBI #5783] Switch to kyuubi-relocated-hive-service-rpc 2023-12-07 19:55:10 +08:00
licenses
licenses-binary [KYUUBI #5674][LICENSE][FOLLOWUP] Update license files 2024-01-30 13:47:33 +08: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 #5914] Update layer diagram on welcome page 2023-12-25 16:13:48 +08:00
.rat-excludes [KYUUBI #5484] Remove legacy Web UI 2023-10-25 13:36:00 +08:00
.readthedocs.yaml
.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 #5674][LICENSE][FOLLOWUP] Update license files 2024-01-30 13:47:33 +08:00
NOTICE [KYUUBI #5953] [LICENSE] Update NOTICE 2024-01-10 19:29:01 +08:00
NOTICE-binary [KYUUBI #5953] [LICENSE] Update NOTICE 2024-01-10 19:29:01 +08:00
pom.xml [KYUUBI #6067] Bump org.postgresql:postgresql from 42.6.0 to 42.7.2 2024-02-21 05:19:13 +00: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.