Skip to content

Commit 227e260

Browse files
authored
add mesh gateway docs (#3171)
1 parent 68f4ab2 commit 227e260

24 files changed

Lines changed: 377 additions & 92 deletions

File tree

assets/scss/_custom.scss

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -986,8 +986,8 @@ body.td-documentation .td-main > .row > main .td-content .card {
986986

987987
.td-content {
988988
p {
989-
font-size: 16px;
990-
line-height: 1.7;
989+
font-size: 15px;
990+
line-height: 1.2;
991991
margin-bottom: 1.25rem;
992992
}
993993

@@ -1021,14 +1021,14 @@ body.td-documentation .td-main > .row > main .td-content .card {
10211021
}
10221022

10231023
ul, ol {
1024-
font-size: 16px;
1025-
line-height: 1.7;
1024+
font-size: 14px;
1025+
line-height: 1.0;
10261026
margin-bottom: 1.25rem;
10271027
padding-left: 2rem;
10281028

10291029
li {
10301030
margin-bottom: 0.5rem;
1031-
line-height: 1.7;
1031+
line-height: 1.0;
10321032
}
10331033
}
10341034

@@ -1181,6 +1181,7 @@ body.td-documentation .td-main > .row > main .td-content .card {
11811181
ul:has(+ pre) {
11821182
padding-left: 0;
11831183
margin-left: 0;
1184+
height: 0.8rem
11841185
}
11851186

11861187
p + .highlight,

content/en/overview/mesh/_index.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,16 @@ aliases:
33
- /en/overview/mannual/
44
- /en/docs3-v2/
55
- /en/docs3-v2/
6-
always_unfold: true
6+
always_unfold: false
77
description: Instructions on how to set up and run Dubbo in Proxyless mode
88
linkTitle: Service Mesh
99
no_list: true
1010
title: Dubbo Service Mesh
1111
type: docs
1212
weight: 3
1313
---
14-
1514
> The service mesh is currently in an early experimental stage. Standard features will be gradually completed and supported.
1615
17-
Instructions on how to set up and run Dubbod in Proxyless mode.
18-
1916
{{< blocks/section color="white" height="auto">}}
2017
<div class="td-content list-page">
2118
<div class="lead"></div>
@@ -26,7 +23,7 @@ Instructions on how to set up and run Dubbod in Proxyless mode.
2623
<h4 class="card-title">
2724
<a href='{{< relref "./getting-started" >}}'>Getting started</a>
2825
</h4>
29-
<p>Quickly and easily try out Dubbod features.</p>
26+
<p>Quickly and easily try out Dubbo features.</p>
3027
</div>
3128
</div>
3229
<div class="col-sm col-md-6 mb-4">
@@ -40,7 +37,7 @@ Instructions on how to set up and run Dubbod in Proxyless mode.
4037
<div class="col-sm col-md-6 mb-4">
4138
<div class="h-100">
4239
<h4 class="card-title">
43-
<a href='{{< relref "./upgrade" >}}'>Upgrade Dubbod</a>
40+
<a href='{{< relref "./upgrade" >}}'>Upgrade Dubbo</a>
4441
</h4>
4542
<p>Upgrade, downgrade, and manage Dubbo across multiple control planes.</p>
4643
</div>

content/en/overview/mesh/concepts/security.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ title: Security
55
type: docs
66
weight: 2
77
---
8-
9-
Dubbo Service Mesh security provides strong identities, powerful policies, transparent TLS encryption, and authentication tooling to protect your services and data. It follows the same security model as Istio, but is optimized for the Dubbo protocol and sidecarless architecture.
8+
> The service mesh is currently in an early experimental stage. Standard features will be gradually completed and supported.
109
1110
## High-level architecture
1211

@@ -130,6 +129,7 @@ After understanding the basic concepts above, you can:
130129
131130
## Related content
132131
132+
- [Quickstart](/en/overview/mesh/getting-started/)
133133
- [Traffic management](/en/overview/mesh/concepts/traffic-management/)
134134
- [Observability](/en/overview/mesh/concepts/observability/)
135135

content/en/overview/mesh/concepts/traffic-management.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,14 @@ title: Traffic Management
55
type: docs
66
weight: 1
77
---
8+
> The service mesh is currently in an early experimental stage. Resource naming may change.
89
9-
In Dubbo Service Mesh, traffic management is implemented through the collaboration of the Dubbo control plane and the Dubbo Agent. The control plane generates gRPC xDS configuration based on Kubernetes CRDs and pushes it to Dubbo Agent via the xDS protocol, enabling fine-grained control over inter-service traffic.
10-
11-
## Traffic management overview
10+
## Introduction
1211

1312
The traffic management model of Dubbo Service Mesh is aligned with Istio, but optimized for the Dubbo protocol and sidecarless architecture. The core components are:
1413

1514
- **ServiceRoute**: defines routing rules and controls how requests are routed to service instances.
1615
- **SubsetRule**: defines service subsets and traffic policies, such as load balancing, connection pools, TLS settings, etc.
17-
- **MeshConfig**: mesh-wide configuration, including default traffic policies, trust domain, and more.
1816

1917
By configuring these resources, you can achieve traffic routing, load balancing, and resilience without modifying application code.
2018

@@ -26,7 +24,7 @@ ServiceRoute enables you to:
2624
- Route traffic to different versions of a service (for example, v1 and v2).
2725
- Route based on request attributes such as headers and paths.
2826
- Configure weighted routing for canary and gradual rollouts.
29-
- (Planned) Configure timeouts and retries for resilience.
27+
- Configure timeouts and retries for resilience.
3028

3129
### ServiceRoute example
3230

@@ -117,13 +115,35 @@ spec:
117115

118116
Subsets are selected based on Pod labels. In the example above, Pods with label `version: v1` are placed into subset `v1`, and Pods with `version: v2` into subset `v2`.
119117

120-
## Other notes
118+
## Gateway
119+
120+
Gateways provide unified control over ingress and egress traffic in the mesh, allowing you to specify which traffic is allowed to enter or leave the mesh.
121+
122+
Dubbo mesh gateway is implemented based on Kubernetes Gateway API, using Pixiu Gateway as the data plane proxy.
123+
124+
### Gateway example
121125

122-
Because Dubbo Service Mesh uses a sidecarless architecture, the traditional Sidecar resource is replaced by the Dubbo Agent. The Dubbo Agent is embedded into the application process and communicates with the control plane via the xDS protocol.
126+
```yaml
127+
apiVersion: gateway.networking.k8s.io/v1
128+
kind: Gateway
129+
metadata:
130+
name: gateway
131+
namespace: dubbo-ingress
132+
spec:
133+
gatewayClassName: dubbo
134+
listeners:
135+
- name: default
136+
hostname: "*.example.com"
137+
port: 80
138+
protocol: HTTP
139+
allowedRoutes:
140+
namespaces:
141+
from: All
142+
```
123143

124144
## Related content
125145

126-
- [Dubbo Service Mesh Quickstart](/en/overview/quickstart/)
146+
- [Quickstart](/en/overview/mesh/getting-started/)
127147
- [Security concepts](/en/overview/mesh/concepts/security/)
128148
- [Observability](/en/overview/mesh/concepts/observability/)
129149

content/en/overview/mesh/getting-started.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,36 @@ title: Quickstart
55
type: docs
66
weight: 1
77
---
8+
> The service mesh is currently in an early experimental stage. Standard features will be gradually completed and supported.
89
9-
Special thanks to [Megan Yahya's KubeCon EU 2021 talk](https://www.youtube.com/watch?v=cGJXkZ7jiDk) for inspiration and related support.
10+
Dubbo Service Mesh is a proxyless mesh model developed in 2025. This mode introduces no extra proxy forwarding overhead, making it suitable for all performance-sensitive applications and for any deployment environment.
1011

11-
Dubbo Service Mesh is a proxyless mesh model developed in 2025. In this model, processes communicate directly and interact with the control plane via the xDS protocol.
12-
13-
This mode introduces no extra proxy forwarding overhead, making it suitable for latency-sensitive applications and for any deployment environment.
12+
- Each deployed application injects a Dubbo Agent that only provides XDS and SDS services, enabling direct inter-service communication through the native gRPC xDS client.
13+
- All injected agents are based on Kubernetes Gateway API to implement communication between services and external systems.
1414

1515
## Download Dubbo
1616

17-
1. Go to the Dubbo release page and download the installer for your OS, or automatically download the latest version (Linux or macOS):
17+
Go to the Dubbo release page and download the installer for your OS, or automatically download the latest version (Linux or macOS):
1818

1919
```bash
2020
curl -L https://dubbo.apache.org/downloadDubbo | sh -
2121
```
2222

23-
2. Change to the Dubbo package directory:
23+
Change to the Dubbo package directory:
2424

2525
```bash
2626
cd dubbo-x.xx.x
2727
```
2828

2929
## Install Dubbo
3030

31-
1. Install Dubbo with the default profile:
31+
Install Dubbo with the default profile:
3232

3333
```bash
3434
dubboctl install -y
3535
```
3636

37-
2. Label the namespace to tell Dubbo to automatically inject the Dubbo Agent when deploying applications:
37+
Label the namespace to tell Dubbo to automatically inject the Dubbo Agent when deploying applications:
3838

3939
```bash
4040
kubectl label namespace default dubbo-injection=enabled
@@ -44,14 +44,15 @@ kubectl label namespace default dubbo-injection=enabled
4444
<div class="td-content list-page">
4545
<div class="lead"></div>
4646
<header class="article-meta"></header>
47-
<div class="row justify-content-center">
48-
<div class="col-sm col-md-5 mb-4">
49-
<div class="h-100 text-center">
50-
<a class="btn btn-lg btn-primary mb-3" href='{{< relref "./setup/install" >}}' style="min-width: 200px; color: white;">
51-
Get started with Proxyless mode
52-
</a>
53-
</div>
54-
</div>
47+
48+
<div style="width:100%; text-align:center;">
49+
<a
50+
class="btn btn-lg btn-primary"
51+
href='{{< relref "./setup/install" >}}'
52+
style="min-width:200px; color: white; display: inline-block; margin: 0 auto; transform: translateX(-40px);"
53+
>
54+
Get started with Proxyless mode
55+
</a>
5556
</div>
5657
</div>
5758
{{< /blocks/section >}}

content/en/overview/mesh/setup/install/dubboctl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The `dubboctl` command exposes the full DubboOperator API via command-line flags
1414

1515
Before you begin, check the following prerequisites:
1616

17-
1. [Download the Dubbod release](../../getting-started.md)
17+
1. [Download the Dubbo release](../../getting-started.md)
1818

1919
## Install Dubbo using a profile
2020

@@ -43,7 +43,7 @@ dubboctl manifest generate > $HOME/generated-manifest.yaml
4343
To completely uninstall Dubbo from the cluster, run:
4444

4545
```bash
46-
istioctl uninstall --remove -y
46+
dubboctl uninstall --remove -y
4747
```
4848

4949
This removes all Dubbo resources. Future versions will support specifying a manifest file.

content/en/overview/mesh/tasks/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ Learn how to use various Dubbo features through hands-on tasks.
1717
<div class="col-sm col-md-6 mb-4">
1818
<div class="h-100">
1919
<h4 class="card-title">
20-
<a href='{{< relref "../../mannual/java-sdk/tasks/traffic-management" >}}'>Traffic management</a>
20+
<a href='{{< relref "./traffic-management" >}}'>Traffic management</a>
2121
</h4>
2222
<p>Learn how to configure and use traffic management features.</p>
2323
</div>
2424
</div>
2525
<div class="col-sm col-md-6 mb-4">
2626
<div class="h-100">
2727
<h4 class="card-title">
28-
<a href='{{< relref "../../mannual/java-sdk/tasks/security" >}}'>Security</a>
28+
<a href='{{< relref "./security" >}}'>Security</a>
2929
</h4>
3030
<p>Learn how to configure and use security features.</p>
3131
</div>
3232
</div>
3333
<div class="col-sm col-md-6 mb-4">
3434
<div class="h-100">
3535
<h4 class="card-title">
36-
<a href='{{< relref "../../mannual/java-sdk/tasks/observability" >}}'>Observability</a>
36+
<a href='{{< relref "./observability" >}}'>Observability</a>
3737
</h4>
3838
<p>Learn how to configure and use observability features.</p>
3939
</div>
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
description: Observability tasks
3+
linkTitle: Observability
4+
title: Observability
5+
type: docs
6+
weight: 3
7+
---
8+
9+
Learn how to configure and use Dubbo Service Mesh observability features through hands-on tasks.
10+
11+
> Coming soon
12+
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
description: Security tasks
3+
linkTitle: Security
4+
title: Security
5+
type: docs
6+
weight: 2
7+
---
8+
9+
Learn how to configure and use Dubbo Service Mesh security features through hands-on tasks.
10+
11+
> Coming soon
12+
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
description: Traffic management tasks
3+
linkTitle: Traffic Management
4+
title: Traffic Management
5+
type: docs
6+
weight: 1
7+
---
8+
9+
Learn how to configure and use Dubbo Service Mesh traffic management features through hands-on tasks.
10+
11+
{{< blocks/section color="white" height="auto">}}
12+
<div class="td-content list-page">
13+
<div class="lead"></div>
14+
<header class="article-meta"></header>
15+
<div class="row">
16+
<div class="col-sm col-md-6 mb-4">
17+
<div class="h-100">
18+
<h4 class="card-title">
19+
<a href='{{< relref "./ingress" >}}'>Ingress</a>
20+
</h4>
21+
<p>Learn how to configure and manage ingress traffic.</p>
22+
</div>
23+
</div>
24+
</div>
25+
<hr>
26+
</div>
27+
{{< /blocks/section >}}
28+

0 commit comments

Comments
 (0)