README
¶
中文 | English
Kubernetes native IoT Gateway
Shifu is a Kubernetes native, production-grade, protocol & vendor agnostic IoT gateway.
Features
Kubernetes native — developing your application while managing your devices, spare the need for maintaining an additional O&M infrastructure.
Open Platform — No vendor lock-in. You can easily deploy Shifu on the edge(from RaspberryPi to edge clusters) or on the cloud(public, private and hybrid cloud are all supported).
Protocol agnostic — HTTP, MQTT, RTSP, Siemens S7, TCP socket, OPC UA...The microservice architecture of Shifu enables it to quickly adapt to new protocols.
Terms
shifu - a Kubernetes CRD for integrating IoT devices into the cluster.
DeviceShifu - a Kubernetes pod as well as the atomic unit of Shifu. DeviceShifu mainly contains the driver of the device and represents a device in the cluster. Or you can call it "digital twin" of the device.
How to connect a proprietary-protocol camera with five lines of code
Community
Welcome to the Shifu community to share your thoughts and ideas! Any suggestion will be deeply valued. We couldn't be more excited to have you.
Get Started
Welcome to check 🗒️Shifu Documentation for detailed information on:
Contributing
Feel free to create an issue or submit a pull request!
We will forever be grateful to all the contributors.
Shifu is officially a CNCF landscape project
Stargazers over time
License
This project is distributed under Apache 2.0 License.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
examples
|
|
|
tcpDeviceShifu/server
start a TCP server, log all coming requests and echo back for test purpose
|
start a TCP server, log all coming requests and echo back for test purpose |
|
pkg
|
|
|
deviceshifu/deviceshifutemplate
Barebone deviceshifu source code.
|
Barebone deviceshifu source code. |
|
k8s/api/v1alpha1
Package v1alpha1 contains API Schema definitions for the shifu v1alpha1 API group +kubebuilder:object:generate=true +groupName=shifu.edgenesis.io
|
Package v1alpha1 contains API Schema definitions for the shifu v1alpha1 API group +kubebuilder:object:generate=true +groupName=shifu.edgenesis.io |