Update install-with-keadm.md for KubeEdge v1.21#725
Update install-with-keadm.md for KubeEdge v1.21#725sachin21212121 wants to merge 1 commit intokubeedge:masterfrom
Conversation
|
[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 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @sachin21212121, 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 updates the install-with-keadm.md documentation to reflect the latest KubeEdge v1.21 release. The changes ensure that users have access to accurate and up-to-date installation instructions, including critical Kubernetes compatibility information. The document's structure and formatting have also been enhanced to provide a clearer and more user-friendly experience for installing KubeEdge.
Highlights
- KubeEdge Version Update: All KubeEdge version references in the
install-with-keadm.mddocumentation have been updated to v1.21. - Kubernetes Compatibility: New Kubernetes compatibility notes and a detailed compatibility table have been added to guide users on supported Kubernetes versions.
- Installation Command Verification: Installation commands have been verified to work correctly across amd64, arm, and arm64 architectures.
- Documentation Clarity and Formatting: The overall clarity and formatting of the installation instructions have been improved for easier readability and navigation.
Using Gemini Code Assist
The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
kubeedge-bot
added
the
size/L
There was a problem hiding this comment.
Code Review
This pull request does a great job of updating and simplifying the install-with-keadm.md documentation for KubeEdge v1.21. The addition of the Kubernetes compatibility table and the overall refactoring for conciseness are excellent improvements. I've left a few comments on minor issues, such as fixing some broken links, correcting a code block's language specifier, and removing excessive blank lines to improve formatting. Once these are addressed, this will be a solid update to the documentation.
| ``` | ||
|
|
||
| Make the docker image: | ||
| Refer to Enable Kubectl logs/exec documentation. |
There was a problem hiding this comment.
This appears to be a broken link. The link to the 'Enable Kubectl logs/exec' documentation should be restored.
| Refer to Enable Kubectl logs/exec documentation. | |
| Refer to [Enable Kubectl logs/exec documentation](../advanced/debug.md). |
| ### 2. Download from Docker Hub | ||
|
|
||
| 2. Ensure the edge node can connect to the cloud node using the local IP of cloud node, or specify the public IP of the cloud node with the `--advertise-address` flag. | ||
|
|
||
| 3. `--advertise-address` is the address exposed by the cloud side (it will be added to the SANs of the CloudCore certificate). The default value is the local IP. | ||
|
|
||
| ### keadm init | ||
| ```bash | ||
|
|
||
| `keadm init` provides a solution for integrating the CloudCore Helm chart. CloudCore will be deployed to cloud nodes in container mode. | ||
| docker run --rm kubeedge/installation-package:v1.21.0 cat /usr/local/bin/keadm > /usr/local/bin/keadm | ||
|
|
||
| Example: | ||
| chmod +x /usr/local/bin/keadm | ||
|
|
||
| ```shell | ||
| keadm init --advertise-address="THE-EXPOSED-IP" --kubeedge-version=v1.17.0 --kube-config=/root/.kube/config | ||
| ``` | ||
|
|
There was a problem hiding this comment.
This section contains several unnecessary blank lines (e.g., lines 53-55, 57, 59, 61-62) which affect readability. Please consider removing them to make the document more compact and improve formatting.
| ### 3. Build from Source | ||
|
|
||
| You can run `kubectl get all -n kubeedge` to ensure that CloudCore start successfully, as shown below. | ||
|
|
||
| ```shell | ||
| # kubectl get all -n kubeedge | ||
| NAME READY STATUS RESTARTS AGE | ||
| pod/cloudcore-56b8454784-ngmm8 1/1 Running 0 46s | ||
|
|
||
| NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE | ||
| service/cloudcore ClusterIP 10.96.96.56 <none> 10000/TCP,10001/TCP,10002/TCP,10003/TCP,10004/TCP 46s | ||
| Refer to build from source instructions. |
There was a problem hiding this comment.
There are excessive blank lines in this section (lines 64-66). Please remove them for better formatting.
| ``` | ||
| ### Example Deployment (metrics-server-deployment.yaml): | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
The code block contains YAML configuration, but it's marked as bash. This should be corrected to yaml for proper syntax highlighting.
| ```bash | |
| ```yaml |
| ## Reset KubeEdge Master and Worker Nodes | ||
|
|
||
| Those settings need to be written in deployment yaml (metrics-server-deployment.yaml) file like this: | ||
|
|
||
| ``` yaml | ||
| volumes: | ||
| # mount in tmp so we can safely use from-scratch images and/or read-only containers | ||
| - name: tmp-dir | ||
| emptyDir: {} | ||
| hostNetwork: true #Add this line to enable hostnetwork mode | ||
| containers: | ||
| - name: metrics-server | ||
| image: metrics-server-kubeedge:latest #Make sure that the REPOSITORY and TAG are correct | ||
| # Modified args to include --kubelet-insecure-tls for Docker Desktop (don't use this flag with a real k8s cluster!!) | ||
| imagePullPolicy: Never #Make sure that the deployment uses the image you built up | ||
| args: | ||
| - --cert-dir=/tmp | ||
| - --secure-port=4443 | ||
| - --v=2 | ||
| - --kubelet-insecure-tls | ||
| - --kubelet-preferred-address-types=InternalDNS,InternalIP,ExternalIP,Hostname | ||
| - --kubelet-use-node-status-port #Enable the feature of --kubelet-use-node-status-port for Metrics-server | ||
| ports: | ||
| - name: main-port | ||
| containerPort: 4443 | ||
| protocol: TCP | ||
| ``` | ||
|
|
||
| ## Reset KubeEdge Master and Worker nodes | ||
|
|
||
| ### Master |
There was a problem hiding this comment.
There are excessive blank lines here (lines 240-242). Please remove them for better formatting.
- Updated version references to v1.21 - Added Kubernetes compatibility notes and table - Verified commands work for amd64, arm, and arm64 architectures - Improved clarity and formatting for easier following of instructions Signed-off-by: sachin21212121 <jhasachin0115@gmail.com>
sachin21212121
force-pushed
the
docs/update-keadm-v1.21
branch
from
26b1504 to
d5d410c
Compare
Shelley-BaoYue
left a comment
Shelley-BaoYue
left a comment
There was a problem hiding this comment.
Same with #726 , please fix format according to the preview page.
| Keadm is used to install the cloud and edge components of KubeEdge. | ||
| It does **not** handle Kubernetes installation or its [runtime environment](https://kubeedge.io/docs/setup/prerequisites/runtime). | ||
|
|
||
| Check [Kubernetes compatibility](https://github.com/kubeedge/kubeedge?tab=readme-ov-file#kubernetes-compatibility) to confirm supported versions. |
There was a problem hiding this comment.
We have already mentioned compatibility here and provided the link, so there is no need to repeat it later from Line20. Doing so would only result in having to maintain updates for compatibility in two places.
3 participants
Description of Changes:
• Updated the KubeEdge version references to v1.21 in install-with-keadm.md.
• Added Kubernetes compatibility notes and a compatibility table to help users select the correct Kubernetes version.
• Verified that installation commands work for amd64, arm, and arm64 architectures.
• Improved clarity and formatting for easier following of instructions.
Reason for the Change:
• The previous documentation referenced older versions and lacked explicit Kubernetes compatibility guidance.
• These updates make the guide accurate, up-to-date, and easier to follow for users installing KubeEdge v1.21.
Notes for Reviewers:
• Focused only on version updates and compatibility information.
• No structural changes outside install-with-keadm.md.