README.md

Eclipse Kura™

What is Eclipse Kura™?

From the maori word for tank/container, Eclipse Kura™ is a versatile software framework designed to supercharge your edge devices. With an intuitive web interface, Eclipse Kura™ streamlines the process of configuring your gateway, connecting sensors, and IoT devices to seamlessly collect, process, and send data to the cloud. Eclipse Kura™ provides an extensible Java API for developing custom plugins within the framework. Additionally, it offers a REST API, enabling the use of Eclipse Kura™ as a backend service in your application.

Eclipse Kura™ runs on an edge gateway, which can be anything from a small SBC(single-board computer) like a Raspberry Pi, or a powerful high-performance computer.

What can Eclipse Kura™ do for me?

• Kura™ Services: Provision and set up features to run on your gateway, such as an MQTT broker.
• Kura™ Networking: Manage Network connectivity, including
• Kura™ Wires: Design data flows and data processing streams effortlessly with a drag-and-drop visual editor.
• Kura™ Cloud Connectors: Extendable cloud connector system.
• Kura™ Drivers: Extendable service that handles reading data off of external devices.
• Kura™ Snapshots: Securely store and re-apply gateway settings for convenience.
• Kura™ Security: Easily and safely store your secrets.
• Kura™ Container Orchestrator: Manage Docker or Podman containers on your gateway for ultimate flexibility.
• Kura™ AI Inference: Run Nvidia Triton Models on the edge.
• Kura™ Plugins: Add and Extend the framework by adding your own Services, and Drivers.
• Kura™ REST Service: Embed the framework as a backend in your own edge applications.

I have used Eclipse Kura™ to make a small-scale Edge deployment, how do I scale now?

If you want to scale, and manage many instances of Eclipse Kura™, check out Eclipse Kapua™. Eclipse Kapua™ is a Eclipse Kura™ compatible cloud command and control service that allows you to aggregate data and configure many Eclipse Kura™ devices.

Documentation

• User Documentation: here you'll find information on how to use Eclipse Kura™ i.e. installation instructions, informations on how to use the web UI and tutorials.
• Developer Documentation: the Eclipse Kura™ Github Wiki serves as a reference for developers who want to contribute to the Eclipse Kura™ project and/or develop new add-ons. Here you'll find Eclipse Kura™ development/release model, guidelines on how to import internal packages, creating new bundles and development environment tips & tricks.
• Docker Containers Documentation: the Eclipse Kura™ team also provides Docker containers for the project. Information on how to build and run them are available at the project's Docker Hub page.
• Developer Quickstart Guide: a quick guide on how to setup the development environment and build the project is also provided in this README.

Additionally, we provide two channels for reporting any issue you find with the project

• Github Issues: for bug reporting.
• Github Discussions: for receiving feedback, asking questions, making new proposals and generally talking about the project.

Install

Eclipse Kura™ is compatible with Java 17.

Target Gateways Installers

Eclipse Kura™ provides pre-built installers for common development boards. Check the following link to download the desired installers. Take a look at our documentation for further information on supported platforms and installer types.

Docker Image

Eclipse Kura™ is also available as a Docker container.

Build

Prerequisites

In order to be able to build Eclipse Kura™ on your development machine, you need to have the following programs installed in your system:

• JDK 17
• Maven 3.5.x

Installing Prerequisites in Mac OS

To install Java 17, download the JDK tar archive from the Adoptium Project Repository.

Once downloaded, copy the tar archive in /Library/Java/JavaVirtualMachines/ and cd into it. Unpack the archive with the following command:

sudo tar -xzf <archive-name>.tar.gz

The tar archive can be deleted afterwards.

Depending on which terminal you are using, edit the profiles (.zshrc, .profile, .bash_profile) to contain:

export JAVA_HOME=/Library/Java/JavaVirtualMachines/<archive-name>/Contents/Home

Reload the terminal and run java -version to make sure it is installed correctly.

Using Brew you can easily install Maven from the command line:

brew install [email protected]

Run mvn -version to ensure that Maven has been added to the PATH. If Maven cannot be found, try running brew link [email protected] --force or manually add it to your path with:

export PATH="/usr/local/opt/[email protected]/bin:$PATH"

Installing Prerequisites in Linux

For Java

sudo apt install openjdk-17-jdk

For Maven

You can follow the tutorial from the official Maven site. Remember that you need to install the 3.5.x version.

Build Eclipse Kura™

Change to the new directory and clone the Eclipse Kura™ repo:

git clone -b develop https://github.com/eclipse/kura.git

Move inside the newly created directory and build the target platform:

mvn -f target-platform/pom.xml clean install

Build the core components:

mvn -f kura/pom.xml clean install

Build the examples (optional):

mvn -f kura/examples/pom.xml clean install

Build the target profiles:

mvn -f kura/distrib/pom.xml clean install -DbuildAll

Tip

You can skip tests by adding -Dmaven.test.skip=true in the commands above and you can compile a specific target by specifying the profile (e.g. -Pgeneric-aarch64).

Build scripts

Alternatively, you can use the build scripts available in the root directory.

./build-all.sh

Building Eclipse Kura™ Containers

The Eclipse Kura™ container build process currently only supports x86 containers. Following the instructions below will build two containers. One based on Alpine Linux kura-alpine-x86_64, and another on Ubi8 kura-ubi8-x86_64.

Build Eclipse Kura™ as per our instructions. To build the containers you'll need to change the target of the "Build the target profiles" step like the following:

mvn -f kura/distrib/pom.xml clean install -DbuildAllContainers

Note

This build step requires 'docker' to be a executable command on your system. For Instance, if you are using Podman please follow the Emulating Docker Cli Guide before running the command above.

After this command completes, images can be found in your preferred container engine image list.

IDE Setups

We currently support two setups for Eclipse Kura™ development:

• Eclipse Kura™ Development Environment Setup: This is the full setup allowing you to contribute to the core Eclipse Kura™ project codebase. It will install all the IDE plugins and formatters to have a pleasant development experience and clone the Eclipse Kura™ source code on your workstation.
• Add-on Development Environment Setup: This setup will allow you to develop applications or bundles running on Eclipse Kura™. It will install only the APIs and the examples and is best suited for developing Eclipse Kura™ add-ons.

Contributing

Contributing to Eclipse Kura™ is fun and easy! To start contributing you can follow our guide here.

Acknowledgments

Thanks to YourKit for providing us an open source license of YourKit Java Profiler!

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.