docs: add bypass feature user guide #108
Conversation
|
@DeshDeepakKant: The label(s) In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Welcome @DeshDeepakKant! It looks like this is your first PR to kmesh-net/website 🎉 |
✅ Deploy Preview for kmesh-net ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
- Add detailed documentation for bypass feature - Include configuration examples - Add troubleshooting steps - Document limitations and considerations Signed-off-by: DeshDeepakKant <[email protected]>
DeshDeepakKant
force-pushed
the
docs/add-bypass-guide
branch
from
50f2db9 to
9bc9216
Compare
content/en/docs/userguide/bypass.md
Outdated
| menu: | ||
| docs: | ||
| parent: user guide | ||
| weight: 19 |
There was a problem hiding this comment.
This weight indicates the position of the page in the navigation bar. Try not to weight it the same as other pages
content/en/docs/userguide/bypass.md
Outdated
| Before using the bypass feature, ensure you have: | ||
|
|
||
| - A running Kubernetes cluster | ||
| - Kmesh installed and configured |
There was a problem hiding this comment.
nit：You can give a link to kmesh quick start
|
Welcome! After this PR is merged, you can apply to join the Kmesh community. |
Signed-off-by: DeshDeepakKant <[email protected]>
Thank you! I am already on Slack. Could you please let me know how I can apply to join the Kmesh community? |
https://github.com/kmesh-net/community/blob/main/community-membership.md |
|
@YaoZengzeng please review it. |
|
|
||
| ## **Overview** | ||
|
|
||
| The bypass feature in Kmesh allows you to temporarily remove mesh service from the traffic path for troubleshooting purposes. This is particularly useful when you need to determine whether communication issues are caused by the mesh service or the application itself. |
There was a problem hiding this comment.
| The bypass feature in Kmesh allows you to temporarily remove mesh service from the traffic path for troubleshooting purposes. This is particularly useful when you need to determine whether communication issues are caused by the mesh service or the application itself. | |
| The bypass feature in Kmesh allows you to temporarily remove mesh from the service traffic path for troubleshooting purposes. This is particularly useful when you need to determine whether communication issues are caused by the mesh service or the application itself. |
| The bypass controller must be enabled in your Kmesh configuration: | ||
|
|
||
| ```yaml | ||
| --enable-bypass=true |
There was a problem hiding this comment.
Please add more details, at least explain that it is added to the command line of Kmesh daemon.
|
|
||
| ##### 1. Normal Flow (Without Bypass) | ||
| ``` | ||
| Service A → Sidecar → Sidecar → Service B |
There was a problem hiding this comment.
| Service A → Sidecar → Sidecar → Service B | |
| Service A → Sidecar A → Sidecar B → Service B |
| Service A → Service B (Direct communication) | ||
| ``` | ||
|
|
||
| ##### Implementation Details |
There was a problem hiding this comment.
It would be better if you could write more details.
|
|
||
| ```bash | ||
| # Check iptables rules in pod | ||
| kubectl exec <pod_name> -- iptables -t nat -L |
There was a problem hiding this comment.
Also need more details about how to verify.
|
cc @weli-l PTAL |
There was a problem hiding this comment.
PR Overview
This PR adds a comprehensive user guide for the bypass feature in Kmesh, aimed at helping users understand how to configure, use, and troubleshoot the feature.
- Introduces configuration steps with example commands
- Describes use cases and limitations of bypass functionality
- Provides troubleshooting and cleanup instructions
Reviewed Changes
| File | Description |
|---|---|
| content/en/docs/userguide/bypass.md | New documentation for the Kmesh bypass feature |
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
content/en/docs/userguide/bypass.md:77
- [nitpick] Consider renaming 'ByPassLabel' to 'BypassLabel' for a more consistent camelCase naming convention.
ByPassLabel = "kmesh.net/bypass"
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Adds user guide for the bypass feature introduced in Kmesh. The documentation covers configuration, usage, and troubleshooting of the bypass feature which allows users to temporarily remove mesh service from the traffic path.
Special notes for your reviewer: