Skip to content

docs: add ADS mode deployment and usage guide#1620

Open
Aaravanand00 wants to merge 5 commits intokmesh-net:mainfrom
Aaravanand00:docs-ads-mode-guide
Open

docs: add ADS mode deployment and usage guide#1620
Aaravanand00 wants to merge 5 commits intokmesh-net:mainfrom
Aaravanand00:docs-ads-mode-guide

Conversation

@Aaravanand00
Copy link
Copy Markdown

What type of PR is this?
/kind documentation

What this PR does / why we need it:
This PR adds a guide for deploying and using Kmesh in ADS (kernel-native) mode.

It includes setup steps, verification, and examples for routing, load balancing, and grayscale traffic.

Which issue(s) this PR fixes:
Fixes #421

Special notes for your reviewer:
The documentation follows the existing structure and includes both English and Chinese versions.

Does this PR introduce a user-facing change?:

Add documentation for deploying and using Kmesh in ADS (kernel-native) mode.

Copilot AI review requested due to automatic review settings March 21, 2026 00:47
@kmesh-bot
Copy link
Copy Markdown
Collaborator

@Aaravanand00: The label(s) kind/documentation cannot be applied, because the repository doesn't have them.

Details

In response to this:

What type of PR is this?
/kind documentation

What this PR does / why we need it:
This PR adds a guide for deploying and using Kmesh in ADS (kernel-native) mode.

It includes setup steps, verification, and examples for routing, load balancing, and grayscale traffic.

Which issue(s) this PR fixes:
Fixes #421

Special notes for your reviewer:
The documentation follows the existing structure and includes both English and Chinese versions.

Does this PR introduce a user-facing change?:

Add documentation for deploying and using Kmesh in ADS (kernel-native) mode.

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.

@kmesh-bot
Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign yaozengzeng for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, 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 Kmesh's documentation by introducing a comprehensive guide for its ADS (Kernel-Native) mode. The new guide aims to clarify the deployment process and demonstrate the powerful traffic management capabilities offered by Kmesh leveraging eBPF for in-kernel L4 and L7 control, providing users with practical examples for various use cases.

Highlights

  • New Documentation for ADS (Kernel-Native) Mode: A comprehensive guide has been added for deploying and using Kmesh in ADS (Kernel-Native) mode, which leverages eBPF for in-kernel traffic control.
  • Detailed Setup and Verification: The new documentation includes step-by-step instructions for configuring Kmesh in ADS mode, deploying the Daemonset, enabling Kmesh for specific namespaces, and verifying xDS subscription and BPF map population.
  • Practical Usage Examples: The guide provides practical examples for implementing HTTP routing, load balancing, and grayscale (canary) releases for both HTTP and TCP traffic using standard Istio resources.
  • Multilingual Support: The new ADS mode documentation is available in both English and Chinese versions.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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.


New docs now unfold, eBPF guides traffic with grace, Kernel's power shown.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds documentation for deploying and using Kmesh in ADS mode, including both English and Chinese versions. The documentation is well-structured, but the usage examples provided for Istio resources are incomplete. Specifically, the VirtualService examples rely on subsets that are not defined in any DestinationRule within the guide, which will prevent them from working correctly. I have added comments with suggestions to include the necessary DestinationRule configurations to make the examples functional and complete.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds new documentation to help users deploy and use Kmesh in ADS (Kernel-Native) mode, and surfaces the new guide from the project READMEs.

Changes:

  • Add English ADS mode deployment/usage guide with verification and traffic-management examples.
  • Add Chinese (zh) ADS mode deployment/usage guide mirroring the English version.
  • Update README entry points to link to the new ADS mode guide(s) and existing demos.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

File Description
docs/en/ads_mode_deployment_and_usage.md New English guide for ADS (Kernel-Native) deployment, verification, and routing/LB/canary examples.
docs/cn/zh/ads_mode_deployment_and_usage.md New Chinese guide mirroring the English ADS mode guide.
README.md Updates “Quick Start” links to include the new ADS mode guide and correct doc paths.
README-zh.md Adds links to the new Chinese ADS guide and other docs (but leaves an older broken demo link elsewhere in the file).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@yashisrani
Copy link
Copy Markdown
Contributor

@Aaravanand00 hey, please sign of DCO when you create any new pr or pushing any code. and try to avoid Chinese doc contribution if you are not familiar with Chinese language. it is not easy language like english.

@Aaravanand00 Aaravanand00 force-pushed the docs-ads-mode-guide branch from ad955f8 to c16913e Compare April 1, 2026 11:33
Copilot AI review requested due to automatic review settings April 1, 2026 11:54
@kmesh-bot kmesh-bot added size/XL and removed size/L labels Apr 1, 2026
@Aaravanand00 Aaravanand00 force-pushed the docs-ads-mode-guide branch from bd33172 to 1155b8e Compare April 1, 2026 11:57
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 9 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Signed-off-by: Aaravanand00 <aaravanand5749@gmail.com>
Signed-off-by: Aaravanand00 <aaravanand5749@gmail.com>
Signed-off-by: Aaravanand00 <aaravanand5749@gmail.com>
Added detailed requirements and design overview for Kmesh, including use cases, deployment views, and feature lists.

Signed-off-by: Aaravanand00 <aaravanand5749@gmail.com>
Signed-off-by: Aaravanand00 <aaravanand5749@gmail.com>
@Aaravanand00 Aaravanand00 force-pushed the docs-ads-mode-guide branch from 27dbd9e to fbfa044 Compare April 1, 2026 12:26
Copilot AI review requested due to automatic review settings April 1, 2026 12:26
@kmesh-bot kmesh-bot added size/XXL and removed size/XL labels Apr 1, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 8 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add a docment about how to deploy and use kmesh with ads mode

4 participants