Skip to content

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

Open
poox41 wants to merge 1 commit into
kubeedge:masterfrom
poox41:docs/clarify-keadm-prerequisites
Open

docs: clarify Kubernetes and runtime prerequisites before installing KubeEdge#785
poox41 wants to merge 1 commit into
kubeedge:masterfrom
poox41:docs/clarify-keadm-prerequisites

Conversation

@poox41
Copy link
Copy Markdown

@poox41 poox41 commented Apr 14, 2026

What this PR does

This PR improves the installation documentation by clarifying that installing KubeEdge does not automatically install Kubernetes or the container runtime.

Why this is needed

New users may misunderstand keadm as a tool that provisions a full Kubernetes environment together with KubeEdge. In practice, Kubernetes and the runtime environment must be prepared separately before installing KubeEdge.

Changes made

  • clarified the scope of keadm in the installation documentation
  • added a reminder that Kubernetes and the runtime environment must be prepared before installation
  • improved the getting started documentation to reduce this misunderstanding

Issue

Fixes #6679

…KubeEdge

Signed-off-by: xiongkai <xiongkai@qq.com>
@kubeedge-bot
Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign kevin-wangzefeng after the PR has been reviewed.
You can assign the PR to them by writing /assign @kevin-wangzefeng in a comment when ready.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubeedge-bot kubeedge-bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Apr 14, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation to clarify that KubeEdge requires a pre-existing Kubernetes and container runtime environment before installation. Feedback suggests consolidating redundant information in the keadm setup guide and adding a link to the runtime prerequisites in the getting started guide for better consistency and usability.

Comment on lines +6 to +10
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.
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.

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.


## 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.
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.

Copy link
Copy Markdown
Contributor

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

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

this PR includes the similar change with #784. can you merge the PR into one? actually, this PR does not really make sense to me though.

Comment on lines +6 to +10
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.
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants