Skip to content

docs: clarify differences between binary installation and keadm installation #784

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
+27 −2
Open

docs: clarify differences between binary installation and keadm installation #784

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
8 changes: 7 additions & 1 deletion docs/setup/install-with-binary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@
title: Installing KubeEdge with Binary
sidebar_position: 4
---
Deploying KubeEdge with binary is used to test, never use this way in production environment.
Binary installation is mainly intended for testing and development, and is generally not recommended for production environments.

## When to choose binary installation

Binary installation is more suitable for advanced users who want full control over binary placement, configuration files, and service management. It is usually a better fit for custom environments, development, debugging, or cases where users do not want to rely on `keadm`.

Compared with `keadm`, binary installation provides more flexibility, but it also requires more manual setup.

## Limitation

Expand Down
9 changes: 8 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,14 @@ 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 handle the installation of Kubernetes and its
[runtime environment](https://kubeedge.io/docs/setup/prerequisites/runtime).
Comment on lines +6 to +7

@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 sentence is split across two lines, which introduces an unnecessary line break and a trailing space on line 6. It is recommended to keep this sentence on a single line for better readability and consistency with the rest of the documentation.

Suggested change
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 handle the installation of Kubernetes and its [runtime environment](https://kubeedge.io/docs/setup/prerequisites/runtime).

@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, maybe this is just mistyping.


## When to choose keadm

`keadm` is recommended for most users who want a simpler and more automated installation experience. It helps set up KubeEdge components in a more standardized way and is usually a better choice for quick start, evaluation, and standard deployments.

Compared with manual binary installation, `keadm` reduces the amount of manual work required for configuration and service setup.

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
12 changes: 12 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,18 @@ In this quick-start guide, we will explain:
- A few common ways of deploying KubeEdge.
- Links for further reading.

## Choose an installation method

KubeEdge provides two common installation approaches: using `keadm` and installing from binaries manually.

- **`keadm`** is recommended for most users who want a simpler and more automated installation experience.
- **Binary installation** is more suitable for users who need more flexibility and full control over binary placement, configuration files, and service setup.

| Method | Best for | Automation | Configuration and service setup |
| --- | --- | --- | --- |
| `keadm` | quick start, evaluation, and standard deployments | higher | mostly handled by `keadm` |
| binary installation | custom environments, development, and debugging | lower | managed manually |

@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

For consistency with the bullet points above (line 18) and the row above in the table, "Binary installation" should be capitalized.

Suggested change
| binary installation | custom environments, development, and debugging | lower | managed manually |
| Binary installation | custom environments, development, and debugging | lower | managed manually |

Comment on lines +13 to +23

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

for me, this is kind of duplication though. probably if we want to keep the notification like this, each page should not have the same note at all?


## Dependencies

For cloud side, we need:
Expand Down