kubeedge/website

KubeEdge website and documentation repo:

KubeEdge

English | 简体中文

KubeEdge is built upon Kubernetes and extends native containerized application orchestration and device management to hosts at the Edge. It consists of cloud part and edge part, provides core infrastructure support for networking, application deployment and metadata synchronization between cloud and edge. It also supports MQTT which enables edge devices to access through edge nodes.

With KubeEdge it is easy to get and deploy existing complicated machine learning, image recognition, event processing and other high level applications to the Edge. With business logic running at the Edge, much larger volumes of data can be secured & processed locally where the data is produced. With data processed at the Edge, the responsiveness is increased dramatically and data privacy is protected.

KubeEdge is an incubation-level hosted project by the Cloud Native Computing Foundation (CNCF). KubeEdge incubation announcement by CNCF.

Advantages

• Kubernetes-native support: Managing edge applications and edge devices in the cloud with fully compatible Kubernetes APIs.
• Cloud-Edge Reliable Collaboration: Ensure reliable messages delivery without loss over unstable cloud-edge network.
• Edge Autonomy: Ensure edge nodes run autonomously and the applications in edge run normally, when the cloud-edge network is unstable or edge is offline and restarted.
• Edge Devices Management: Managing edge devices through Kubernetes native APIs implemented by CRD.
• Extremely Lightweight Edge Agent: Extremely lightweight Edge Agent(EdgeCore) to run on resource constrained edge.

How It Works

KubeEdge consists of cloud part and edge part.

Architecture

In the Cloud

• CloudHub: a web socket server responsible for watching changes at the cloud side, caching and sending messages to EdgeHub.
• EdgeController: an extended kubernetes controller which manages edge nodes and pods metadata so that the data can be targeted to a specific edge node.
• DeviceController: an extended kubernetes controller which manages devices so that the device metadata/status data can be synced between edge and cloud.

On the Edge

• EdgeHub: 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: an agent that runs on edge nodes and manages containerized applications.
• EventBus: a MQTT client to interact with MQTT servers (mosquitto), offering publish and subscribe capabilities to other components.
• ServiceBus: an HTTP client to interact with HTTP servers (REST), offering HTTP client capabilities to components of cloud to reach HTTP servers running at edge.
• DeviceTwin: responsible for storing device status and syncing device status to the cloud. It also provides query interfaces for applications.
• MetaManager: the message processor between edged and edgehub. It is also responsible for storing/retrieving metadata to/from a lightweight database (SQLite).

Kubernetes compatibility

	Kubernetes 1.20	Kubernetes 1.21	Kubernetes 1.22	Kubernetes 1.23	Kubernetes 1.24	Kubernetes 1.25	Kubernetes 1.26	Kubernetes 1.27	Kubernetes 1.28	Kubernetes 1.29
KubeEdge 1.12	✓	✓	✓	-	-	-	-	-	-	-
KubeEdge 1.13	+	✓	✓	✓	-	-	-	-	-	-
KubeEdge 1.14	+	+	✓	✓	✓	-	-	-	-	-
KubeEdge 1.15	+	+	+	+	✓	✓	✓	-	-	-
KubeEdge 1.16	+	+	+	+	+	✓	✓	✓	-	-
KubeEdge 1.17	+	+	+	+	+	+	✓	✓	✓	-
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.

Guides

Get start with this doc.

See our documentation on kubeedge.io for more details.

To learn deeply about KubeEdge, try some examples on examples.

Roadmap

• 2024 Roadmap

Meeting

Regular Community Meeting:

• Europe Time: Wednesdays at 16:30-17:30 Beijing Time (biweekly, starting from Feb. 19th 2020). (Convert to your timezone.)
• Pacific Time: Wednesdays at 10:00-11:00 Beijing Time (biweekly, starting from Feb. 26th 2020). (Convert to your timezone.)

Resources:

• Meeting notes and agenda
• Meeting recordings
• Meeting link
• Meeting Calendar | Subscribe

Contact

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
• slack
• twitter

Contributing

If you're interested in being a contributor and want to get involved in developing the KubeEdge code, please see CONTRIBUTING for details on submitting patches and the contribution workflow.

Security

Security Audit

A third party security audit of KubeEdge has been completed in July 2022. Additionally, the KubeEdge community completed an overall system security analysis of KubeEdge. The detailed reports are as follows.

• Security audit

• Threat model and security protection analysis paper

Reporting security vulnerabilities

We encourage security researchers, industry organizations and users to proactively report suspected vulnerabilities to our security team ([email protected]), the team will help diagnose the severity of the issue and determine how to address the issue as soon as possible.

For further details please see Security Policy for our security process and how to report vulnerabilities.

License

KubeEdge is under the Apache 2.0 license. See the LICENSE file for details.

website's Issues

Docs: add SeviceBus introduction

Ref kubeedge/kubeedge#1498

Add user guide about how to implement and use third party storage with CSI.

/kind documentation

Docs: add ServiceBus user guide

Ref kubeedge/kubeedge#1498

Add user guide about how to create HTTP services with ServiceBusI.

/kind documentation

update hugo

update hugo to last work version on this theme
/assign

Docs: add Admission user guide

Ref kubeedge/kubeedge#1498

Add user guide about how to Control resources on the edge with Admission.

/kind documentation

Code of conduct link broken

Describe the bug
The code of conduct link on the documentation site renders a 404 error when trying to access it

To Reproduce
Steps to reproduce the behavior:

1. Go to 'https://kubeedge.readthedocs.io/en/latest/getting-started/contribute.html#getting-started'
2. Click on 'code of conduct'
3. Scroll down to '....'
4. See error '404 this is the web page you looking for'

Expected behavior
The link to be accessible

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [Windows 10]
• Browser [chrome]

Additional context
Add any other context about the problem here.

Translate documents in content/ko to Korean

Is your feature request related to a problem? Please describe.
Translate.

Describe the solution you'd like
As version increased to v1.3, I'd like to change the Korean documentation of kubeedge.

update links

http=>https
/assign

update hugo to last version

https://github.com/kubeedge/website/blob/master/netlify.toml
/assign

Code snippet formatting

Don't include the command prompt
Do: mkdir -p /var/lib/kubeedge
Don't: $ mkdir -p /var/lib/kubeedge

Following the docs style guide of kubernetes

update favicons

https://realfavicongenerator.net/favicon_checker?protocol=https&site=kubeedge.io%2Fen%2F#.YkAdPufP23A
for all devices
/assign

fix Cloud Native logo on mobile & tablet

/assign

Accessibility add link name

/assign

Accessibility update social links

https://kubeedge.io/en/blog/release-v1.9/
/assign

DOCS：add software version/_index_zh.md

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Create a tutorials section

• Add tutorials on how to use both the edge and cloud.

• Add tutorials on how to to use kubeedge with Huawei IEF

• Add tutorial with any other cloud provider or orchestration tool.

Accessibility update "go to top"

arrow
/assign

Add CNCF/LF logo and trademark to the site footer

To prep for incubation, the site needs to follow CNCF website guidelines:

• Display the CNCF logo
• Display a trademark statement for the Linux Foundation

Support return the latest version number in the response when user curls the URL

Is your feature request related to a problem? Please describe.
If the user curls the URL the response should be return the latest version number, e.g.

#: curl https://kubeedge.io/latestversion
v1.4.0

Add Blog Section

• Add a blog section to the website.

• Add blog posts.

fix toggle menu on close

/assign

testing bot 111

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

wrong copyright date

/assign

Updating the kubeedge docs

Now we have lots of new features, we need add more docs for them.

Setup the Huawei CI-Bot on this repository.

"heterogeneous" misspelled on homepage

https://kubeedge.io has a tile that says KubeEdge is "heterogenous." The correct spelling is "heterogeneous." As written, it looks like "hetero" and "erogenous," which implies something entirely different.

Clicking on the Home link does not work

On the navigation menu, the Home link should take you to the home slide section of the home page.
Clicking on the menu item does not do anything.

**Automation**

Automatically move your cards to the right place based on the status and activity of your issues and pull requests.

Clicking on the Learn More button on home slider takes user to a different doc

The KubeEdge documentation is now moved to https://docs.kubeedge.io.
The Learn More About KubeEdge button on the home slider still points to older documentation.

Testing bot please ignore

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...' please ignore
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

The link in kubeedge website missed the '.md' suffix

Describe the bug
now the link in kubeedge website missed the '.md' suffix, Ref: page
But in github it works fine, in kubeedge.io missed '.md' , so lead to a 404 in kubeedge.io.

Noticed have a PR before related to this. #704

Expected behavior
The link works fine.

/cc @anvithks @yamt Could you please help take a look?

Dark mode information is not remembered by the website

Describe the bug
Dark mode information is not remembered by the website

To Reproduce
Steps to reproduce the behavior:

1. Open the webpage
2. Choose dark mode
3. Refresh the page
4. Dark mode is lost and the webpage fallsback to light mode

Expected behavior
When user chooses dark mode, then whenever the user comes back to the page, it has to be rendered in dark mode

Suggestion
you can use localStorage API of modern browsers to store and retrieve the theme information

localStorage.setItem('theme', 'dark')
localStorage.getItem('theme')

Developer onboarding documentation missing

What would you like to be added/modified: Currently this page is empty: https://kubeedge.io/en/docs/developer/build/

Why is this needed: It should describe pre-requisites and a basic development workflow for contributors

New theme and format for the website

Project Description

Redesign and reimplement the official website to show the key features of KubeEdge.

Difficulty

Medium

Mentor

Kevin Wang(@kevin-wangzefeng): [email protected]

Output

• New website styling
• Key values/features of KubeEdge highlighted in prominent position
• redundant content section removed in homepage
• add support for hosting multiple releases and multi-languages for documents
• add community information including partners, end users, success stories.

Tech. Requirement

• KubeEdge
• css
• website layout

Related Repo

• https://github.com/kubeedge/website

Translate documents in content/ko/home/ to Korean.

Is your feature request related to a problem? Please describe.
Translation.

Describe the solution you'd like
There is no Korean documents in this project.
I would like to translate documents in content/ko/home/ to Korean.

Describe alternatives you've considered
Not all documents can be translated at once, but I will continue to translate them step by step.

Additional context

Chinese (zh) Translation of website

The new website supports multiple languages.
The chinese content is maintained under the content/zh folder.
Some of the files are already translated using Google Translate but this may not be accurate.
We will need to do the following:

• Identify incorrect translations and fix them.

• Add missing translations

Docs: add CSI user guide

Ref kubeedge/kubeedge#1498

Add user guide about how to implement and use third party storage with CSI.

/kind documentation

Accessibility add link name

/assign

update content links

http=>https
/assign

Docs: add Device CRD user/developer guide

Ref kubeedge/kubeedge#1498

Add guide about how to implement/use Device CRD.

/kind documentation

Add twitter feed and tweets section

• Add a twitter feed that shows engagement with the official twitter handle.

Docs: add Mapper developer guide

Ref kubeedge/kubeedge#1498

Add developer guide about how to implement mapper.

/kind documentation

Update Academic theme to latest version v4.1.0

Update docs/

Is your feature request related to a problem? Please describe.

Now we use https://docs.kubeedge.io/en/latest/ rather than https://kubeedge.io/en/docs, while https://kubeedge.io/en/docs/ can be visited, and some docs are outdated like https://kubeedge.io/en/docs/getting-started-minikube/.

Describe the solution you'd like

Use git filter-branch to keep git log and sync docs from kubeedge/kubeedge/docs.

If no need to keep git log, just skip it.

Other problem is that need we keep two docs website?

@kevin-wangzefeng

Update docs about keadm install kubeedge

the docs of page https://kubeedge.io/en/docs/setup/keadm/ is out of date, we have move the keadm beta install cmds to GA, and the origin keadm init/join/reset cmds have been moved to keadm deprecated init/join/reset, we need to update instructions

ref:
https://github.com/kubeedge/kubeedge/blob/master/CHANGELOG/CHANGELOG-1.11.md#beta-sub-commands-in-keadm-to-ga
https://github.com/kubeedge/kubeedge/blob/master/CHANGELOG/CHANGELOG-1.11.md#deprecation-of-original-init-and-join
kubeedge/kubeedge#3900

/help
/good-first-issue

Create a demos section.

• Give the link to the demo repository.

• Provide a video of the demo.

• Update the demo documentation.

Update documentation section.

• Integration with readthedocs.io

• explore the option of retaining the website style and readthedocs style the same.

Accessibility add alt to image

/assign
Cloud Native Computing Foundation

Request to translation for Korean.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

I would like to translate these documents into Korean.

Can only contributors translate documents?

If not, please tell me the procedure to start translating Korean.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Netlify CI is using an unsupported image

Describe the bug
In #177, the CI is failing with the following error:

  UNSUPPORTED BUILD IMAGE

  The build image for this site uses Ubuntu 14.04 Trusty Tahr, which is no longer supported.

  To enable builds for this site, select a later build image at the following link:
  https://app.netlify.com/sites/privatekubeedge/settings/deploys#build-image-selection

  For more details, visit the build image migration guide:
  https://answers.netlify.com/t/end-of-support-for-trusty-build-image-everything-you-need-to-know/39004

social icons ui update

make one line
/assign