kubeedge / kubeedge/examples

[Tracking] Examples Repository Maintenance: Status of All Demos on KubeEdge v1.22+

Open
#166 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
269
Forks
174
PR merge metrics
No merged PRs in 30d

Description

After testing most examples against **KubeEdge v1.22** (latest stable as of April 2026), many demos are outdated or broken.

This issue serves as a **central tracking board** so community members can easily see the current status of each example, know which ones are already being worked on, and pick up examples that still need help.

**Goal:**
- Improve user experience (examples should work out-of-the-box)
- Reduce maintenance burden
- Encourage community contributions through clear visibility

## Status Legend

| Symbol | Meaning |
|--------|---------|
| ✅ | Works without issues on KubeEdge v1.22 |
| 🛠️ | Outdated but fixed (or fix in progress) |
| ⛔ | Requires special hardware (hard to verify) |
| ‼️ | requires complete refactoring |

## Current Status Table

| Example | Status on v1.22 | Handled By / PR | Main Issues |
|--------------------------------------|-----------------|-----------------|--------------------------------------------------|
| **temperature-sensor-demo** | ✅ | - | - |
| **new-counter-demo** | ✅ | - | - |
| **sound-equipment-fault-detection** | 🛠️ | - | Minor build issues (Dockerfile, GOPROXY, image import) |
| **traffic-light** | ‼️ | GaoFeng | MUST be refractory with mapper framework |
| **apache-beam-analysis** | ‼️ | - | No source code, only pre-built images |
| **ke-twitter-demo** | ‼️ | - | Twitter/X API v1.1 completely deprecated and MUST be refractory with mapper framework |
| **kubeedge-counter-demo** | ‼️ | GaoFeng | MUST be refractory with mapper framework |
| **web-demo** | ‼️ | - | MUST be refractory with mapper framework |
| **wechat-demo** | ‼️ | - | WeChat API changes + MUST be refractory with mapper framework |
| **kubeedge-edge-ai-application** | ⛔ | - | Hardware dependent |
| **led-raspberrypi** | ‼️ | GaoFeng | MUST be refractory with mapper framework |
| **security-demo** | ‼️ | - | SPIRE-focused, not a typical KubeEdge demo |
| **temperature-demo** |‼️ | - | MUST be refractory with mapper framework |
| **bluetooth-CC2650-demo** | ⛔ | - | Hardware dependent + no source code |

## How to Contribute

- Comment below with the example name you want to work on (e.g. `"I'll take web-demo"` or `"Working on ke-twitter-demo"`).
- Once you start, update the **"Handled By / PR"** column in this table (you can edit the issue description or ask a maintainer to update it).
- Reference this issue in your Pull Request.
- If an example already shows a PR link or "In progress", please coordinate with the person working on it to avoid duplicate effort.

## Advice
I suggest removing the old and outdated examples from the KubeEdge examples repository, as they are useless and incompatible with the modern architecture of KubeEdge. Keeping them will cause confusion for developers, for example in Issue #5758 (https://github.com/kubeedge/kubeedge/issues/5758), where other users have also been confused by these examples.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Current Status Table and choose one unhandled example; inspect that example's source, Dockerfile, and dependencies against KubeEdge v1.22. Coordinate in the issue before starting, since several examples are already assigned or require major refactoring. Done means the selected example's status and ownership are updated with a verified fix, refactoring plan, or documented hardware limitation.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, go
Domain
developer-experience, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.