Welcome to KubeEdge’s documentation!

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

• KubeEdge Home

Getting Started

• Welcome to KubeEdge
  • Why KubeEdge?
  • First Steps
• Welcome
• Before you get started
  • Code of Conduct
  • Community Expectations
• Getting started
• Your First Contribution
  • Find something to work on
• Contributor Workflow
  • Creating Pull Requests
  • Code Review
  • Testing
• Roadmap
  • 2019 Q4 Roadmap
  • Future
• Support
  • Community
• KubeEdge Community Membership
  • Member
  • Approver
  • Maintainer
  • Owner
• Setup using Release package
  • Prerequisites
  • Cloud Vm
  • Edge Vm
• Reporting bugs

General Concepts

• What is KubeEdge
  • Advantages
  • Components
  • Architecture
  • Getting involved
• Beehive
  • Beehive Overview
  • Message Format
  • Register Module
  • Channel Context Structure Fields
  • Module Operations
  • Message Operations

Edge Concepts

• EdgeD
  • Overview
  • Pod Management
  • Pod Lifecycle Event Generator
  • CRI for edged
  • Secret Management
  • Probe Management
  • ConfigMap Management
  • Container GC
  • Image GC
  • Status Manager
  • Volume Management
  • MetaClient
• EventBus
  • Overview
  • Topic
  • Flow chart
• MetaManager
  • Overview
  • Insert Operation
  • Update Operation
  • Delete Operation
  • Query Operation
  • Response Operation
  • NodeConnection Operation
  • MetaSync Operation
• Edgehub
  • Overview
  • Keep Alive
  • Publish Client Info
  • Route To Cloud
  • Route To Edge
  • Usage
• DeviceTwin
  • Overview
  • Operations Performed By Device Twin Controller
  • Modules
  • Tables

Cloud Concepts

• Edge Controller
  • Edge Controller Overview
  • Operations Performed By Edge Controller
  • Downstream Controller:
  • Upstream Controller:
  • Controller Manager:
• CloudHub
  • CloudHub Overview
  • Usage
• Device Controller
  • Device Controller Overview
  • Operations Performed By Device Controller
  • Upstream Controller:
  • Downstream Controller:

Edgesite

• EdgeSite: Standalone Cluster at edge
  • Abstract
  • Motivation
  • Assumptions
  • Architecture Design
  • Advantages
  • Getting Started

Mappers

• Bluetooth Mapper
  • Introduction
  • Running the mapper
  • Modules
  • Usage
• Modbus Mapper
  • Introduction
  • Running the mapper
  • Modules

Setup

• Pre-requisites
  • Kubernetes
  • Mosquitto
  • Docker
• Setup KubeEdge from sourcecode
  • Abstract
  • Prerequisites
  • Run KubeEdge
  • Deploy Application on cloud side
  • Run Tests
• One Click Installer
  • Limitation
  • Downloading KubeEdge Installer
  • Building from source
  • Installing KubeEdge Master Node (on the Cloud) component
  • Installing KubeEdge Worker Node (at the Edge) component
  • Reset KubeEdge Master and Worker nodes
  • Simple steps to bring up KubeEdge setup and deploy a pod
  • Errata
• Cross Compiling KubeEdge
  • For ARM Architecture from x86 Architecture
• Measuring memory footprint of EdgeCore
  • Why measuring memory footprint
  • KPI’s measured
  • How to test
• Integrate with HuaweiCloud [Intelligent EdgeFabric (IEF)]
  • Intelligent EdgeFabric (IEF)

Guides

• MQTT Message Topics
  • Subscribe Topics
• Unit Test Guide
  • Unit Test
  • Mocks
  • Ginkgo
  • Writing UT using GoMock
• Device Management User Guide
  • Device Model
  • Device Instance
  • Device Mapper
  • Usage of Device CRD
• Edgemesh test env config guide
  • Docker support (recommended)
  • Containerd Support
  • Example for Edgemesh test env
  • Edgemesh end to end test guide

Troubleshooting

• FAQs