1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
# KubeEdge
[](https://travis-ci.org/kubeedge/kubeedge)
[](https://goreportcard.com/report/github.com/kubeedge/kubeedge)
[](https://github.com/kubeedge/kubeedge/blob/master/LICENSE)
[](https://github.com/kubeedge/kubeedge/releases)
[](https://kubeedge.readthedocs.io/en/latest/?badge=latest)
<img src="./docs/images/KubeEdge_logo.png">
KubeEdge is an open source system extending native containerized application orchestration and device management to hosts at the Edge. It is built upon Kubernetes and provides core infrastructure support for networking, application deployment and metadata synchronization between cloud and edge. It also supports **MQTT** and allows developers to author custom logic and enable resource constrained device communication at the Edge. KubeEdge consists of a cloud part and an edge part.
## Advantages
#### Edge Computing
With business logic running at the Edge, much larger volumes of data can be secured & processed locally where the data is produced. Edge nodes can run autonomously which effectively reduces the network bandwidth requirements and consumptions between Edge and Cloud. With data processed at the Edge, the responsiveness is increased dramatically and data privacy is protected.
#### Simplified development
Developers can write regular http or mqtt based applications, containerize them, and run them anywhere - either at the Edge or in the Cloud - whichever is more appropriate.
#### Kubernetes-native support
With KubeEdge, users can orchestrate apps, manage devices and monitor app and device status on Edge nodes just like a traditional Kubernetes cluster in the Cloud. Locations of edge nodes are transparent to customers.
#### Abundant applications
It is easy to get and deploy existing complicated machine learning, image recognition, event processing and other high level applications to the Edge.
## Introduction
KubeEdge is composed of the following components:
### Cloud Part
- [CloudHub](https://github.com/kubeedge/kubeedge/blob/master/docs/modules/cloud/cloudhub.md): a web socket server responsible for watching changes at the cloud side, caching and sending messages to EdgeHub.
- [EdgeController](https://github.com/kubeedge/kubeedge/blob/master/docs/modules/cloud/controller.md): an extended kubernetes controller which manages edge nodes and pods metadata so that the data can be targeted to a specific edge node.
- [DeviceController](https://github.com/kubeedge/kubeedge/blob/master/docs/modules/cloud/device_controller.md): an extended kubernetes controller which manages devices so that the device metadata/status data can be synced between edge and cloud.
### Edge Part
- [EdgeHub](https://github.com/kubeedge/kubeedge/blob/master/docs/modules/edge/edgehub.md): a web socket client responsible for interacting with Cloud Service for the edge computing (like Edge Controller as in the KubeEdge Architecture). This includes syncing cloud-side resource updates to the edge, and reporting edge-side host and device status changes to the cloud.
- [Edged](https://github.com/kubeedge/kubeedge/blob/master/docs/modules/edge/edged.md): an agent that runs on edge nodes and manages containerized applications.
- [EventBus](https://github.com/kubeedge/kubeedge/blob/master/docs/modules/edge/eventbus.md): a MQTT client to interact with MQTT servers (mosquitto), offering publish and subscribe capabilities to other components.
- ServiceBus: a HTTP client to interact with HTTP servers (REST), offering HTTP client capabilities to components of cloud to reach HTTP servers running at edge.
- [DeviceTwin](https://github.com/kubeedge/kubeedge/blob/master/docs/modules/edge/devicetwin.md): responsible for storing device status and syncing device status to the cloud. It also provides query interfaces for applications.
- [MetaManager](https://github.com/kubeedge/kubeedge/blob/master/docs/modules/edge/metamanager.md): the message processor between edged and edgehub. It is also responsible for storing/retrieving metadata to/from a lightweight database (SQLite).
### Architecture
<img src="./docs/images/kubeedge_arch.png">
## Compatibility matrix
### Kubernetes compatibility
| | Kubernetes 1.11 | Kubernetes 1.12 | Kubernetes 1.13 | Kubernetes 1.14 | Kubernetes 1.15 | Kubernetes 1.16 | Kubernetes 1.17 |
|------------------------|-----------------|-----------------|-----------------|-----------------|-----------------|-----------------|-----------------|
| KubeEdge 1.0 | ✓ | ✓ | ✓ | ✓ | ✓ | - | - |
| KubeEdge 1.1 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| KubeEdge 1.2 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| KubeEdge HEAD (master) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
Key:
* `✓` KubeEdge and the Kubernetes version are exactly compatible.
* `+` KubeEdge has features or API objects that may not be present in the Kubernetes version.
* `-` The Kubernetes version has features or API objects that KubeEdge can't use.
### Golang dependency
| | Golang 1.10 | Golang 1.11 | Golang 1.12 | Golang 1.13 |
|-------------------------|----------------|-----------------|-----------------|-----------------|
| KubeEdge 1.0 | ✓ | ✓ | ✓ | ✗ |
| KubeEdge 1.1 | ✗ | ✗ | ✓ | ✗ |
| KubeEdge 1.2 | ✗ | ✗ | ✓ | ✓ |
| KubeEdge HEAD (master) | ✗ | ✗ | ✓ | ✓ |
## To start developing KubeEdge
The [set up] hosts all information about building KubeEdge from source, how to setup. etc.
To build KubeEdge from source there is one option:
##### You have a working [Go environment].
```
mkdir -p $GOPATH/src/github.com/kubeedge
cd $GOPATH/src/github.com/kubeedge
git clone git@github.com:kubeedge/kubeedge.git
# If you only want to compile quickly without using go mod, please set GO111MODULE=off (e.g. export GO111MODULE=off)
cd kubeedge
make
```
## Usage
* [Install KubeEdge](./docs/setup/kubeedge_install.md)
* [Configure KubeEdge](./docs/setup/kubeedge_configure.md)
* [Deploy Application and Run Tests](./docs/setup/kubeedge_precheck.md)
## Roadmap
* [2019 Q4 Roadmap](./docs/getting-started/roadmap.md#2019-q4-roadmap)
## Meeting
Regular Community Meeting: Wednesday at 16:30 Beijing Time (biweekly).
- [Meeting notes and agenda](https://docs.google.com/document/d/1Sr5QS_Z04uPfRbA7PrXr3aPwCRpx7EtsyHq7mp6CnHs/edit)
- [Meeting recordings](https://www.youtube.com/playlist?list=PLQtlO1kVWGXkRGkjSrLGEPJODoPb8s5FM)
- [Meeting link](https://zoom.us/j/4167237304)
- [Meeting Calendar](https://calendar.google.com/calendar/embed?src=8rjk8o516vfte21qibvlae3lj4%40group.calendar.google.com) | [Subscribe](https://calendar.google.com/calendar?cid=OHJqazhvNTE2dmZ0ZTIxcWlidmxhZTNsajRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ)
## Documentation
The detailed documentation for KubeEdge and its modules can be found at [https://docs.kubeedge.io](https://docs.kubeedge.io).
Some sample applications and demos to illustrate possible use cases of KubeEdge platform can be found at this [examples](https://github.com/kubeedge/examples) repository.
## Contact
<!--
We don't have a troubleshooting guide yet. When we do, uncomment the following and add the link.
If you need support, start with the [troubleshooting guide], and work your way through the process that we've outlined.
-->
If you have questions, feel free to reach out to us in the following ways:
- [mailing list](https://groups.google.com/forum/#!forum/kubeedge)
- [slack](https://join.slack.com/t/kubeedge/shared_invite/enQtNjc0MTg2NTg2MTk0LWJmOTBmOGRkZWNhMTVkNGU1ZjkwNDY4MTY4YTAwNDAyMjRkMjdlMjIzYmMxODY1NGZjYzc4MWM5YmIxZjU1ZDI)
- [twitter](https://twitter.com/kubeedge)
## Contributing
If you're interested in being a contributor and want to get involved in
developing the KubeEdge code, please see [CONTRIBUTING](CONTRIBUTING.md) for
details on submitting patches and the contribution workflow.
## License
KubeEdge is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.
[set up]: docs/setup/kubeedge_install.md
[Go environment]: https://golang.org/doc/install
|
