Building With Maven

Kyuubi is built based on Apache Maven,

./build/mvn clean package -DskipTests

This results in the creation of all sub-modules of Kyuubi project without running any unit test.

If you want to test it manually, you can start Kyuubi directly from the Kyuubi project root by running

bin/kyuubi start

Building A Submodule Individually

For instance, you can build the Kyuubi Common module using:

build/mvn clean package -pl kyuubi-common -DskipTests

Building Submodules Individually

For instance, you can build the Kyuubi Common module using:

build/mvn clean package -pl kyuubi-common,kyuubi-ha -DskipTests

Skipping Some Modules

For instance, you can build the Kyuubi modules without Kyuubi Codecov and Assembly modules using:

mvn clean install -pl '!dev/kyuubi-codecov,!kyuubi-assembly' -DskipTests

Building Kyuubi Against Different Apache Spark Versions

Since v1.1.0, Kyuubi support building with different Spark profiles,

Building Kyuubi Against Different Scala Versions

Since v1.8.0, Kyuubi support building with different Scala profile. Currently, Kyuubi supports building with Scala 2.12 and 2.13, while Scala 2.12 by default.

Please activate scala-2.13 profile when Scala 2.13 support is needed. The GA tests have covered integration test with the Kyuubi server, engines and related plugins, while the Flink engine and it’s integration tests are not included for the reason that Flink does not support Scala 2.13 yet and will pull out client support for Scala.

For the Scala version for Spark engines, the server will look up the SPARK_SCALA_VERSION system environment variable first, and then the Scala version of the server compiled with if the former one not set. For the Scala version for other engines, the server will use the Scala version of the server compiled with.

Building With Apache dlcdn Site

By default, we use https://archive.apache.org/dist/ to download the built-in release packages of engines, such as Spark or Flink. But sometimes, you may find it hard to reach, or the download speed is too slow, then you can define the apache.archive.dist by -Pmirror-cdn to accelerate to download speed. For example,

build/mvn clean package -Pmirror-cdn

The profile migrates your download repo to the Apache officially suggested site - https://dlcdn.apache.org. Note that, this site only holds the latest versions of Apache releases. You may fail if the specific version defined by spark.version or flink.version is overdue.

Building with the fast profile

The fast profile helps to significantly reduce build time, which is useful for development or compilation validation, by skipping running the tests, code style checks, building scaladoc, enforcer rules and downloading engine archives used for tests.

build/mvn clean package -Pfast