This is an automated email from the ASF dual-hosted git repository.
xuetaoli pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/dubbo-go-pixiu.git
The following commit(s) were added to refs/heads/develop by this push:
new ec04b795 chore: update readme (#831)
ec04b795 is described below
commit ec04b79511bdcb2713300b321ab6228161257163
Author: Xuetao Li <[email protected]>
AuthorDate: Mon Dec 8 19:27:06 2025 +0800
chore: update readme (#831)
* update readme
* update link
---
README.md | 38 ++++++++++----------
README_CN.md | 112 +++++++++++++++++++++++++++++++----------------------------
2 files changed, 78 insertions(+), 72 deletions(-)
diff --git a/README.md b/README.md
index 07f3a1cb..97b27ca0 100644
--- a/README.md
+++ b/README.md
@@ -4,21 +4,26 @@
[](https://travis-ci.org/apache/dubbo-go-pixiu)
[](https://codecov.io/gh/apache/dubbo-go-pixiu)
-[](https://pkg.go.dev/github.com/apache/dubbo-go-pixiu?tab=doc)
+[](https://pkg.go.dev/github.com/apache/dubbo-go-pixiu?tab=doc)
[](https://goreportcard.com/report/github.com/apache/dubbo-go-pixiu)

**English** | [中文](README_CN.md)
------
+---
**Dubbo-Go-Pixiu** is a next-generation **AI / API Gateway** built on
**Dubbo-go**, empowering seamless connections to **LLMs** and **MCPs** with
unified access, intelligent extensions, and cost-efficient management. At the
same time, Pixiu bridges external protocols with internal Dubbo clusters,
supporting **HTTP**, **gRPC**, **Dubbo2**, and **Triple** for high-performance,
scalable integration.
+> ⭐ **New Capability:** Pixiu has evolved into a **universal AI Gateway**,
designed to simplify and unify access to **LLMs and AI service providers** —
whether from public vendors or self-hosted models.
+
+> ⭐ **New Capability:** Pixiu has also evolved into a **Kubernetes Ingress
Controller**, enabling native management of API and AI traffic within
Kubernetes clusters through declarative routing and Pixiu’s flexible governance
model.
+
👉 **Try it now:** Explore our official
[samples](https://github.com/apache/dubbo-go-pixiu-samples)
## We've evolved into the **Next-Generation AI Gateway**
Pixiu has evolved into a **universal AI Gateway**, designed to simplify and
unify access to **LLMs and AI service providers** — whether from public vendors
or self-hosted models.
+
With Pixiu, you can:
* **Unified Access to AI Models:**
@@ -36,6 +41,9 @@ With Pixiu, you can:
* **Future-Proof Architecture:**
Designed for the hybrid world of API + AI traffic — bridging traditional
microservices with the AI-first era.
+> ✨ **Now also a Kubernetes Ingress Controller:**
+> Pixiu’s AI gateway abilities can now be applied directly at the cluster
ingress layer — allowing traffic governance, routing, and observability to be
defined declaratively via Kubernetes APIs.
+
👉 **Try it now:** Explore our AI Gateway Samples:
[LLM](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/llm) and
[MCP](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/mcp)
@@ -65,7 +73,7 @@ With Pixiu, you can:
| 🔍 **Service Discovery** | Integrates with Zookeeper, Nacos, or any service
registry to discover Dubbo and Spring Cloud services automatically. |
| ⚖️ **Traffic Governance** | Integrates with Sentinel for fine-grained rate
limiting, circuit breaking, and traffic shaping.
|
| 📈 **Observability** | OpenTelemetry and Jaeger support for full
tracing, metrics, and logging visibility.
|
-| 🎨 **Visual Management** | The **Pixiu-Admin** UI offers real-time visual
configuration for gateway rules and policies.
|
+| 🎨 **Visual Management** | The
**[Pixiu-admin](https://github.com/apache/dubbo-go-pixiu/tree/develop/admin)**
UI offers real-time visual configuration for gateway rules and policies.
|
## Deploying with Docker
@@ -102,33 +110,27 @@ docker run --name pixiu-gateway -p 8888:8888 -d \
dubbo-go-pixiu:local
```
-For more information, visit the [Pixiu Docker
Hub](https://hub.docker.com/r/dubbogopixiu/dubbo-go-pixiu).
## Pixiu Admin – Visual Control Plane
-Manage traffic, routing, and AI model access visually via `pixiu-admin`.
+Manage traffic, routing via `pixiu-admin`.
Start instantly with Docker Compose:
```bash
docker-compose up -d
```
-After starting, you can access the management plane by opening
`http://localhost:8080` in your browser.
+👉 Access admin UI at: [http://localhost:8080](http://localhost:8080)

-👉 **More Details:** please visit
[pixiu-admin](https://github.com/apache/dubbo-go-pixiu/tree/develop/admin)
## Other Projects in the Dubbo-Go-Pixiu Ecosystem
-* **[pixiu-samples](https://github.com/apache/dubbo-go-pixiu-samples)**
- The official sample repository for Dubbo-Go-Pixiu, demonstrating various use
cases and configurations.
-*
**[pixiu-admin](https://github.com/apache/dubbo-go-pixiu/tree/develop/admin)**
- Dubbo-Go-Pixiu Admin is a comprehensive management platform for the
Dubbo-Go-Pixiu gateway. It provides a centralized control plane for
configuring, monitoring, and managing gateway resources via a web-based UI and
RESTful APIs.
-* **[pixiu-api](https://github.com/dubbo-go-pixiu/pixiu-api)**
- Dubbo-Go-Pixiu API provides the API models for the ecosystem and integrates
with Pixiu Admin.
-*
**[benchmark](https://github.com/apache/dubbo-go-pixiu/tree/develop/tools/benchmark)**
- The benchmarking system allows users to measure and analyze key performance
metrics—such as latency, throughput, and QPS—under various load conditions to
evaluate protocol conversion efficiency.
+*
**[dubbo-go-pixiu-samples](https://github.com/apache/dubbo-go-pixiu-samples)**
— Official sample repository demonstrating various use cases
+*
**[pixiu-admin](https://github.com/apache/dubbo-go-pixiu/tree/develop/admin)**
— Visual management plane for configuration & monitoring
+* **[pixiu-api](https://github.com/dubbo-go-pixiu/pixiu-api)** — API / model
definitions for Pixiu Admin
+*
**[benchmark](https://github.com/apache/dubbo-go-pixiu/tree/develop/tools/benchmark)**
— Benchmarking suite for pixiu
## Community & Contribution
@@ -139,10 +141,10 @@ We warmly welcome all forms of contributions\! Whether
it's submitting an issue,
* **Join Our Community**:
-Join our discussion group through Ding talk, WeChat, or Discord.
+ Join our discussion group through Ding talk, WeChat, or Discord.
-discord https://discord.gg/C5ywvytg
-
+ discord https://discord.gg/C5ywvytg
+ 
If you like Dubbo-Go-Pixiu, please ⭐ star us on GitHub!
diff --git a/README_CN.md b/README_CN.md
index c596b7f2..f0c6b60f 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -1,6 +1,6 @@
[](http://alexstocks.github.io/html/dubbogo.html)
-# Dubbo-Go-Pixiu:新一代高性能 AI / API 网关
+# Dubbo-Go-Pixiu: 下一代高性能 AI / API 网关
[](https://travis-ci.org/apache/dubbo-go-pixiu)
[](https://codecov.io/gh/apache/dubbo-go-pixiu)
@@ -12,118 +12,122 @@
---
-**Dubbo-Go-Pixiu** 是一个基于 **Dubbo-go** 构建的新一代 **AI / API 网关**,能够无缝连接 **LLM** 与
**MCP**,提供统一接入、智能扩展与高效的成本管理。同时,Pixiu 还可桥接外部协议与内部 Dubbo 集群,支持
**HTTP**、**gRPC**、**Dubbo2** 与 **Triple**,实现高性能、可扩展的集成能力。
+**Dubbo-Go-Pixiu** 是一个基于 **Dubbo-go** 打造的下一代 **AI / API 网关**,支持无缝连接 **LLMs** 和
**MCPs**,提供统一访问、智能扩展和高效的成本管理。同时,Pixiu 还可以将外部协议与内部 Dubbo 集群进行桥接,支持
**HTTP**、**gRPC**、**Dubbo2** 和 **Triple** 协议,实现高性能、可扩展的集成。
-👉 **立即体验:** 访问我们的官方 [示例项目](https://github.com/apache/dubbo-go-pixiu-samples)
+> ⭐ **新能力:** Pixiu 已进化为一个 **通用 AI 网关**,旨在简化并统一访问 **LLMs 和 AI 服务提供商** ——
无论是公有云供应商还是自托管模型。
-## 我们已进化为「下一代 AI 网关」
+> ⭐ **新能力:** Pixiu 还进化为 **Kubernetes Ingress Controller**,通过声明式路由和 Pixiu
灵活的治理模型,实现在 Kubernetes 集群内原生管理 API 和 AI 流量。
-Pixiu 现已演进为通用型 **AI 网关**,旨在简化并统一访问各种 **LLM 与 AI 服务提供商**——无论是公共云厂商还是自建模型。
+👉 **立即试用:** 探索我们的官方 [示例](https://github.com/apache/dubbo-go-pixiu-samples)
-通过 Pixiu,你可以:
+## 我们已经进化为 **下一代 AI 网关**
-* **统一访问 AI 模型:**
- 通过单一一致的 API 网关层,轻松接入 OpenAI、Anthropic 或任何自定义 / 私有部署的 LLM 或 MCP 服务。
+Pixiu 已经发展成 **通用 AI 网关**,旨在简化并统一访问 **LLMs 和 AI 服务提供商** —— 无论是来自公共供应商还是自建模型。
-* **MCP 服务暴露:**
- 通过 Pixiu 将现有的 HTTP API 等后端服务封装并暴露为 MCP Server,让 AI 应用能够直接调用你的业务逻辑。
+使用 Pixiu,您可以:
+
+* **统一接入 AI 模型:**
+ 通过单一、一致的 API 网关层,轻松连接 OpenAI、Anthropic 或任何 **自定义/本地 LLM 或 MCP** 服务。
+
+* **暴露 MCP 服务器:**
+ 通过 Pixiu,将现有的 HTTP API 和后端服务作为 MCP 服务器暴露,允许 AI 应用直接调用您的业务逻辑。
* **灵活扩展 AI 工作负载:**
- 通过 Pixiu 的插件系统,为请求添加认证、缓存、限流、重试、可观测性,甚至模型编排等功能。
+ 通过 Pixiu 的插件系统,应用认证、缓存、限流、重试策略、可观测性甚至模型编排等功能。
* **多租户与成本高效:**
- 实现细粒度的成本控制、审计与 Token 计费,适用于大规模 AI 部署。
+ 为大规模 AI 部署实施精细化的成本控制、审计和 Token 计费管理。
* **面向未来的架构:**
- 为「API + AI 混合流量」时代而设计,轻松衔接传统微服务与 AI 优先架构。
+ 设计用于混合的 API + AI 流量 —— 将传统的微服务架构与 AI 首先的时代连接起来。
+
+> ✨ **现在也成为 Kubernetes Ingress Controller:**
+> Pixiu 的 AI 网关能力现在可以直接应用于集群入口层 —— 通过 Kubernetes API 声明式定义流量治理、路由和可观测性。
-👉 **立即尝试:** 查看我们的 AI 网关示例:[LLM
示例](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/llm) 与 [MCP
示例](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/mcp)
+👉 **立即试用:** 探索我们的 AI
网关示例:[LLM](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/llm) 和
[MCP](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/mcp)
## 为什么选择 Dubbo-Go-Pixiu?
* **⚡ 高性能:**
- 使用 Go 语言构建,具备极低延迟与高吞吐量,专为大规模 API 流量与 LLM 工作负载优化。
+ 基于 Go 构建,超低延迟和高吞吐量,优化大规模 API 流量和 LLM 工作负载。
-* **🧩 高可扩展性:**
- 强大的 **插件与过滤器框架**,可轻松扩展或定制网关行为——从路由、认证到可观测性与 AI 场景支持。
+* **🧩 高度可扩展:**
+ 强大的 **插件和过滤器框架** 使得扩展或自定义网关行为变得容易 —— 从路由、认证到可观测性和 AI 特定用例。
* **🎯 开发者友好:**
- 简洁配置、统一管理平面与清晰的可观测性,使其成为开发者与平台工程师的理想选择。
+ 简单配置、统一管理平面和清晰的可观测性,使 Pixiu 成为开发者和平台工程师的理想选择。
-* **🌩️ 原生云设计:**
- 完全兼容 Kubernetes,支持声明式配置,轻松集成 Dubbo、Spring Cloud 或自定义后端。
+* **🌩️ 云原生设计:**
+ 在 Kubernetes 中无缝运行,支持声明式配置,轻松集成 Dubbo、Spring Cloud 或自定义后端。
-* **🔗 无缝 Dubbo 集成:**
- 官方推荐的 Sidecar 解决方案,用于将非 Java 应用(如 Go、Python、Node.js 等)连接至 Dubbo 服务。
+* **🔗 无缝对接 Dubbo:**
+ 官方的 Sidecar 解决方案,连接非 Java 应用(Go、Python、Node.js 等)与 Dubbo 服务。
### 核心特性
-| 分类 | 描述 |
-| ------------- | ------------------------------------------------------ |
-| 🚀 **协议处理** | 支持 HTTP、gRPC、Dubbo2、Triple 之间的代理与转换,提供丰富的协议网关能力。 |
-| 🛡️ **安全与认证** | 支持 HTTPS、JWT、OAuth2 等多种安全机制,保护你的 API 与 AI 端点。 |
-| 🔍 **服务发现** | 集成 Zookeeper、Nacos 等注册中心,自动发现 Dubbo 与 Spring Cloud 服务。 |
-| ⚖️ **流量治理** | 集成 Sentinel,支持限流、熔断与流量整形等精细化治理。 |
-| 📈 **可观测性** | 内置 OpenTelemetry 与 Jaeger 支持,实现全链路追踪、指标与日志可视化。 |
-| 🎨 **可视化管理** | 提供 **Pixiu-Admin** UI,实现网关规则与策略的实时可视化配置。 |
+| 类别 | 描述 |
+| ------------- | ---------------------------------------------------------- |
+| 🚀 **协议处理** | 支持 HTTP、gRPC、Dubbo2 和 Triple 协议的代理和转换,提供丰富的协议网关功能。 |
+| 🛡️ **安全与认证** | HTTPS、JWT、OAuth2 等安全机制,保护您的 API 和 AI 服务端点。 |
+| 🔍 **服务发现** | 集成 Zookeeper、Nacos 或任何服务注册中心,自动发现 Dubbo 和 Spring Cloud 服务。 |
+| ⚖️ **流量治理** | 集成 Sentinel,实现精细化的限流、熔断和流量整形。 |
+| 📈 **可观测性** | 支持 OpenTelemetry 和 Jaeger 实现全链路追踪、指标和日志可视化。 |
+| 🎨 **可视化管理** |
**[Pixiu-admin](https://github.com/apache/dubbo-go-pixiu/tree/develop/admin)**
UI 提供实时可视化的网关规则和策略配置管理。 |
## 使用 Docker 部署
-Pixiu 提供官方 Docker 镜像,便于快速部署。
+我们还提供了 Docker 镜像,方便快速部署。
**1. 从源码构建 Docker 镜像**
-请确保当前目录为项目根目录(包含 `Dockerfile` 文件),执行以下命令:
+确保您在项目根目录下(包含 `Dockerfile` 文件),然后运行以下命令构建镜像:
-```bash
-# 可自定义镜像名称与标签,这里使用 dubbo-go-pixiu:local
+```shell
+# 可以自定义镜像名称和标签,这里使用 dubbo-go-pixiu:local
docker build -t dubbo-go-pixiu:local .
```
-构建过程可能需要几分钟。成功后,本地将生成名为 `dubbo-go-pixiu:local` 的镜像。
+这可能需要几分钟时间来构建。一旦成功,您可以使用名为 `dubbo-go-pixiu:local` 的本地镜像。
**2. 使用默认配置运行 Pixiu**
-```bash
+使用刚才构建的本地镜像启动容器:
+
+```shell
docker run --name pixiu-gateway -p 8888:8888 -d dubbo-go-pixiu:local
```
**3. 使用自定义配置文件运行**
-如需使用自定义配置文件,可将本地文件挂载至容器的 `/etc/pixiu/` 目录:
+如果您需要使用自定义配置文件,可以将本地文件挂载到容器的 `/etc/pixiu/` 目录中。
-```bash
+```shell
+# 确保使用您构建的本地镜像名称,例如 dubbo-go-pixiu:local
docker run --name pixiu-gateway -p 8888:8888 -d \
-v /your/local/path/conf.yaml:/etc/pixiu/conf.yaml \
-v /your/local/path/log.yml:/etc/pixiu/log.yml \
dubbo-go-pixiu:local
```
-更多信息请访问 [Pixiu Docker
Hub](https://hub.docker.com/r/dubbogopixiu/dubbo-go-pixiu)。
-
## Pixiu Admin – 可视化控制平面
-通过 `pixiu-admin` 可视化管理流量、路由与 AI 模型接入。
-
-使用 Docker Compose 一键启动:
+通过 `pixiu-admin` 管理流量和路由。
+可以通过 Docker Compose 快速启动:
```bash
docker-compose up -d
```
-启动后,在浏览器中访问 `http://localhost:8080` 即可打开管理面板。
+👉 访问管理员 UI:[http://localhost:8080](http://localhost:8080)

-👉 **更多细节:** 请访问
[pixiu-admin](https://github.com/apache/dubbo-go-pixiu/tree/develop/admin)
-
-## Dubbo-go-pixiu 生态系统的其他项目
+## Dubbo-Go-Pixiu 生态中的其他项目
-- **[pixiu-samples](https://github.com/apache/dubbo-go-pixiu-samples)**
-Pixiu-samples 提供了多个使用 dubbo-go-pixiu 的示例项目,涵盖了从基本的 API 网关功能到复杂的 AI
网关场景,帮助用户快速上手和理解 pixiu 的各种功能。
--
**[pixiu-admin](https://github.com/apache/dubbo-go-pixiu/tree/develop/admin)**
Dubbo-go-pixiu Admin 是 dubbo-go-pixiu 网关的综合管理平台。它提供了一个集中的控制面板,用于通过基于 Web 的用户界面和
RESTful API 来配置、监控和管理网关资源。
-- **[pixiu-api](https://github.com/dubbo-go-pixiu/pixiu-api)**
Dubbo-go-pixiu API 是 dubbo-go-pixiu 生态系统的 API 模型。用于与 pixiu-admin 的集成。
--
**[benchmark](https://github.com/apache/dubbo-go-pixiu/tree/develop/tools/benchmark)**
该基准测试系统允许用户在各种负载条件下测量和分析关键性能指标,如延迟、吞吐量和每秒查询数 (QPS),以评估协议转换过程的效率。
+*
**[dubbo-go-pixiu-samples](https://github.com/apache/dubbo-go-pixiu-samples)**
— 官方示例仓库,展示各种用例
+*
**[pixiu-admin](https://github.com/apache/dubbo-go-pixiu/tree/develop/admin)**
— 可视化配置与监控管理平台
+* **[pixiu-api](https://github.com/dubbo-go-pixiu/pixiu-api)** — Pixiu 管理面 API
/ 模型定义
+*
**[benchmark](https://github.com/apache/dubbo-go-pixiu/tree/develop/tools/benchmark)**
— Pixiu 性能测试套件
## 社区与贡献
@@ -136,8 +140,8 @@ Pixiu-samples 提供了多个使用 dubbo-go-pixiu 的示例项目,涵盖了
* **加入社区:**
可通过钉钉、微信或 Discord 加入我们的讨论群组。
-Discord: [https://discord.gg/C5ywvytg](https://discord.gg/C5ywvytg)
-
+ Discord: [https://discord.gg/C5ywvytg](https://discord.gg/C5ywvytg)
+ 
如果你喜欢 Dubbo-Go-Pixiu,请在 GitHub 上给我们点个 ⭐!