docs: update install-with-keadm.md for KubeEdge v1.21#731
docs: update install-with-keadm.md for KubeEdge v1.21#731sachin21212121 wants to merge 1 commit intokubeedge:masterfrom
Conversation
Signed-off-by: sachin21212121 <jhasachin0115@gmail.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 |
Summary of ChangesHello @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 significantly refines the Highlights
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 is a great pull request that significantly improves the install-with-keadm.md documentation. The content is now much more concise, better structured, and easier to follow. Updating the commands to KubeEdge v1.21 and cleaning up the command outputs are excellent changes.
I've found a couple of broken links and a potential issue in one of the YAML examples. My detailed feedback is in the review comments. Once these minor issues are addressed, this documentation will be in great shape.
| spec: | ||
| affinity: | ||
| nodeAffinity: | ||
| requiredDuringSchedulingIgnoredDuringExecution: | ||
| nodeSelectorTerms: | ||
| - matchExpressions: | ||
| - key: kubernetes.io/hostname | ||
| operator: In | ||
| values: | ||
| - charlie-latest | ||
| hostNetwork: true | ||
| containers: | ||
| - name: metrics-server | ||
| image: metrics-server-kubeedge:latest | ||
| imagePullPolicy: Never | ||
| 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 | ||
| ports: | ||
| - name: main-port | ||
| containerPort: 4443 | ||
| protocol: TCP |
There was a problem hiding this comment.
The example deployment for metrics-server is missing the volumes and volumeMounts for the temporary directory, which is used by the --cert-dir=/tmp argument. This can cause the pod to fail if it's based on a minimal or scratch image without a writable /tmp directory. Please add the necessary volume configuration.
spec:
affinity:
nodeAffinity:
requiredDuringSchedulingIgnoredDuringExecution:
nodeSelectorTerms:
- matchExpressions:
- key: kubernetes.io/hostname
operator: In
values:
- charlie-latest
hostNetwork: true
volumes:
- name: tmp-dir
emptyDir: {}
containers:
- name: metrics-server
image: metrics-server-kubeedge:latest
imagePullPolicy: Never
volumeMounts:
- name: tmp-dir
mountPath: /tmp
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
ports:
- name: main-port
containerPort: 4443
protocol: TCP| ### Helm Notes | ||
|
|
||
| 3. `keadm init` by default, deploys CloudCore in container mode. If you want to deploy CloudCore as a binary, please refer to [`keadm deprecated init`](#keadm-deprecated-init). | ||
| Set flags `--set key=value` for CloudCore Helm chart. See [CloudCore Helm Charts README.md](https://github.com/kubeedge/kubeedge/tree/master/build/cloud/cloudcore). |
There was a problem hiding this comment.
The link to the CloudCore Helm Charts README is broken and results in a 404 error. Please update it to point to the correct file for the v1.21 release.
| Set flags `--set key=value` for CloudCore Helm chart. See [CloudCore Helm Charts README.md](https://github.com/kubeedge/kubeedge/tree/master/build/cloud/cloudcore). | |
| Set flags `--set key=value` for CloudCore Helm chart. See [CloudCore Helm Charts README.md](https://github.com/kubeedge/kubeedge/blob/release-1.21/manifests/charts/cloudcore/README.md). |
| ``` | ||
| ## Deploy Demo on Edge Nodes | ||
|
|
||
| Refer to [Deploy demo on edge nodes](https://kubeedge.io/docs/setup/deploy-demo/). |
There was a problem hiding this comment.
This link to deploy a demo on edge nodes is broken. Please update it to point to the correct page and anchor.
| Refer to [Deploy demo on edge nodes](https://kubeedge.io/docs/setup/deploy-demo/). | |
| Refer to [Deploy demo on edge nodes](https://kubeedge.io/docs/setup/install-with-binary#deploy-demo-on-edge-nodes). |
2 participants
This PR updates the install-with-keadm.md documentation based on feedback from PR #725
Changes include:
Updated instructions for KubeEdge v1.21.
Fixed all broken links (direct links to GitHub/KubeEdge docs).
Removed redundant content and excessive blank lines.
Corrected code block language formatting.
Added “Deprecated Commands” sections for clarity.
Simplified and clarified the introduction and prerequisites.