Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/application-layer/install_waypoint.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 3
title: Install Waypoint
description: Deploy Kmesh waypoint proxies for L7 traffic management.
keywords: [waypoint, L7, install, service mesh, ebpf, proxy]
---

If you want to make use of Kmesh L7 features, this is the prerequisites to install waypoint.
Expand Down
4 changes: 3 additions & 1 deletion docs/application-layer/kiali.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 8
title: Use Kiali to visualize traffic graph under Kmesh
title: Visualise Traffic with Kiali
description: Use Kiali to view the Kmesh traffic topology graph.
keywords: [kiali, traffic graph, observability, metrics, dashboard]
---

## Preparation
Expand Down
2 changes: 2 additions & 0 deletions docs/application-layer/locality-loadbalance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 9
title: Locality Load Balancing
description: Configure locality-aware load balancing and failover in Kmesh.
keywords: [locality, load balancing, failover, L4, ambient, zone]
---

This document introduces how to use Locality Load Balancing with Istio in the Kmesh.
Expand Down
2 changes: 2 additions & 0 deletions docs/application-layer/request-routing-ads.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 1
title: Request Routing
description: Route HTTP requests by weight or user identity in Kmesh.
keywords: [request routing, header routing, jason, user, http]
---

This task shows you how to set up Request Routing policy for http traffic in Kmesh.
Expand Down
2 changes: 2 additions & 0 deletions docs/application-layer/traffic-shifting-ads.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 2
title: Traffic Shifting
description: Set up weight-based and header-based HTTP traffic shifting in Kmesh.
keywords: [traffic shifting, weight, header, routing, http, split]
---

This task shows you how to set up Traffic Shifting policy for http traffic in Kmesh.
Expand Down
2 changes: 2 additions & 0 deletions docs/application-layer/try-fault-injection.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 6
title: Try Fault Injection
description: Learn how to inject HTTP delays & aborts to test micro-service resiliency in Kmesh.
keywords: [fault injection, http delay, abort, resilience, testing, kmesh, waypoint]
---

## Preparation
Expand Down
2 changes: 2 additions & 0 deletions docs/application-layer/try-request-routing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 4
title: Try Request Routing
description: Route traffic by version or user identity with Kmesh VirtualService policies.
keywords: [request routing, version routing, header routing, jason user, kmesh, virtualservice]
---

## Preparation
Expand Down
2 changes: 2 additions & 0 deletions docs/application-layer/try-request-timeout.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 7
title: Try Request Timeouts
description: Configure HTTP request timeouts and observe timeout behaviour in Kmesh.
keywords: [request timeout, http timeout, reviews service, kmesh, waypoint, fault injection]
---

# Try Request Timeouts
Expand Down
2 changes: 2 additions & 0 deletions docs/application-layer/try-traffic-shifting.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 5
title: Try Traffic Shifting
description: Shift HTTP traffic between service versions with weighted routing.
keywords: [traffic shifting, weighted routing, canary, split, http]
---

## Preparation
Expand Down
3 changes: 2 additions & 1 deletion docs/architecture/architecture.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Kmesh Architecture
description: ""
description: High-level overview of Kmesh components – daemon, eBPF orchestration, and waypoint proxy.
keywords: [kmesh architecture, ebpf orchestration, waypoint proxy, service mesh data plane]
sidebar_position: 1
---

Expand Down
3 changes: 2 additions & 1 deletion docs/architecture/roadmap.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Roadmap
description: ""
description: Kmesh feature timeline – traffic management, security, observability, and ecosystem collaboration.
keywords: [kmesh roadmap, feature timeline, traffic management, observability, ebpf]
sidebar_position: 2
---

Expand Down
2 changes: 2 additions & 0 deletions docs/community/contribute.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Contributing
description: Join the Kmesh community – learn how to contribute code, docs, or feedback.
keywords: [contribute, community, kmesh, cncf, pull request, good first issue]
sidebar_position: 1
---

Expand Down
5 changes: 5 additions & 0 deletions docs/community/feature-lifecycle.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Feature Lifecycle
description: Understand Alpha, Beta, and GA stages for Kmesh features and APIs.
keywords: [feature lifecycle, alpha beta ga, api stability, graduation criteria, kmesh]
sidebar_position: 2
---

Expand All @@ -10,8 +12,11 @@ Each version has different level of stability, support time,
and requires different graduation criteria moving to next level:

- [Alpha](#alpha)
- [Graduation Criteria](#graduation-criteria)
- [Beta](#beta)
- [Graduation Criteria](#graduation-criteria-1)
- [GA](#ga)
- [Graduation Criteria](#graduation-criteria-2)

## Alpha

Expand Down
2 changes: 2 additions & 0 deletions docs/community/governance.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Governance
description: Kmesh project governance – values, membership, meetings, and decision-making process.
keywords: [governance, values, membership, steering committee, kmesh, cncf]
sidebar_position: 3
---

Expand Down
2 changes: 2 additions & 0 deletions docs/community/membership.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Membership
description: Community roles in Kmesh – Member, Reviewer, Approver, Maintainer – and how to advance.
keywords: [community roles, member, reviewer, approver, maintainer, kmesh, ladder]
sidebar_position: 4
---

Expand Down
2 changes: 2 additions & 0 deletions docs/performance/performance.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Kmesh Performance
description: Benchmark results, test methodology, and performance metrics for Kmesh eBPF data plane.
keywords: [kmesh performance, fortio benchmark, latency, throughput, ebpf, observability]
sidebar_position: 1
---

Expand Down
2 changes: 2 additions & 0 deletions docs/performance/resource-consumption.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Kmesh Resource Consumption
description: CPU and memory usage analysis of Kmesh eBPF programs under various load scenarios.
keywords: [resource consumption, cpu usage, memory usage, ebpf, kmesh, stress test]
sidebar_position: 2
---

Expand Down
2 changes: 2 additions & 0 deletions docs/setup/develop-with-kind.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Deploy/Develop with Kind
description: Quick guide to create a local Kubernetes cluster with Kind and deploy Kmesh for development.
keywords: [kind, local cluster, development, kmesh, istio ambient, ebpf]
sidebar_position: 2
---

Expand Down
3 changes: 2 additions & 1 deletion docs/setup/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Quick Start
description: This guide lets you quickly install Kmesh.
description: Get Kmesh running in under 10 minutes – prerequisites, install options, and first service test.
keywords: [quick start, install kmesh, kubernetes, istio ambient, ebpf, helm]
sidebar_position: 1
---

Expand Down
2 changes: 2 additions & 0 deletions docs/setup/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Installation Troubleshooting Guide
description: Fix common Kmesh install issues – port conflicts, dependencies, CNI errors, and health checks.
keywords: [troubleshooting, port 15006, libbpf, cni conflict, kmesh, debug]
sidebar_position: 4
---

Expand Down
2 changes: 2 additions & 0 deletions docs/setup/use-enhanced-kernel.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Use Enhanced Kernel
description: Enable full Kmesh features (L7, etc.) on openEuler 23.03 with kernel 6.1+.
keywords: [enhanced kernel, openeuler 23.03, kernel 6.1, l7 traffic, ebpf, kmesh]
sidebar_position: 3
---

Expand Down
2 changes: 2 additions & 0 deletions docs/transpot-layer/accesslog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 6
title: Access Logs
description: Enable and interpret Kmesh TCP access logs with kmeshctl.
keywords: [access logs, kmeshctl, tcp logging, ebpf, monitoring]
---

## Enable Kmesh access logging
Expand Down
2 changes: 2 additions & 0 deletions docs/transpot-layer/l4-metrics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 2
title: Querying L4 Metrics from Prometheus
description: Collect and query Kmesh L4 TCP metrics via Prometheus dashboards.
keywords: [l4 metrics, prometheus, tcp metrics, kmesh, observability]
---

## Preparation
Expand Down
2 changes: 2 additions & 0 deletions docs/transpot-layer/performace-monitoring.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 4
title: Use Grafana to visualize kmesh performance monitoring
description: Build Grafana dashboards to monitor Kmesh daemon performance in real time.
keywords: [grafana, performance monitoring, ebpf, kmesh, dashboards]
---

**NOTE:** This is an immature feature, so we turn it off by default, you can optionally turn it on.
Expand Down
2 changes: 2 additions & 0 deletions docs/transpot-layer/service-metrics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 5
title: Use Grafana to visualize service metrics
description: Visualize Kmesh service-level metrics (traffic, latency, errors) in Grafana.
keywords: [service metrics, grafana, kmesh, dashboards, observability]
---

## Preparation
Expand Down
2 changes: 2 additions & 0 deletions docs/transpot-layer/tcp-authorization.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 1
title: TCP Authorization
description: Enforce IP-based ALLOW/DENY policies for TCP traffic in Kmesh with AuthorizationPolicy.
keywords: [tcp authorization, authorizationpolicy, ip allowlist, kmesh, security]
---


Expand Down
2 changes: 2 additions & 0 deletions docs/transpot-layer/xdp-auth.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 3
title: TCP Authorization in XDP
description: Accelerate TCP authorization by enforcing port/IP policies directly in XDP/eBPF.
keywords: [xdp auth, ebpf, port deny, ip deny, kmesh, authorization]
---

## Authorization in XDP
Expand Down
Loading