README.md

LF Edge eKuiper - An edge lightweight IoT data analytics software

eKuiper is an open source stream processing engine for edge computing. The open source project is hosted by LF Edge.

It can be run at all kinds of resource constrained edge devices. One goal of eKuiper is to migrate the cloud streaming software frameworks (such as Apache Spark，Apache Storm and Apache Flink) to edge side. eKuiper references these cloud streaming frameworks, and also considered special requirement of edge analytics, and introduced rule engine, which is based on Source, SQL (business logic) and Sink, rule engine is used for developing streaming applications at edge side.

Understand eKuiper

Learn about eKuiper and its fundamental concepts.

• Why eKuiper
• Stream Processing Concept
• Rule Composition
• Source
• Sink
• Rule logic by SQL
• Extension

View Concepts

Try eKuiper

Follow tutorials to learn how to use eKuiper.

• Getting started locally
• Getting started in Docker
• Getting started by dashboard
• Run as EdgeX Foundry rule engine
• Deploy by OpenYurt

View Tutorials

Look up reference information

Refer to the syntax and properties.

• Rule Syntax
• Available Sources
• Available Sinks
• Available Functions
• SQL Reference

View Reference

Learn how to use eKuiper

Learn how to create and manage rules and how to modify configurations etc.

• Configuration
• Rest API
• CLI

View Operations

Develop extensions

Learn how to develop custom extensions.

• Native go plugin development
• Portable go plugin development
• Python plugin development

View Extension Programming

Get Help

If you get stuck, check out our community support resources.

• Open GitHub issue.

• Ask in the forum.

• Join our Slack, and then join ekuiper or ekuiper-user channel.

• Mail to eKuiper help mail list.

• Join WeChat group, scan the below QR code and mark "eKuiper".

  

Contribute

Anyone can contribute for anything, not just code.

• Edit Doc in GitHub
• How to contribute