-
Notifications
You must be signed in to change notification settings - Fork 30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add bypass feature user guide #108
Open
DeshDeepakKant
wants to merge
2
commits into
kmesh-net:main
Choose a base branch
from
DeshDeepakKant:docs/add-bypass-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,158 @@ | ||
--- | ||
draft: false | ||
linktitle: Use Bypass Feature in Kmesh | ||
menu: | ||
docs: | ||
parent: user guide | ||
weight: 19 | ||
title: Use Bypass Feature in Kmesh | ||
toc: true | ||
type: docs | ||
--- | ||
|
||
## **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. | ||
|
||
## **Use Cases** | ||
|
||
###### 1. Troubleshooting Service Communication | ||
- Identify whether issues are caused by mesh service or application logic | ||
- Test direct communication between services without mesh interference | ||
- Debug network connectivity issues | ||
|
||
##### 2. Traffic Path Verification | ||
- Verify service behavior with and without mesh involvement | ||
- Validate application communication patterns | ||
- Test service-to-service direct connectivity | ||
|
||
## **Prerequisites** | ||
|
||
Before using the bypass feature, ensure you have: | ||
|
||
- A running Kubernetes cluster | ||
- Kmesh installed and configured | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit:You can give a link to kmesh quick start |
||
- Pods with sidecar injection enabled | ||
- Administrative access to the cluster | ||
|
||
## **Enabling Bypass** | ||
|
||
##### 1. Enable Bypass Controller | ||
|
||
The bypass controller must be enabled in your Kmesh configuration: | ||
|
||
```yaml | ||
--enable-bypass=true | ||
``` | ||
|
||
##### 2. Label Pods for Bypass | ||
|
||
To enable bypass for specific pods: | ||
|
||
```bash | ||
kubectl label pod <pod_name> kmesh.net/bypass=enabled | ||
``` | ||
|
||
## **How It Works** | ||
|
||
##### Traffic Flow Changes | ||
|
||
##### 1. Normal Flow (Without Bypass) | ||
``` | ||
Service A → Sidecar → Sidecar → Service B | ||
``` | ||
|
||
##### 2. Bypass Enabled Flow | ||
``` | ||
Service A → Service B (Direct communication) | ||
``` | ||
|
||
##### Implementation Details | ||
|
||
The bypass feature implements traffic control through: | ||
|
||
1. **Label Monitoring**: | ||
```go | ||
const ( | ||
ByPassLabel = "kmesh.net/bypass" | ||
ByPassValue = "enabled" | ||
) | ||
``` | ||
|
||
2. **IPTables Rules**: | ||
```bash | ||
iptables -t nat -I OUTPUT -m bpf --object-pinned /sys/fs/bpf/bypass -j RETURN | ||
iptables -t nat -I PREROUTING -m bpf --object-pinned /sys/fs/bpf/bypass -j RETURN | ||
``` | ||
|
||
## **Verification** | ||
|
||
##### 1. Check Bypass Status | ||
|
||
```bash | ||
# Check if pod has bypass label | ||
kubectl get pod <pod_name> --show-labels | ||
``` | ||
|
||
##### 2. Verify Traffic Flow | ||
|
||
```bash | ||
# Check iptables rules in pod | ||
kubectl exec <pod_name> -- iptables -t nat -L | ||
``` | ||
|
||
##### 3. Verify Bypass Configuration | ||
|
||
```bash | ||
# Check bypass controller status | ||
kubectl get pods -n kmesh-system | grep bypass-controller | ||
``` | ||
|
||
## **Limitations and Considerations** | ||
|
||
##### 1. Single Pod Scope | ||
- Bypass affects only the labeled pod | ||
- Does not affect the entire traffic path | ||
|
||
##### 2. Message Format | ||
- Before enabling bypass: | ||
- Configure mesh service for plaintext messages | ||
- Prevent encryption/decryption issues | ||
|
||
##### 3. Traffic Direction | ||
- Current: Affects both inbound and outbound traffic | ||
- Future: Will support directional bypass | ||
|
||
## **Troubleshooting** | ||
|
||
##### Common Issues and Solutions | ||
|
||
1. **Bypass Not Working** | ||
```bash | ||
# Verify label | ||
kubectl get pod <pod_name> --show-labels | grep kmesh.net/bypass | ||
|
||
# Check sidecar | ||
kubectl describe pod <pod_name> | grep sidecar | ||
``` | ||
|
||
2. **Communication Issues** | ||
```bash | ||
# Check iptables | ||
kubectl exec <pod_name> -- iptables -t nat -L | ||
|
||
# Verify network namespace | ||
kubectl exec <pod_name> -- ip netns list | ||
``` | ||
|
||
## **Cleanup** | ||
|
||
##### Remove Bypass Configuration | ||
|
||
```bash | ||
# Remove bypass label | ||
kubectl label pod <pod_name> kmesh.net/bypass- | ||
|
||
# Verify removal | ||
kubectl get pod <pod_name> --show-labels | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This weight indicates the position of the page in the navigation bar. Try not to weight it the same as other pages