Merge pull request #85 from yaooqinn/i84

fix #84 releasing 0.2.0
tree: 605a66cb36ec80a05a44a2fd787f62d05536a5f2
  1. bin/
  2. build/
  3. docs/
  4. if/
  5. src/
  6. .gitignore
  7. .travis.yml
  8. _config.yml
  9. CODE_OF_CONDUCT.md
  10. CONTRIBUTING.md
  11. LICENSE
  12. pom.xml
  13. README.md
  14. scalastyle-config.xml
README.md

Kyuubi codecov Build StatusHitCount

Kyuubi is an enhanced edition of the Apache Spark's primordial Thrift JDBC/ODBC Server. It is mainly designed for directly running SQL towards a cluster with all components including HDFS, YARN, Hive MetaStore, and itself secured. Kyuubi is a Spark SQL thrift service with end-to-end multi tenant guaranteed. Please go to Kyuubi Architecture to learn more if you are interested.

Basically, the Thrift JDBC/ODBC Server as a similar ad-hoc SQL query service of Apache Hive‘s HiveServer2 for Spark SQL, acts as a distributed query engine using its JDBC/ODBC or command-line interface. In this mode, end-users or applications can interact with Spark SQL directly to run SQL queries, without the need to write any code. We can make pretty business reports with massive data using some BI tools which supported JDBC/ODBC connections, such as Tableau, NetEase YouData and so on. Benefitting from Apache Spark’s capability, we can archive much more performance improvement than Apache Hive as a SQL on Hadoop service.

But unfortunately, due to the limitations of Spark‘s own architecture,to be used as an enterprise-class product, there are a number of problems compared with HiveServer2,such as multi-tenant isolation, authentication/authorization, high concurrency, high availability, and so on. And the Apache Spark community’s support for this module has been in a state of prolonged stagnation.

Kyuubi has enhanced the Thrift JDBC/ODBC Server in some ways for solving these existing problems, as shown in the following table.

FeaturesThrift ServerKyuubiComments
multiple SparkContextSpark has several issues to have multiple SparkContext instances in one single JVM. Option spark.driver.allowMultipleContexts=true only enables SparkContext to be instantiated many times but these instances can only share and use the scheduler and execution environments of the last initialized one, which is kind of like a shallow copy of a Java object. Kyuubi provides a way of isolating these components by user to avoid overlapping.
“lazy” SparkContextEach SparkContext initialization is delayed to the phase of first session of a particular user's creation in Kyuubi, while Thrift JDBC/ODBC Server create one only when it starts.
SparkContext cacheIn Thrift JDBC/ODBC Server, SparkContext is a resident variable. Kyuubi will cache SparkContext instances for a while after session closed before the server terminating them.
dynamic queueWe use spark.yarn.queue to specifying the queue that Spark on Yarn applications run into. Once Thrift JDBC/ODBC Server started, it becomes unchangeable, while HiveServer2 could switch queue byset mapred.job.queue.name=thequeue. Kyuubi adopts a compromise method which could identify and use spark.yarn.queue in the connection string.
session level configurationsspark.sql.*Kyuubi supports all Spark/Hive/Hadoop configurations, such as spark.executor.cores/memory, to be set in the connection string which will be used to initialize SparkContext.
authenticationPlease refer to the Authentication/Security Guide
authorizationSpark Authorizer will be add to Kyuubi soon.
impersonationKyuubi fully support hive.server2.proxy.user and hive.server2.doAs
multi tenancyBased on the above features,Kyuubi is able to run as a multi-tenant server on a LCE supported Yarn cluster.
operation logKyuubi redirect sql operation log to local file which has an interface for the client to fetch.
high availabilityBased on ZooKeeper dynamic service discovery
cluster modeyarn cluster mode will be supported soon
type mappingKyuubi support Spark result/schema to be directly converted to Thrift result/schemas bypassing Hive format results

Getting Started

Packaging

Please refer to the Building Kyuubi in the online documentation for an overview on how to build Kyuubi.

Start Kyuubi

We can start Kyuubi with the built-in startup script bin/start-kyuubi.sh. First of all, export SPARK_HOME in $KYUUBI_HOME/bin/kyuubi-env.sh

export SPARK_HOME=/the/path/to/a/runable/spark/binary/dir

And then the last, start Kyuubi with bin/start-kyuubi.sh

$ bin/start-kyuubi.sh \ 
    --master yarn \
    --deploy-mode client \
    --driver-memory 10g \
    --conf spark.kyuubi.frontend.bind.port=10009

Run Spark SQL on Kyuubi

Now you can use beeline, Tableau or Thrift API based programs to connect to Kyuubi server.

Stop Kyuubi

bin/stop-kyuubi.sh

Multi Tenancy Support

Prerequisites

Kyuubi may work well with different deployments such as non-secured Yarn, Standalone, Mesos or even local mode, but it is mainly designed for a secured HDFS/Yarn Cluster on which Kyuubi will play well with multi tenant and secure features.

Suppose that you already have a secured HDFS cluster for deploying Spark, Hive or other applications.

Configure Yarn

Spark on Yarn

  • Setup for Spark On Yarn Ensure that HADOOP_CONF_DIR or YARN_CONF_DIR points to the directory which contains the (client side) configuration files for the Hadoop cluster.

Configure Hive

  • Configuration of Hive is done by placing your hive-site.xml, core-site.xml and hdfs-site.xml files in $SPARK_HOME/conf.

Configuration

Please refer to the Configuration Guide in the online documentation for an overview on how to configure Kyuubi.

Authentication

Please refer to the Authentication/Security Guide in the online documentation for an overview on how to enable security for Kyuubi.

Additional Documentations

Building Kyuubi
Configuration Guide
Authentication/Security Guide
Kyuubi Architecture