Skip to content

docs: clarify Kubernetes and runtime prerequisites before installing KubeEdge #785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
poox41 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify Kubernetes and runtime prerequisites before installing KubeEdge #785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/setup/install-with-keadm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ title: Installing KubeEdge with Keadm
sidebar_position: 3
---

Keadm is used to install the cloud and edge components of KubeEdge. It does not handle the installation of Kubernetes and its [runtime environment](https://kubeedge.io/docs/setup/prerequisites/runtime).
Keadm is used to install the cloud and edge components of KubeEdge. It does not install Kubernetes or the [runtime environment](https://kubeedge.io/docs/setup/prerequisites/runtime). Before using `keadm`, make sure your Kubernetes cluster and runtime environment are already prepared.

## Important note

Installing KubeEdge with `keadm` does not install Kubernetes or the container runtime. `keadm` only installs KubeEdge components. Before running `keadm init` or `keadm join`, make sure Kubernetes and the runtime environment are already installed and working properly.
Comment on lines +6 to +10

@gemini-code-assist gemini-code-assist Bot Apr 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The information regarding Kubernetes and runtime prerequisites is repeated twice in the first few lines. Consolidating this into a single, clear note improves readability and reduces redundancy.

Suggested change
Keadm is used to install the cloud and edge components of KubeEdge. It does not install Kubernetes or the [runtime environment](https://kubeedge.io/docs/setup/prerequisites/runtime). Before using `keadm`, make sure your Kubernetes cluster and runtime environment are already prepared.
## Important note
Installing KubeEdge with `keadm` does not install Kubernetes or the container runtime. `keadm` only installs KubeEdge components. Before running `keadm init` or `keadm join`, make sure Kubernetes and the runtime environment are already installed and working properly.
Keadm is used to install the cloud and edge components of KubeEdge.
Note: keadm does not install Kubernetes or the [runtime environment](https://kubeedge.io/docs/setup/prerequisites/runtime). Before running keadm init or keadm join, make sure your Kubernetes cluster and container runtime are already installed and working properly.

@fujitatomoya fujitatomoya Apr 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i second this comment, this is pure duplication for user documentation.


Please refer to [Kubernetes compatibility](https://github.com/kubeedge/kubeedge#kubernetes-compatibility) documentation to check **Kubernetes compatibility** and ascertain the Kubernetes version to be installed.

Expand Down
4 changes: 4 additions & 0 deletions docs/welcome/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ In this quick-start guide, we will explain:
- A few common ways of deploying KubeEdge.
- Links for further reading.

## Before you begin

KubeEdge is installed on top of an existing Kubernetes environment. Installing KubeEdge does not automatically provision Kubernetes or the container runtime, so make sure they are prepared before installation.

@gemini-code-assist gemini-code-assist Bot Apr 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Adding a link to the runtime prerequisites page here would be consistent with the other installation documents and helpful for users who need to set up their environment.

Suggested change
KubeEdge is installed on top of an existing Kubernetes environment. Installing KubeEdge does not automatically provision Kubernetes or the container runtime, so make sure they are prepared before installation.
KubeEdge is installed on top of an existing Kubernetes environment. Installing KubeEdge does not automatically provision Kubernetes or the [container runtime](https://kubeedge.io/docs/setup/prerequisites/runtime), so make sure they are prepared before installation.


## Dependencies

For cloud side, we need:
Expand Down