Kaa releases
Skip to end of metadata
Go to start of metadata

The following instructions explain how to build a Kaa endpoint SDK and integrate it with snappy Ubuntu Core.

Required software components

Ensure the following components are installed on your machine.


To integrate Kaa with snappy Ubuntu Core, you need to use two virtual boxes: one to deploy snappy Ubuntu and a Kaa client and the other to deploy the Kaa sandbox.

Configuring and building sample Kaa client

We assume that the Kaa sandbox is already started.

NOTE: Make sure that the Kaa client is able to connect to Bootstrap and Operations servers deployed on the Kaa sandbox.

To configure and build a sample Kaa client, proceed as follows:

  1. Go to http://localhost:8080/sandbox/.
  2. Enter the IP address of your Kaa sanbox VM into the text field and then click Change (in the following screenshot, the IP address is
  3. Wait till the service restarts.
  4. Get the latest Kaa code from github.

  5. Configure and generate C SDK for your Kaa client.
    NOTE: You can find sample Avro schemas in c-sdk-sample/avro/path.

    Avro schemas
  6. Create a snappy application in web UI.
    Refer to managing applications in case of difficulties.

  7. Add a new configuration schema for your application (look at configuration.avsc).
    NOTE: Refer to the configuration schema section in Admin UI guide in case of difficulties.
  8. Add a new profile schema for your application (look at profile.avsc).
    NOTE: Refer to the profile schema section in Admin UI guide in case of difficulties.
  9. Add a new log schema for your application (look at log.avsc).
    NOTE: Refer to the log schema section in Admin UI guide in case of difficulties.
  10. Generate the C SDK for your application.
    NOTE: Refer to the generating SDK section in Admin UI guide in case of difficulties.
  11. Build a Kaa client with the generated C SDK. Remove everything in the c-sdk-sample/libs/kaa folder and unzip the generated SDK to that folder.

    Build C Kaa client

    If the build is successful, you will get the result on your screen as follows: 

    Build result

Building snappy package

To build a snap package, proceed as follows:

  1. Install snappy Ubuntu tools by executing the following commands either from Ubuntu or from the Kaa sandbox (in case you are using another OS). Building inside Kaa sandbox is preferable, because system upgrade step may harm your system.

    Install Snappy tools
  2. Create the correct folder structure. Refer to the official snappy Ubuntu Core documentation for details.

  3. Copy the previously built Kaa client to the snappy-kaa/bin directory.

  4. Create the package.yaml file in the snappy-kaa/meta directory with the following context.

  5. Create the readme.md file in the snappy-kaa/meta directory with the following context.

  6. Build a snap package from the snappy-kaa directory.

    Build snappy package

    As a result, you should get the kaa_0.0.1_all.snap file.

    Known issue: your readme.md should contain at least two lines of text or package build will silently fail. this is some kind of undocumented behavior.    

Installing snappy Ubuntu

To locally deploy snappy Ubuntu, run the following commands.

Deploy Snappy ubuntu

As a result, you should be connected to your snappy Ubuntu box.

Installing sample Kaa client on snappy Ubuntu

To install the previously built sample Kaa client on snappy Ubuntu, proceed as follows:

  1. From the snappy Ubuntu shell, copy kaa_0.0.1_all.snap from your host machine.

    Get and install snap package
  2. Start the Kaa client on the snappy Ubuntu box.

    Start Kaa client

    As a result, you should get the logs similar to the following:

Further reading

To learn more about snappy Ubuntu Core, visit the official Ubuntu web site.

To learn more about Kaa, look at the following guides and references.


What it is for

Getting started

Use it to quickly create your first Kaa application.

Design reference 

Use this reference to learn about features and capabilities of Kaa (Endpoint profilingEventsNotificationsLogging, and other features).

Programming guide

Use this guide to create your own Kaa applications.

Copyright © 2014-2015, CyberVision, Inc.

  • No labels