docs: add kernel-native mode install guide to quick-start #268
Conversation
✅ Deploy Preview for kmesh-net ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
[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 @AAdIprog! It looks like this is your first PR to kmesh-net/website 🎉 |
Summary of ChangesHello @AAdIprog, 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 Kmesh quick-start documentation by introducing a structured and user-friendly guide for installing Kmesh in Kernel-Native mode. By organizing installation instructions into tabbed sections for both Dual Engine and Kernel-Native modes, the changes aim to provide a clearer and more intuitive path for users to set up Kmesh according to their specific operational requirements, ultimately improving the overall clarity and usability of the documentation. 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. 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
|
![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 does a great job of refactoring the installation documentation to include instructions for the Kernel-Native mode using tabs. The structure is much clearer now. I have a couple of suggestions to improve the clarity and portability of the commands in the new section to make the quick-start guide even more user-friendly.
| 1. Modify the startup mode to `kernel-native`: | ||
|
|
||
| ```shell | ||
| sed -i 's/--mode=dual-engine/--mode=kernel-native/' deploy/charts/kmesh-helm/values.yaml |
There was a problem hiding this comment.
The sed -i command is not portable and will fail on macOS, which uses BSD sed. To improve the user experience for developers on macOS, please add a note about the difference. For example, you could add a note above the code block mentioning that macOS users should use sed -i '' 's/--mode=dual-engine/--mode=kernel-native/' ....
|
|
||
| ### Option 2: Install from Yaml | ||
|
|
||
| 1. Modify the startup mode in the Yaml configuration files (you may need to locate the specific DaemonSet configuration). |
There was a problem hiding this comment.
This instruction is too vague for a quick-start guide. Users may not know which file to look for or what to change. Please provide more specific instructions, similar to the Helm installation section. It would be helpful to specify the exact file in deploy/yaml/ to modify and show an example of the change (e.g., using sed or a diff).
There was a problem hiding this comment.
Pull request overview
This PR enhances the quick-start documentation by adding a dedicated installation guide for Kernel-Native Mode alongside the existing Dual Engine mode instructions. The documentation now uses a tabbed interface to clearly separate the two installation modes.
Changes:
- Refactored the "Install Kmesh" section to use Docusaurus Tabs/TabItem components
- Added comprehensive Kernel-Native mode installation instructions with prerequisite warnings
- Moved the previous "Change Kmesh Start Mode" section into the Kernel-Native tab as installation steps
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 1. Modify the startup mode in the Yaml configuration files (you may need to locate the specific DaemonSet configuration). | ||
|
|
There was a problem hiding this comment.
The instruction to modify the startup mode in Yaml configuration files is vague and unhelpful. Unlike the Helm option which provides a specific sed command, this option only mentions "you may need to locate the specific DaemonSet configuration" without providing concrete guidance on:
- Which file(s) to modify
- What the current value looks like
- What the new value should be
- The exact location within the file
Consider adding more specific instructions similar to the Helm option, or at least specify the file path and the parameter name to change.
| 1. Modify the startup mode in the Yaml configuration files (you may need to locate the specific DaemonSet configuration). | |
| 1. Open the Kmesh DaemonSet manifest under `deploy/yaml/` (for example, `deploy/yaml/kmesh-daemonset.yaml`) and update the startup mode: | |
| - Locate the container `args` entry that contains `--mode=dual-engine`. | |
| - Change it to `--mode=kernel-native`. | |
| For example: | |
| ```yaml | |
| apiVersion: apps/v1 | |
| kind: DaemonSet | |
| metadata: | |
| name: kmesh-daemon | |
| spec: | |
| template: | |
| spec: | |
| containers: | |
| - name: kmesh | |
| args: | |
| - "--mode=kernel-native" | |
| ``` |
| time="2024-04-25T13:17:41Z" level=info msg="cni config file: /etc/cni/net.d/10-kindnet.conflist" subsys="cni installer" | ||
| time="2024-04-25T13:17:41Z" level=info msg="command Start cni successful" subsys=manager | ||
| ``` | ||
| ### Option 1: Install from Helm (Recommended) |
There was a problem hiding this comment.
Missing an "Install from OCI Registry" option for the Kernel Native tab. While the Dual Engine tab provides this as Option 1 (Recommended), users following the Kernel Native instructions don't have an equivalent option explained. Consider adding instructions for how to install from the OCI registry with kernel-native mode, possibly using Helm's --set flag to override the mode parameter, or explicitly state that OCI registry installation is not recommended for kernel-native mode and explain why.
| helm install kmesh ./deploy/charts/kmesh-helm -n kmesh-system --create-namespace | ||
| ``` | ||
|
|
||
| ### Option 2: Install from Yaml |
There was a problem hiding this comment.
The "Install from Helm Chart Archive" option (Option 3) is missing from the Kernel Native tab. This creates an inconsistency with the Dual Engine tab which offers four installation options. Consider adding this option to maintain consistency, or explicitly state that not all installation methods are available for kernel-native mode.
2 participants
Description
Resolves #95
This PR adds a dedicated installation guide for Kernel-Native Mode to the quick-start.md documentation.
Changes
values.yaml(viased) or Yaml config to enablekernel-nativemode before installation.Verification
--mode=kernel-native) are correct and easy to follow.