docs: clarify differences between binary installation and keadm installation#784
docs: clarify differences between binary installation and keadm installation#784poox41 wants to merge 1 commit intokubeedge:masterfrom
Conversation
…llation Signed-off-by: xiongkai <xiongkai@qq.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome @poox41! It looks like this is your first PR to kubeedge/website 🎉 |
kubeedge-bot
added
the
size/S
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request enhances the KubeEdge documentation by adding guidance on choosing between 'keadm' and binary installation methods, including a new comparison table in the getting started guide. The review feedback identifies a formatting issue with an unnecessary line break in the keadm installation document and a capitalization inconsistency within the comparison table.
| 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). |
There was a problem hiding this comment.
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.
| 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). |
There was a problem hiding this comment.
i second this, maybe this is just mistyping.
| | 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 | |
There was a problem hiding this comment.
For consistency with the bullet points above (line 18) and the row above in the table, "Binary installation" should be capitalized.
| | binary installation | custom environments, development, and debugging | lower | managed manually | | |
| | Binary installation | custom environments, development, and debugging | lower | managed manually | |
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
i am not necessarily against this PR, but i would suggest to avoid the duplication.
| 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). |
There was a problem hiding this comment.
i second this, maybe this is just mistyping.
| ## 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 | |
There was a problem hiding this comment.
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?
3 participants
What this PR does
This PR improves the installation documentation by clarifying the differences between binary installation and keadm installation.
Why this is needed
New users may be confused about which installation method to choose, since the two approaches differ in automation level, setup flow, and service/configuration management.
Changes made
keadmRelated issue
Fixes #6688