Fix KubeEdge Version and Update WasmEdge Docs#227
Fix KubeEdge Version and Update WasmEdge Docs#227sachin21212121 wants to merge 1 commit intokubeedge:masterfrom
Conversation
…ns and code improvements 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 focuses on updating the WasmEdge + KubeEdge integration documentation to align with a more recent and stable KubeEdge version (v1.21.0). The changes ensure that the provided installation and usage instructions are accurate and compatible with current KubeEdge features, while also improving the overall structure and clarity of the guide for better user experience. 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 pull request provides a much-needed update to the WasmEdge and KubeEdge integration documentation. The changes, including updating the KubeEdge version, using variables for consistency, fixing links, and improving formatting, significantly enhance the clarity and usability of the guide. I've added a couple of suggestions to make the shell commands more generic and user-friendly, which should further improve the reader's experience.
| ```bash | ||
| # Use a compatible KubeEdge version and specify the profile | ||
| KUBEEDGE_VERSION=v1.21.0 | ||
| keadm init --advertise-address="THE-EXPOSED-IP" --profile version=${KUBEEDGE_VERSION} --kube-config=/root/.kube/config |
There was a problem hiding this comment.
The hardcoded path --kube-config=/root/.kube/config might not be suitable for all environments, as users may not be running as root or may have their kubeconfig file in a different location. It's better to omit this flag to let keadm use the default kubeconfig path ($HOME/.kube/config) or the KUBECONFIG environment variable. This makes the command more general, and users with a non-standard configuration can still add the flag back if needed.
| keadm init --advertise-address="THE-EXPOSED-IP" --profile version=${KUBEEDGE_VERSION} --kube-config=/root/.kube/config | |
| keadm init --advertise-address="THE-EXPOSED-IP" --profile version=${KUBEEDGE_VERSION} |
| # Replace ${token} with the actual token obtained from 'keadm gettoken' | ||
| keadm join --cloudcore-ipport="THE-EXPOSED-IP":10000 --token=${token} --kubeedge-version=${KUBEEDGE_VERSION} |
There was a problem hiding this comment.
Using ${token} can be misleading, as it suggests a shell variable that should already be defined on the edge node. Since the token is generated on the cloud node and needs to be manually provided here, using a more explicit placeholder like <TOKEN> would be clearer for the user and reduce potential confusion.
| # Replace ${token} with the actual token obtained from 'keadm gettoken' | |
| keadm join --cloudcore-ipport="THE-EXPOSED-IP":10000 --token=${token} --kubeedge-version=${KUBEEDGE_VERSION} | |
| # Replace <TOKEN> with the actual token obtained from 'keadm gettoken' | |
| keadm join --cloudcore-ipport="THE-EXPOSED-IP":10000 --token=<TOKEN> --kubeedge-version=${KUBEEDGE_VERSION} |
| Name: wasi-demo | ||
| Namespace: default | ||
| Priority: 0 | ||
| Node: kubeedge-dev-linux-baoyue/192.168.1.123 | ||
| Start Time: Mon, 06 Mar 2023 19:41:42 +0800 | ||
| Labels: run=wasi-demo | ||
| Annotations: module.wasm.image/variant: compat-smart | ||
| Status: Succeeded | ||
| IP: 10.88.0.13 | ||
| IPs: | ||
| IP: 10.88.0.13 | ||
| IP: 2001:4860:4860::d | ||
| Containers: | ||
| wasi-demo: | ||
| Container ID: containerd://1e1df3ece5d3d67ead3375e82df039d617b9698e421be2a085eadbfe273b2a06 | ||
| Image: hydai/wasm-wasi-example:with-wasm-annotation | ||
| Image ID: docker.io/hydai/wasm-wasi-example@sha256:525aab8d6ae8a317fd3e83cdac14b7883b92321c7bec72a545edf276bb2100d6 | ||
| Port: <none> | ||
| Host Port: <none> | ||
| Args: | ||
| /wasi_example_main.wasm | ||
| 50000000 | ||
| State: Terminated | ||
| Reason: Completed | ||
| Exit Code: 0 | ||
| Started: Mon, 06 Mar 2023 19:41:50 +0800 | ||
| Finished: Mon, 06 Mar 2023 19:41:50 +0800 | ||
| Ready: False | ||
| Restart Count: 0 | ||
| Environment: <none> | ||
| Mounts: | ||
| /var/run/secrets/kubernetes.io/serviceaccount from kube-api-access-lznkt (ro) | ||
| Conditions: | ||
| Type Status | ||
| Initialized True | ||
| Ready False | ||
| ContainersReady False | ||
| PodScheduled True | ||
| Volumes: | ||
| kube-api-access-lznkt: | ||
| Type: Projected (a volume that contains injected data from multiple sources) | ||
| TokenExpirationSeconds: 3607 | ||
| ConfigMapName: kube-root-ca.crt | ||
| ConfigMapOptional: <nil> | ||
| DownwardAPI: true | ||
| QoS Class: BestEffort | ||
| Node-Selectors: <none> | ||
| Tolerations: node.kubernetes.io/not-ready:NoExecute op=Exists for 300s | ||
| node.kubernetes.io/unreachable:NoExecute op=Exists for 300s | ||
| Events: <none> |
There was a problem hiding this comment.
I think we want to keep this, could you add it back?
There was a problem hiding this comment.
sure, i will add it back
3 participants
Updated the WasmEdge + KubeEdge documentation to use a valid KubeEdge version (v1.21.0) and Improved consistency of variables and links to official docs