docs: add comprehensive keadm ctl command documentation#766
docs: add comprehensive keadm ctl command documentation#766abhicodes11 wants to merge 2 commits intokubeedge:masterfrom
Conversation
Signed-off-by: Abhi <abhicodes11@users.noreply.github.com>
kubeedge-bot
added
the
kind/documentation
|
[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 @abhicodes11! It looks like this is your first PR to kubeedge/website 🎉 |
Summary of ChangesHello @abhicodes11, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the KubeEdge documentation by introducing a dedicated and exhaustive guide for the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
kubeedge-bot
added
the
size/L
![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 adds comprehensive documentation for keadm ctl commands, which is a great addition for users. The new documentation is well-structured and covers all subcommands with examples. I've made a few suggestions to improve clarity and completeness in the command references. Overall, this is a valuable contribution to the KubeEdge documentation.
| The `keadm ctl` command includes 8 subcommands for edge node management: | ||
|
|
||
| - `get` - Get information about edge resources | ||
| - `describe` - Describe edge resources in detail |
There was a problem hiding this comment.
There are two trailing spaces on this line which might be unintentional. Please remove them for consistent formatting across the document.
| - `describe` - Describe edge resources in detail | |
| - `describe` - Describe edge resources in detail |
| Get information about edge resources. | ||
|
|
||
| ```bash | ||
| # Get all edge pods |
There was a problem hiding this comment.
The description 'Get all edge pods' is ambiguous because flags like --all-edge-nodes or --node are required to specify which pods to get, as shown in the examples. Please update the comment to clarify this.
| # Get all edge pods | |
| # Get pods on edge nodes (specify with --all-edge-nodes or --node) |
| # Restart an edge pod | ||
| keadm ctl restart <pod-name> --node <edge-node> | ||
|
|
||
| # Restart multiple pods | ||
| keadm ctl restart <pod1> <pod2> --node <edge-node> | ||
|
|
||
| # Force restart | ||
| keadm ctl restart <pod-name> --node <edge-node> --force |
There was a problem hiding this comment.
The command reference for restart is missing the option to restart pods by deployment, which is a useful feature shown in the examples. Please add the --deployment flag usage to this reference section for completeness.
| # Restart an edge pod | |
| keadm ctl restart <pod-name> --node <edge-node> | |
| # Restart multiple pods | |
| keadm ctl restart <pod1> <pod2> --node <edge-node> | |
| # Force restart | |
| keadm ctl restart <pod-name> --node <edge-node> --force | |
| # Restart an edge pod | |
| keadm ctl restart <pod-name> --node <edge-node> | |
| # Restart multiple pods | |
| keadm ctl restart <pod1> <pod2> --node <edge-node> | |
| # Restart all pods in a deployment | |
| keadm ctl restart --deployment <deployment-name> --node <edge-node> | |
| # Force restart | |
| keadm ctl restart <pod-name> --node <edge-node> --force |
- Fix broken links in Chinese build by using absolute paths - Update relative links to work with i18n translations - Ensure all links resolve correctly in both English and Chinese Signed-off-by: Abhi <abhicodes11@users.noreply.github.com>
| ## Managing Edge Nodes with CTL Commands | ||
|
|
||
| After installing KubeEdge, you can use `keadm ctl` commands to manage edge nodes and pods. These commands provide comprehensive control over edge resources, including viewing logs, executing commands, restarting pods, and managing upgrades. | ||
|
|
||
| For detailed documentation on all available `keadm ctl` commands, see [Keadm CTL Commands](./keadm-ctl.md). | ||
|
|
There was a problem hiding this comment.
i am not necessarily against this PR, but i do not think it would be ideal to introduce keadm ctl command all the sudden here... what about the other sub-commands? i would say it would be better if we have dedicated section to explain the keadm sub-commands and link it to here.
3 participants
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Adds comprehensive keadm ctl command documentation to the KubeEdge website with examples, troubleshooting guide, and best practices.
Changes Made:
keadm-ctl.mdwith complete command reference for all 8 ctl commandsinstall-with-keadm.mdto reference the new documentationWhich issue(s) this PR fixes:
#6629 kubeedge/kubeedge repository
Does this PR introduce a user-facing change?:
Added comprehensive keadm ctl command documentation to improve user experience.
Related PR:
Complements PR #6636 in kubeedge/kubeedge repositor
Please check if the PR fulfills these requirements
What is the current behavior?
Website lacks comprehensive keadm ctl command documentation.
What is the new behavior (if this is a feature change)?
Added complete keadm ctl command documentation with examples and troubleshooting guide.
Does this PR introduce a breaking change?
No