mirror of https://github.com/vee1e/kubeedge - Kubernetes Native Edge Computing Framework (project under CN
Find a file
2019-01-25 16:50:33 +08:00
.circleci add ut in CI and make it pass 2018-11-15 10:14:31 +08:00
beehive change import path for 'go get' 2018-11-13 09:45:49 +08:00
cmd change import path for 'go get' 2018-11-13 09:45:49 +08:00
conf Merge pull request #15 from islinwb/adapt_for_IEF 2018-11-15 15:04:37 +08:00
docs add flow chart for messages handled by eventbus 2019-01-25 16:50:33 +08:00
example initialize directories 2018-10-26 10:06:46 +08:00
hack GOPATH can be empty, it will cause unclear error like "directory not found", so give explicit error 2018-12-26 18:12:27 +08:00
mocks Added UT for metaManager, corresponding Mocks and FeedbackError in msg_processor 2018-12-27 11:58:54 +05:30
pkg scripts: used table driven tests for meta_test.go 2019-01-04 14:07:51 +05:30
test change import path for 'go get' 2018-11-13 09:45:49 +08:00
vendor Added Vendor packages 2019-01-02 10:07:34 +05:30
CONTRIBUTING.md add contributing.md 2018-12-28 11:01:52 +08:00
Gopkg.lock Added Vendor packages 2019-01-02 10:07:34 +05:30
Gopkg.toml Added Vendor packages 2019-01-02 10:07:34 +05:30
LICENSE Initial commit 2018-09-28 16:57:50 +08:00
Makefile add hack/verify.sh and add verify in Makefile 2018-11-09 19:25:59 +08:00
README.md docs: fixed spelling mistakes in README 2019-01-08 14:33:46 +05:30

KubeEdge

Go Report Card LICENSE Releases

KubeEdge is an open source system extending native containerized application orchestration and device management to hosts at Edge. It is built upon Kubernetes and provides core infrastructure support for network, app. deployment and metadata synchronization between cloud and edge. It also supports MQTT and allows developers to author customer logic and enable resource constraint devices communication at Edge.

Advantages

Edge Computing

With business logic running at Edge, volumes of data can be secured & processed locally. It reduces the bandwidth request between Edge and Cloud; increases the response speak; and protects customers' data privacy.

Simplify development

Developers can write regular http or mqtt based applications; containerize and run anywhere at Edge or Cloud.

Kubernetes-native support

With KubeEdge, users can orchestrate apps, manage devices and monitor app/device status against Edge nodes like a normal K8s cluster in the Cloud

Abundant applications

You can easily get and deploy complicated machine learning, image recognition, event processing and other high level applications to your Edge side.

Introduction

KubeEdge is composed of these components:

  • Edged: Edged is an agent running on edge node for managing user's application.
  • EdgeHub: EdgeHub is a web socket client, which is responsible for interacting with Huawei Cloud IEF service, including sync cloud side resources update, report edged side host and device status changes.
  • EventBus: EventBus is a MQTT client to interact with MQTT server(mosquitto), offer subscribe and publish capability to other components.
  • DeviceTwin: DeviceTwin is responsible for storing device status and syncing device status to the cloud. It also provides query interfaces for applications.
  • MetaManager: MetaManager is the message processor and between edged and edgehub. It's also responsible for storing/retrieving metadata to/from a lightweight database(SQLite).

Architecture

Roadmap

Release 1.0

KubeEdge will provide the fundamental infrastructure and basic functionalities for IOT/Edge workload. This includes:

  • K8s Application deployment through kubectl from Cloud to Edge node(s)
  • K8s configmap, secret deployment through kubectl from Cloud to Edge node(s) and their applications in Pod
  • Bi-directional and multiplex network communication between Cloud and edge nodes
  • K8s Pod and Node status querying with kubectl at Cloud with data collected/reported from Edge
  • Edge node autonomy when its getting offline and recover post reconnection to Cloud
  • Device twin and MQTT protocol for IOT devices talking to Edge node

Release 2.0 and Future

  • Build service mesh with KubeEdge and Istio
  • Enable function as a service at Edge
  • Support more types of device protocols to Edge node such as AMQP, BlueTooth, ZigBee, etc.
  • Evaluate and enable super large scale of Edge clusters with thousands of Edge nodes and millions of devices
  • Enable intelligent scheduling of apps. to large scale of Edge nodes
  • etc.

Usage

Prerequisites

To use KubeEdge, you need make sure have mosquitto(as MQTT broker) and docker in your environment, if don't have, please reference the following step to install docker and mosquitto.

Install docker

For ubuntu:

# Install Docker from Ubuntu's repositories:
apt-get update
apt-get install -y docker.io

# or install Docker CE 18.06 from Docker's repositories for Ubuntu or Debian:
apt-get update && apt-get install apt-transport-https ca-certificates curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | apt-key add -
add-apt-repository \
   "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
   $(lsb_release -cs) \
   stable"
apt-get update && apt-get install docker-ce=18.06.0~ce~3-0~ubuntu

For centOS:

# Install Docker from CentOS/RHEL repository:
yum install -y docker

# or install Docker CE 18.06 from Docker's CentOS repositories:
yum install yum-utils device-mapper-persistent-data lvm2
yum-config-manager \
    --add-repo \
    https://download.docker.com/linux/centos/docker-ce.repo
yum update && yum install docker-ce-18.06.1.ce

Install mosquitto

For ubuntu:

apt install mosquitto

For centOS:

yum install mosquitto

See mosquitto official website for more information.

Build

Clone kube-edge

git clone https://github.com/kubeedge/kubeedge.git $GOPATH/src/github.com/kubeedge/kubeedge
cd $GOPATH/src/github.com/kubeedge/kubeedge
make # or `make edge_core`

Integrate with HuaweiCloud Intelligent EdgeFabric (IEF)

Note: The HuaweiCloud IEF is only available in China now.

  1. Create an account in HuaweiCloud.
  2. Go to IEF and create an Edge node.
  3. Download the node configuration file (<node_name>.tar.gz).
  4. Run bash -x hack/setup_for_IEF.sh /PATH/TO/<node_name>.tar.gz to modify the configuration files in conf/.

Run

# run mosquitto
mosquitto -d -p 1883

# run edge_core
# `conf/` should be in the same directory as the binary
./edge_core
# or
nohup ./edge_core > edge_core.log 2>&1 &

If you are using HuaweiCloud IEF, then the edge node you created should be running (check it in the IEF console page).

Community

Slack channel:

kubeedge.slack.com

Users can join this channel by clicking the invitation link.

Documentation

Please find link for detailed information about individual modules of KubeEdge.

Support

If you need support, start with the [troubleshooting guide], and work your way through the process that we've outlined.

That said, if you have questions, reach out to us, feel free to reach out to these folks:

  • @m1093782566
  • @islinwb
  • @Lion-Wei