Kite SDK Examples

The Kite Examples project provides examples of how to use the Kite SDK.

Each example is a standalone Maven module with associated documentation.

Basic Examples

Advanced Examples

Getting Started

The easiest way to run the examples is on the Cloudera QuickStart VM, which has all the necessary Hadoop services pre-installed, configured, and running locally. See the notes below for any initial setup steps you should take.

The current examples run on version 5.1.0 of the QuickStart VM.

Checkout the latest branch of this repository in the VM:

git clone git://
cd kite-examples

Then choose the example you want to try and refer to the README in the relevant subdirectory.

Setting up the QuickStart VM

There are two ways to run the examples with the QuickStart VM:

  1. Logged in to the VM guest (username and password are both cloudera).
  2. From your host computer.

The advantage of the first approach is that you don't need to install anything extra on your host computer, such as Java or Maven, so there are no fewer set up steps.

For either approach, you need to make the following changes while logged into the VM:

The second approach is preferable when you want to use tools from your own development environment (browser, IDE, command line). However, there are a few extra steps you need to take to configure the QuickStart VM, listed below:

If you have VBoxManage installed on your host machine, you can do this via command line as well. In bash, this would look something like:

# Set VM_NAME to the name of your VM as it appears in VirtualBox
VM_NAME="QuickStart VM"
PORTS="8032 10020"
for port in $PORTS; do
  VBoxManage modifyvm "$VM_NAME" --natpf1 "Rule $port,tcp,,$port,,$port"

Running integration tests

Some of the examples include integration tests. You can run them all with the following command:

for module in $(ls -d -- */); do
  (cd $module; mvn clean verify; if [ $? -ne 0 ]; then break; fi)


Working with the VM