Getting Started

KubeEdge is an open source system for extending native containerized application orchestration capabilities to hosts at Edge.

In this quick-start guide, we will explain:

• How to ask questions, build and contribute to KubeEdge.
• A few common ways of deploying KubeEdge.
• Links for further reading.

Choose an installation method

KubeEdge provides two common installation approaches: using keadm and installing from binaries manually.

• keadm is recommended for most users who want a simpler and more automated installation experience.
• Binary installation is more suitable for users who need more flexibility and full control over binary placement, configuration files, and service setup.

Method	Best for	Automation	Configuration and service setup
keadm	quick start, evaluation, and standard deployments	higher	mostly handled by keadm
binary installation	custom environments, development, and debugging	lower	managed manually

Dependencies

For cloud side, we need:

• Kubernetes cluster

For edge side, we need:

• Container runtimes, now we support:
  • Docker
  • Containerd
  • Cri-o
  • Virtlet
• MQTT Server(Optional)

Get KubeEdge!

You can find the latest KubeEdge release here.

During release, we build tarballs for major platforms and release docker images in kubeedge dockerhub.

Deploying KubeEdge

Check setup docs.

Contributing

Contributions are very welcome! See our CONTRIBUTING.md for more information.

Community

KubeEdge is an open source project and we value and welcome new contributors and members of the community. Here are ways to get in touch with the community:

• Mailing list
• Slack
• Twitter
• GitHub Issues