Skip to content

Commit b2f9bf9

Browse files
johnlannijohnlanni
committed
update README
1 parent 9257077 commit b2f9bf9

File tree

3 files changed

+302
-255
lines changed

3 files changed

+302
-255
lines changed

‎README.md

+72-136
Original file line numberDiff line numberDiff line change
@@ -14,216 +14,152 @@
1414
<a href="https://trendshift.io/repositories/10918" target="_blank"><img src="https://trendshift.io/api/badge/repositories/10918" alt="alibaba%2Fhigress | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
1515
</div>
1616

17-
[**官网**](https://higress.cn/) &nbsp; |
18-
&nbsp; [**文档**](https://higress.cn/docs/latest/overview/what-is-higress/) &nbsp; |
19-
&nbsp; [**博客**](https://higress.cn/blog/) &nbsp; |
20-
&nbsp; [**电子书**](https://higress.cn/docs/ebook/wasm14/) &nbsp; |
21-
&nbsp; [**开发指引**](https://higress.cn/docs/latest/dev/architecture/) &nbsp; |
22-
&nbsp; [**AI插件**](https://higress.cn/plugin/) &nbsp;
23-
17+
[**Official Site**](https://higress.io/en-us/) &nbsp; |
18+
&nbsp; [**Docs**](https://higress.io/en-us/docs/overview/what-is-higress) &nbsp; |
19+
&nbsp; [**Blog**](https://higress.io/en-us/blog) &nbsp; |
20+
&nbsp; [**Developer**](https://higress.io/en-us/docs/developers/developers_dev) &nbsp; |
21+
&nbsp; [**Higress in Cloud**](https://www.alibabacloud.com/product/microservices-engine?spm=higress-website.topbar.0.0.0) &nbsp;
2422

2523

2624
<p>
27-
<a href="README_EN.md"> English <a/>| 中文 | <a href="README_JP.md"> 日本語 <a/>
25+
English | <a href="README_ZH.md">中文<a/> | <a href="README_JP.md">日本語<a/>
2826
</p>
2927

28+
Higress is a cloud-native API gateway based on Istio and Envoy, which can be extended with Wasm plugins written in Go/Rust/JS. It provides dozens of ready-to-use general-purpose plugins and an out-of-the-box console (try the [demo here](http://demo.higress.io/)).
3029

31-
Higress 是一款云原生 API 网关，内核基于 Istio 和 Envoy，可以用 Go/Rust/JS 等编写 Wasm 插件，提供了数十个现成的通用插件，以及开箱即用的控制台（demo 点[这里](http://demo.higress.io/)）
32-
33-
Higress 在阿里内部为解决 Tengine reload 对长连接业务有损，以及 gRPC/Dubbo 负载均衡能力不足而诞生。
30+
Higress was born within Alibaba to solve the issues of Tengine reload affecting long-connection services and insufficient load balancing capabilities for gRPC/Dubbo.
3431

35-
阿里云基于 Higress 构建了云原生 API 网关产品，为大量企业客户提供 99.99% 的网关高可用保障服务能力。
32+
Alibaba Cloud has built its cloud-native API gateway product based on Higress, providing 99.99% gateway high availability guarantee service capabilities for a large number of enterprise customers.
3633

37-
Higress 的 AI 网关能力支持国内外所有[主流模型供应商](https://github.com/alibaba/higress/tree/main/plugins/wasm-go/extensions/ai-proxy/provider)和基于 vllm/ollama 等自建的 DeepSeek 模型；在阿里云内部支撑了通义千问 APP、百炼大模型 API、机器学习 PAI 平台等 AI 业务。同时服务国内头部的 AIGC 企业（如零一万物），以及 AI 产品（如 FastGPT）
34+
Higress's AI gateway capabilities support all [mainstream model providers](https://github.com/alibaba/higress/tree/main/plugins/wasm-go/extensions/ai-proxy/provider) both domestic and international, as well as self-built DeepSeek models based on vllm/ollama. Within Alibaba Cloud, it supports AI businesses such as Tongyi Qianwen APP, Bailian large model API, and machine learning PAI platform. It also serves leading AIGC enterprises (such as Zero One Infinite) and AI products (such as FastGPT).
3835

3936
![](https://img.alicdn.com/imgextra/i2/O1CN011AbR8023V8R5N0HcA_!!6000000007260-2-tps-1080-606.png)
4037

41-
4238
## Summary
4339

44-
- [**快速开始**](#快速开始)
45-
- [**功能展示**](#功能展示)
46-
- [**使用场景**](#使用场景)
47-
- [**核心优势**](#核心优势)
48-
- [**社区**](#社区)
40+
- [**Quick Start**](#quick-start)
41+
- [**Feature Showcase**](#feature-showcase)
42+
- [**Use Cases**](#use-cases)
43+
- [**Core Advantages**](#core-advantages)
44+
- [**Community**](#community)
4945

50-
## 快速开始
46+
## Quick Start
5147

52-
Higress 只需 Docker 即可启动，方便个人开发者在本地搭建学习，或者用于搭建简易站点:
48+
Higress can be started with just Docker, making it convenient for individual developers to set up locally for learning or for building simple sites:
5349

5450
```bash
55-
# 创建一个工作目录
51+
# Create a working directory
5652
mkdir higress; cd higress
57-
# 启动 higress，配置文件会写到工作目录下
53+
# Start higress, configuration files will be written to the working directory
5854
docker run -d --rm --name higress-ai -v ${PWD}:/data \
5955
-p 8001:8001 -p 8080:8080 -p 8443:8443 \
6056
higress-registry.cn-hangzhou.cr.aliyuncs.com/higress/all-in-one:latest
6157
```
6258

63-
监听端口说明如下：
59+
Port descriptions:
6460

65-
- 8001 端口：Higress UI 控制台入口
66-
- 8080 端口：网关 HTTP 协议入口
67-
- 8443 端口：网关 HTTPS 协议入口
61+
- Port 8001: Higress UI console entry
62+
- Port 8080: Gateway HTTP protocol entry
63+
- Port 8443: Gateway HTTPS protocol entry
6864

69-
**Higress 的所有 Docker 镜像都一直使用自己独享的仓库，不受 Docker Hub 境内访问受限的影响**
65+
**All Higress Docker images use their own dedicated repository, unaffected by Docker Hub access restrictions in certain regions**
7066

71-
K8s 下使用 Helm 部署等其他安装方式可以参考官网 [Quick Start 文档](https://higress.cn/docs/latest/user/quickstart/)。
67+
For other installation methods such as Helm deployment under K8s, please refer to the official [Quick Start documentation](https://higress.io/en-us/docs/user/quickstart).
7268

73-
如果您是在云上部署，生产环境推荐使用[企业版](https://higress.io/cloud/)，开发测试可以使用下面一键部署社区版：
69+
If you are deploying in the cloud, the enterprise version is recommended for production environments, and you can use the one-click deployment community version below for development and testing:
7470

7571
[![Deploy on AlibabaCloud ComputeNest](https://service-info-public.oss-cn-hangzhou.aliyuncs.com/computenest.svg)](https://computenest.console.aliyun.com/service/instance/create/default?type=user&ServiceName=Higress社区版)
7672

73+
## Use Cases
7774

78-
## 使用场景
75+
- **AI Gateway**:
7976

80-
- **AI 网关**:
77+
Higress can connect to all LLM model providers both domestic and international using a unified protocol, while also providing rich AI observability, multi-model load balancing/fallback, AI token rate limiting, AI caching, and other capabilities:
8178

82-
Higress 能够用统一的协议对接国内外所有 LLM 模型厂商，同时具备丰富的 AI 可观测、多模型负载均衡/fallback、AI token 流控、AI 缓存等能力：
79+
![](https://img.alicdn.com/imgextra/i2/O1CN01izmBNX1jbHT7lP3Yr_!!6000000004566-0-tps-1920-1080.jpg)
8380

84-
![](https://img.alicdn.com/imgextra/i1/O1CN01fNnhCp1cV8mYPRFeS_!!6000000003605-0-tps-1080-608.jpg)
81+
- **MCP Server Hosting**:
8582

86-
- **MCP Server 托管**:
83+
Higress, as an Envoy-based API gateway, supports hosting MCP Servers through its plugin mechanism. MCP (Model Context Protocol) is essentially an AI-friendly API that enables AI Agents to more easily call various tools and services. Higress provides unified capabilities for authentication, authorization, rate limiting, and observability for tool calls, simplifying the development and deployment of AI applications.
8784

88-
Higress 作为基于 Envoy 的 API 网关，支持通过插件方式托管 MCP Server。MCP（Model Context Protocol）本质是面向 AI 更友好的 API，使 AI Agent 能够更容易地调用各种工具和服务。Higress 可以统一处理工具调用的认证/鉴权/限流/观测等能力，简化 AI 应用的开发和部署。
85+
![](https://img.alicdn.com/imgextra/i1/O1CN01wv8H4g1mS4MUzC1QC_!!6000000004952-2-tps-1764-597.png)
8986

90-
![](https://img.alicdn.com/imgextra/i3/O1CN01K4qPUX1OliZa8KIPw_!!6000000001746-2-tps-1581-615.png)
87+
By hosting MCP Servers with Higress, you can achieve:
88+
- Unified authentication and authorization mechanisms, ensuring the security of AI tool calls
89+
- Fine-grained rate limiting to prevent abuse and resource exhaustion
90+
- Comprehensive audit logs recording all tool call behaviors
91+
- Rich observability for monitoring the performance and health of tool calls
92+
- Simplified deployment and management through Higress's plugin mechanism for quickly adding new MCP Servers
93+
- Dynamic updates without disruption: Thanks to Envoy's friendly handling of long connections and Wasm plugin's dynamic update mechanism, MCP Server logic can be updated on-the-fly without any traffic disruption or connection drops
9194

92-
通过 Higress 托管 MCP Server，可以实现：
93-
- 统一的认证和鉴权机制，确保 AI 工具调用的安全性
94-
- 精细化的速率限制，防止滥用和资源耗尽
95-
- 完整的审计日志，记录所有工具调用行为
96-
- 丰富的可观测性，监控工具调用的性能和健康状况
97-
- 简化的部署和管理，通过 Higress 插件机制快速添加新的 MCP Server
95+
- **Kubernetes ingress controller**:
9896

99-
- **Kubernetes Ingress 网关**:
100-
101-
Higress 可以作为 K8s 集群的 Ingress 入口网关, 并且兼容了大量 K8s Nginx Ingress 的注解，可以从 K8s Nginx Ingress 快速平滑迁移到 Higress。
97+
Higress can function as a feature-rich ingress controller, which is compatible with many annotations of K8s' nginx ingress controller.
10298

103-
支持 [Gateway API](https://gateway-api.sigs.k8s.io/) 标准，支持用户从 Ingress API 平滑迁移到 Gateway API。
104-
105-
相比 ingress-nginx，资源开销大幅下降，路由变更生效速度有十倍提升：
106-
107-
![](https://img.alicdn.com/imgextra/i1/O1CN01bhEtb229eeMNBWmdP_!!6000000008093-2-tps-750-547.png)
108-
![](https://img.alicdn.com/imgextra/i1/O1CN01bqRets1LsBGyitj4S_!!6000000001354-2-tps-887-489.png)
99+
[Gateway API](https://gateway-api.sigs.k8s.io/) support is coming soon and will support smooth migration from Ingress API to Gateway API.
109100

110-
- **微服务网关**:
101+
- **Microservice gateway**:
111102

112-
Higress 可以作为微服务网关, 能够对接多种类型的注册中心发现服务配置路由，例如 Nacos, ZooKeeper, Consul, Eureka 等。
103+
Higress can function as a microservice gateway, which can discovery microservices from various service registries, such as Nacos, ZooKeeper, Consul, Eureka, etc.
113104

114-
并且深度集成了 [Dubbo](https://github.com/apache/dubbo), [Nacos](https://github.com/alibaba/nacos), [Sentinel](https://github.com/alibaba/Sentinel) 等微服务技术栈，基于 Envoy C++ 网关内核的出色性能，相比传统 Java 类微服务网关，可以显著降低资源使用率，减少成本。
115-
116-
![](https://img.alicdn.com/imgextra/i4/O1CN01v4ZbCj1dBjePSMZ17_!!6000000003698-0-tps-1613-926.jpg)
105+
It deeply integrates with [Dubbo](https://github.com/apache/dubbo), [Nacos](https://github.com/alibaba/nacos), [Sentinel](https://github.com/alibaba/Sentinel) and other microservice technology stacks.
117106

118-
- **安全防护网关**:
107+
- **Security gateway**:
108+
109+
Higress can be used as a security gateway, supporting WAF and various authentication strategies, such as key-auth, hmac-auth, jwt-auth, basic-auth, oidc, etc.
119110

120-
Higress 可以作为安全防护网关， 提供 WAF 的能力，并且支持多种认证鉴权策略，例如 key-auth, hmac-auth, jwt-auth, basic-auth, oidc 等。
121111

122-
## 核心优势
112+
## Core Advantages
123113

124-
- **生产等级**
114+
- **Production Grade**
125115

126-
脱胎于阿里巴巴2年多生产验证的内部产品，支持每秒请求量达数十万级的大规模场景。
116+
Born from Alibaba's internal product with over 2 years of production validation, supporting large-scale scenarios with hundreds of thousands of requests per second.
127117

128-
彻底摆脱 Nginx reload 引起的流量抖动，配置变更毫秒级生效且业务无感。对 AI 业务等长连接场景特别友好。
118+
Completely eliminates traffic jitter caused by Nginx reload, configuration changes take effect in milliseconds and are transparent to business. Especially friendly to long-connection scenarios such as AI businesses.
129119

130-
- **流式处理**
120+
- **Streaming Processing**
131121

132-
支持真正的完全流式处理请求/响应 Body，Wasm 插件很方便地自定义处理 SSE （Server-Sent Events）等流式协议的报文。
122+
Supports true complete streaming processing of request/response bodies, Wasm plugins can easily customize the handling of streaming protocols such as SSE (Server-Sent Events).
133123

134-
在 AI 业务等大带宽场景下，可以显著降低内存开销。
124+
In high-bandwidth scenarios such as AI businesses, it can significantly reduce memory overhead.
135125

136-
- **便于扩展**
126+
- **Easy to Extend**
137127

138-
提供丰富的官方插件库，涵盖 AI、流量管理、安全防护等常用功能，满足90%以上的业务场景需求。
128+
Provides a rich official plugin library covering AI, traffic management, security protection and other common functions, meeting more than 90% of business scenario requirements.
139129

140-
主打 Wasm 插件扩展，通过沙箱隔离确保内存安全，支持多种编程语言，允许插件版本独立升级，实现流量无损热更新网关逻辑。
130+
Focuses on Wasm plugin extensions, ensuring memory safety through sandbox isolation, supporting multiple programming languages, allowing plugin versions to be upgraded independently, and achieving traffic-lossless hot updates of gateway logic.
141131

142-
- **安全易用**
132+
- **Secure and Easy to Use**
143133

144-
基于 Ingress API 和 Gateway API 标准，提供开箱即用的 UI 控制台，WAF 防护插件、IP/Cookie CC 防护插件开箱即用。
145-
146-
支持对接 Let's Encrypt 自动签发和续签免费证书，并且可以脱离 K8s 部署，一行 Docker 命令即可启动，方便个人开发者使用。
147-
148-
149-
## 功能展示
150-
151-
### AI 网关 Demo 展示
152-
153-
[从 OpenAI 到其他大模型，30 秒完成迁移
154-
](https://www.bilibili.com/video/BV1dT421a7w7/?spm_id_from=333.788.recommend_more_video.14)
155-
156-
157-
### Higress UI 控制台
158-
159-
- **丰富的可观测**
160-
161-
提供开箱即用的可观测，Grafana&Prometheus 可以使用内置的也可对接自建的
162-
163-
![](./docs/images/monitor.gif)
164-
165-
166-
- **插件扩展机制**
167-
168-
官方提供了多种插件，用户也可以[开发](./plugins/wasm-go)自己的插件，构建成 docker/oci 镜像后在控制台配置，可以实时变更插件逻辑，对流量完全无损。
169-
170-
![](./docs/images/plugin.gif)
171-
172-
173-
- **多种服务发现**
174-
175-
默认提供 K8s Service 服务发现，通过配置可以对接 Nacos/ZooKeeper 等注册中心实现服务发现，也可以基于静态 IP 或者 DNS 来发现
176-
177-
![](./docs/images/service-source.gif)
178-
179-
180-
- **域名和证书**
181-
182-
可以创建管理 TLS 证书，并配置域名的 HTTP/HTTPS 行为，域名策略里支持对特定域名生效插件
183-
184-
![](./docs/images/domain.gif)
185-
186-
187-
- **丰富的路由能力**
188-
189-
通过上面定义的服务发现机制，发现的服务会出现在服务列表中；创建路由时，选择域名，定义路由匹配机制，再选择目标服务进行路由；路由策略里支持对特定路由生效插件
190-
191-
![](./docs/images/route-service.gif)
192-
193-
194-
## 社区
195-
196-
### 感谢
197-
198-
如果没有 Envoy 和 Istio 的开源工作，Higress 就不可能实现，在这里向这两个项目献上最诚挚的敬意。
134+
Based on Ingress API and Gateway API standards, provides out-of-the-box UI console, WAF protection plugin, IP/Cookie CC protection plugin ready to use.
199135

200-
### 交流群
136+
Supports connecting to Let's Encrypt for automatic issuance and renewal of free certificates, and can be deployed outside of K8s, started with a single Docker command, convenient for individual developers to use.
201137

202-
![image](https://img.alicdn.com/imgextra/i2/O1CN01fZefEP1aPWkzG3A19_!!6000000003322-0-tps-720-405.jpg)
138+
## Community
203139

204-
### 技术分享
140+
[Slack](https://w1689142780-euk177225.slack.com/archives/C05GEL4TGTG): to get invited go [here](https://communityinviter.com/apps/w1689142780-euk177225/higress).
205141

206-
微信公众号：
142+
### Thanks
207143

208-
![](https://img.alicdn.com/imgextra/i1/O1CN01WnQt0q1tcmqVDU73u_!!6000000005923-0-tps-258-258.jpg)
144+
Higress would not be possible without the valuable open-source work of projects in the community. We would like to extend a special thank you to Envoy and Istio.
209145

210-
### 关联仓库
146+
### Related Repositories
211147

212-
- Higress 控制台：https://github.com/higress-group/higress-console
213-
- Higress（独立运行版）：https://github.com/higress-group/higress-standalone
148+
- Higress Console: https://github.com/higress-group/higress-console
149+
- Higress Standalone: https://github.com/higress-group/higress-standalone
214150

215-
### 贡献者
151+
### Contributors
216152

217153
<a href="https://github.com/alibaba/higress/graphs/contributors">
218154
<img alt="contributors" src="https://contrib.rocks/image?repo=alibaba/higress"/>
219155
</a>
220156

221157
### Star History
222158

223-
[![Star History](https://api.star-history.com/svg?repos=alibaba/higress&type=Date)](https://star-history.com/#alibaba/higress&Date)
159+
[![Star History Chart](https://api.star-history.com/svg?repos=alibaba/higress&type=Date)](https://star-history.com/#alibaba/higress&Date)
224160

225161
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
226162
<a href="#readme-top" style="text-decoration: none; color: #007bff; font-weight: bold;">
227-
↑ 返回顶部 ↑
163+
↑ Back to Top ↑
228164
</a>
229165
</p>

0 commit comments

Comments
 (0)