Skip to content

Commit

Permalink
feat: 🎸 rename higress.io => higress.cn
Browse files Browse the repository at this point in the history
  • Loading branch information
heimanba committed Dec 10, 2024
1 parent 245694b commit ea37754
Show file tree
Hide file tree
Showing 21 changed files with 239 additions and 239 deletions.
426 changes: 213 additions & 213 deletions site.txt

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const feedbackBody = `
---
#### 文档详细信息
⚠ *请勿编辑此部分。higress.io ➟ GitHub 问题链接必须具有此部分。*
⚠ *请勿编辑此部分。higress.cn ➟ GitHub 问题链接必须具有此部分。*
* Version ID: 2bac3769-2613-f739-4796-0737c7cd8919
* Content: [${title}](${Astro.url.href})
Expand Down
2 changes: 1 addition & 1 deletion src/content/blog/30-line-wasm.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ category: "case"
在11月15号的直播 《Higress 开源背后的发展历程和上手 Demo 演示》中,为大家演示了 Higress 的 Wasm 插件如何面向 Ingress 资源进行配置生效,本文对当天的 Demo 进行一个回顾,并说明背后的原理机制。
<!--truncate-->
本文中 Demo 运行的前提,需要在 K8s 集群中安装了 Higress,并生效了下面这份 quickstart 配置:
[https://higress.io/samples/quickstart.yaml](https://higress.cn/samples/quickstart.yaml)
[https://higress.cn/samples/quickstart.yaml](https://higress.cn/samples/quickstart.yaml)
这个 Demo 要实现的功能是一个 Mock 应答的功能,需要实现根据配置的内容,返回 HTTP 应答。
本文会按以下方式进行介绍:

Expand Down
4 changes: 2 additions & 2 deletions src/content/blog/DeployOnWindows.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,15 @@ ipconfig


```
curl -fsSL https://higress.io/standalone/get-higress.sh | bash -s -- -c nacos://192.168.0.1:8848 --nacos-username=nacos --nacos-password=nacos
curl -fsSL https://higress.cn/standalone/get-higress.sh | bash -s -- -c nacos://192.168.0.1:8848 --nacos-username=nacos --nacos-password=nacos
```

请将 `192.168.0.1` 替换为 Nacos 服务器的 IP(如果 Nacos 部署在本机,请不要使用如 `localhost``127.0.0.1` 的 Loopback 地址),并按需调整 `--nacos-username``--nacos-password` 的取值。如果 Nacos 服务未开启认证功能,则可以移除这两个参数。


在这里未开启授权服务,直接使用WLANIP替换对应的IP
```shell
curl -fsSL https://higress.io/standalone/get-higress.sh | bash -s -- -c nacos://10.30.0.225:8848
curl -fsSL https://higress.cn/standalone/get-higress.sh | bash -s -- -c nacos://10.30.0.225:8848

```
输入命令等待部署,即可看到生成的用户名与密码
Expand Down
2 changes: 1 addition & 1 deletion src/content/blog/Higress-gvr7dx_awbbpb_rf96wdxo9lctgng8.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ keywords: ["Higress"]
authors: "CH3CHO"
---

**一、前言**<br />**什么是 Prompt Engingering**<br />提示工程(Prompt Engingering),也被称为上下文提示(In-Context Prompting),指的是通过结构化文本等方式来完善提示词,引导LLM输出我们期望的结果。通过提示词工程可以在不更新模型权重的情况下,让LLM完成不同类型的任务。面对同样一个问题,为LLM设置不同的提示词,能够得到不同的回答结果。我们可以通过对Prompt的优化提升LLM的回答精度。<br />例如:<br />![](/img/1728551152236.png)<br />**点击图片可查看完整电子表格**<br />**什么是 AI Gateway**<br />AI Gateway的定义是AI Native的API Gateway,是基于API Gateway的能⼒来满⾜AI Native的需求。例如:<br />• 将传统的QPS限流扩展到Token限流<br />• 将传统的负载均衡/重试/fallback能力延伸,支持对接多个大模型厂商API,提高整体稳定性<br />• 扩展可观测能力,支持不同模型之间效果的对比A/B Test,以及对话上下⽂链路Tracing等<br />Higress (https://github.com/alibaba/higress) 是阿⾥云开源的⼀款AI Gateway,为开发者提供了一站式的 AI 插件集和增强后端模型调度处理能力,使得 AI 与网关的集成更加便捷和高效。官方提供了丰富的插件库,涵盖 AI、流量管理、安全防护等常用功能,满足90%以上的业务场景需求。此外还支持 Wasm 插件扩展,支持多语言编写 Wasm 插件,插件更新采用热插拔机制对流量无损。<br />本文主要基于 Higress 的 Wasm 插件机制,使用 Go 进行插件的整体开发和能力增强。具体可以参考:https://higress.io/docs/latest/plugins/custom/
**一、前言**<br />**什么是 Prompt Engingering**<br />提示工程(Prompt Engingering),也被称为上下文提示(In-Context Prompting),指的是通过结构化文本等方式来完善提示词,引导LLM输出我们期望的结果。通过提示词工程可以在不更新模型权重的情况下,让LLM完成不同类型的任务。面对同样一个问题,为LLM设置不同的提示词,能够得到不同的回答结果。我们可以通过对Prompt的优化提升LLM的回答精度。<br />例如:<br />![](/img/1728551152236.png)<br />**点击图片可查看完整电子表格**<br />**什么是 AI Gateway**<br />AI Gateway的定义是AI Native的API Gateway,是基于API Gateway的能⼒来满⾜AI Native的需求。例如:<br />• 将传统的QPS限流扩展到Token限流<br />• 将传统的负载均衡/重试/fallback能力延伸,支持对接多个大模型厂商API,提高整体稳定性<br />• 扩展可观测能力,支持不同模型之间效果的对比A/B Test,以及对话上下⽂链路Tracing等<br />Higress (https://github.com/alibaba/higress) 是阿⾥云开源的⼀款AI Gateway,为开发者提供了一站式的 AI 插件集和增强后端模型调度处理能力,使得 AI 与网关的集成更加便捷和高效。官方提供了丰富的插件库,涵盖 AI、流量管理、安全防护等常用功能,满足90%以上的业务场景需求。此外还支持 Wasm 插件扩展,支持多语言编写 Wasm 插件,插件更新采用热插拔机制对流量无损。<br />本文主要基于 Higress 的 Wasm 插件机制,使用 Go 进行插件的整体开发和能力增强。具体可以参考:https://higress.cn/docs/latest/plugins/custom/

**二、Geo-IP插件与AI 提示词修饰插件的结合与使用**<br />**插件参数配置**<br />**配置Geo-IP插件**<br />启用Geo-IP插件(目前仅支持IPv4),并配置:

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/ebook/en/wasm16.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ func (ctx *CommonPluginCtx[PluginConfig]) OnPluginStart(int) types.OnPluginStart
> 这里我们不进一步分析插件解析过程,后续在插件生效原理章节从控制面和数据面详细分析插件全局、路由、域名、服务级别生效原理。
大部分情况下插件全局配置和路由、域名、服务级别配置规则是一样的,因此在定义插件时只需要调用 wrapper.ParseConfigBy(parseConfig) 来设置插件配置解析回调钩子函数。
而有些插件(如 [basic-auth](https://higress.io/docs/latest/plugins/authentication/basic-auth/))的全局配置和路由、域名、服务级别配置规则是不一样的。baisc-auth 插件配置 YAML 样例如下:
而有些插件(如 [basic-auth](https://higress.cn/docs/latest/plugins/authentication/basic-auth/))的全局配置和路由、域名、服务级别配置规则是不一样的。baisc-auth 插件配置 YAML 样例如下:
```yaml
apiVersion: extensions.higress.io/v1alpha1
kind: WasmPlugin
Expand Down Expand Up @@ -635,7 +635,7 @@ tinygo build -scheduler=none -target=wasi -gc=custom -tags='custommalloc nottiny
### 2.5 Envoy 请求缓存区限制
当自定义插件使用 `onHttpRequestBody` 非流式传输,当请求超过 `downstream` 缓存区限制(默认是 32k)。Envoy 会给用户返回 413, 同时报 `request_payload_too_large` 错误。
比如在 AI 长上下文中场景中可能会碰到这个问题,这个问题可以通过参考 [全局配置说明](https://higress.io/docs/latest/user/configmap/) 调整 Downstream 配置项 `connectionBufferLimits` 解决, 或者 使用 `SetRequestBodyBufferLimit` 方法设置请求 body buffer limit 解决。 关于如何使用 `SetRequestBodyBufferLimit` 可以参考 Higress 官方提供 [ai-proxy 插件](https://github.com/alibaba/higress/blob/main/plugins/wasm-go/extensions/ai-proxy/main.go#L81) 的实现。
比如在 AI 长上下文中场景中可能会碰到这个问题,这个问题可以通过参考 [全局配置说明](https://higress.cn/docs/latest/user/configmap/) 调整 Downstream 配置项 `connectionBufferLimits` 解决, 或者 使用 `SetRequestBodyBufferLimit` 方法设置请求 body buffer limit 解决。 关于如何使用 `SetRequestBodyBufferLimit` 可以参考 Higress 官方提供 [ai-proxy 插件](https://github.com/alibaba/higress/blob/main/plugins/wasm-go/extensions/ai-proxy/main.go#L81) 的实现。
## 3 Envoy 属性(Attributes)
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/ebook/en/wasm17.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ keywords: [Higress]

## 1 Envoy 集群(Cluster)名称和服务发现来源

Higress 插件的 Go SDK 在进行 HTTP 和 Redis 调用时,是通过指定的集群名称来识别并连接到相应的 Envoy 集群。 此外,Higress 利用 [McpBridge](https://higress.io/docs/latest/user/mcp-bridge/) 支持多种服务发现机制,包括静态配置(static)、DNS、Kubernetes 服务、Eureka、Consul、Nacos、以及 Zookeeper 等。
Higress 插件的 Go SDK 在进行 HTTP 和 Redis 调用时,是通过指定的集群名称来识别并连接到相应的 Envoy 集群。 此外,Higress 利用 [McpBridge](https://higress.cn/docs/latest/user/mcp-bridge/) 支持多种服务发现机制,包括静态配置(static)、DNS、Kubernetes 服务、Eureka、Consul、Nacos、以及 Zookeeper 等。
每种服务发现机制对应的集群名称生成规则都有所不同,这些规则在 cluster_wrapper.go 代码文件中有所体现。
为了包装不同的服务发现机制,Higress 插件 Go SDK 定义了 Cluster 接口,该接口包含两个方法:ClusterName 和 HostName。
```golang
Expand Down Expand Up @@ -624,7 +624,7 @@ spec:
以此类推。这种情况 Redis 调用也是一样处理。 关于回调链可以参考 Higress 官方提供 [ai-agent](https://github.com/alibaba/higress/blob/main/plugins/wasm-go/extensions/ai-agent/main.go#L169) 插件功能。

## 参考
- [1][Mcp Bridge 配置说明](https://higress.io/docs/latest/user/mcp-bridge/)
- [1][Mcp Bridge 配置说明](https://higress.cn/docs/latest/user/mcp-bridge/)



Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/ebook/zh-cn/wasm16.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ func (ctx *CommonPluginCtx[PluginConfig]) OnPluginStart(int) types.OnPluginStart
> 这里我们不进一步分析插件解析过程,后续在插件生效原理章节从控制面和数据面详细分析插件全局、路由、域名、服务级别生效原理。
大部分情况下插件全局配置和路由、域名、服务级别配置规则是一样的,因此在定义插件时只需要调用 wrapper.ParseConfigBy(parseConfig) 来设置插件配置解析回调钩子函数。
而有些插件(如 [basic-auth](https://higress.io/docs/latest/plugins/authentication/basic-auth/))的全局配置和路由、域名、服务级别配置规则是不一样的。baisc-auth 插件配置 YAML 样例如下:
而有些插件(如 [basic-auth](https://higress.cn/docs/latest/plugins/authentication/basic-auth/))的全局配置和路由、域名、服务级别配置规则是不一样的。baisc-auth 插件配置 YAML 样例如下:
```yaml
apiVersion: extensions.higress.io/v1alpha1
kind: WasmPlugin
Expand Down Expand Up @@ -640,7 +640,7 @@ types.ActionPause 实际上对应就是这个状态。
### 2.5 Envoy 请求缓存区限制
当自定义插件使用 `onHttpRequestBody` 非流式传输,当请求超过 `downstream` 缓存区限制(默认是 32k)。Envoy 会给用户返回 413, 同时报 `request_payload_too_large` 错误。
比如在 AI 长上下文中场景中可能会碰到这个问题,这个问题可以通过参考 [全局配置说明](https://higress.io/docs/latest/user/configmap/) 调整 Downstream 配置项 `connectionBufferLimits` 解决, 或者使用 `SetRequestBodyBufferLimit` 方法设置请求 body buffer limit 解决。 关于如何使用 `SetRequestBodyBufferLimit` 可以参考 Higress 官方提供 [ai-proxy 插件](https://github.com/alibaba/higress/blob/main/plugins/wasm-go/extensions/ai-proxy/main.go#L81) 的实现。
比如在 AI 长上下文中场景中可能会碰到这个问题,这个问题可以通过参考 [全局配置说明](https://higress.cn/docs/latest/user/configmap/) 调整 Downstream 配置项 `connectionBufferLimits` 解决, 或者使用 `SetRequestBodyBufferLimit` 方法设置请求 body buffer limit 解决。 关于如何使用 `SetRequestBodyBufferLimit` 可以参考 Higress 官方提供 [ai-proxy 插件](https://github.com/alibaba/higress/blob/main/plugins/wasm-go/extensions/ai-proxy/main.go#L81) 的实现。
相应的,如果使用`onHttpResponseBody` 非流式传输,如果响应 body 超过`downstream` 缓存区限制,也会导致传输失败。例如使用 curl 时可能出现报错 `curl: (18) transfer closed with outstanding read data remaining`。处理方式也是类似的,可以通过调整 Downstream 配置项 `connectionBufferLimits` 解决, 或者使用 `SetResponseBodyBufferLimit` 方法设置响应 body buffer limit 解决。
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/ebook/zh-cn/wasm17.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ keywords: [Higress]

## 1 Envoy 集群(Cluster)名称和服务发现来源

Higress 插件的 Go SDK 在进行 HTTP 和 Redis 调用时,是通过指定的集群名称来识别并连接到相应的 Envoy 集群。 此外,Higress 利用 [McpBridge](https://higress.io/docs/latest/user/mcp-bridge/) 支持多种服务发现机制,包括静态配置(static)、DNS、Kubernetes 服务、Eureka、Consul、Nacos、以及 Zookeeper 等。
Higress 插件的 Go SDK 在进行 HTTP 和 Redis 调用时,是通过指定的集群名称来识别并连接到相应的 Envoy 集群。 此外,Higress 利用 [McpBridge](https://higress.cn/docs/latest/user/mcp-bridge/) 支持多种服务发现机制,包括静态配置(static)、DNS、Kubernetes 服务、Eureka、Consul、Nacos、以及 Zookeeper 等。
每种服务发现机制对应的集群名称生成规则都有所不同,这些规则在 cluster_wrapper.go 代码文件中有所体现。
为了包装不同的服务发现机制,Higress 插件 Go SDK 定义了 Cluster 接口,该接口包含两个方法:ClusterName 和 HostName。
```golang
Expand Down Expand Up @@ -650,7 +650,7 @@ spec:
以此类推。这种情况 Redis 调用也是一样处理。 关于回调链可以参考 Higress 官方提供 [ai-agent](https://github.com/alibaba/higress/blob/main/plugins/wasm-go/extensions/ai-agent/main.go#L169) 插件功能。

## 参考
- [1][Mcp Bridge 配置说明](https://higress.io/docs/latest/user/mcp-bridge/)
- [1][Mcp Bridge 配置说明](https://higress.cn/docs/latest/user/mcp-bridge/)



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ X-Auth-Request-Redirect: https://my-oidc-provider.example.com/sign_out_page
### OIDC 服务 HTTPS 协议
如果 OIDC Provider 为 HTTPS 协议,参考Higress中[配置后端服务协议:HTTPS](https://higress.io/docs/latest/user/annotation-use-case/#%E9%85%8D%E7%BD%AE%E5%90%8E%E7%AB%AF%E6%9C%8D%E5%8A%A1%E5%8D%8F%E8%AE%AEhttps%E6%88%96grpc)的说明需要通过使用注解`higress.io/backend-protocol: "HTTPS"`配置请求转发至后端服务使用HTTPS协议,参考Auth0示例中Ingress配置
如果 OIDC Provider 为 HTTPS 协议,参考Higress中[配置后端服务协议:HTTPS](https://higress.cn/docs/latest/user/annotation-use-case/#%E9%85%8D%E7%BD%AE%E5%90%8E%E7%AB%AF%E6%9C%8D%E5%8A%A1%E5%8D%8F%E8%AE%AEhttps%E6%88%96grpc)的说明需要通过使用注解`higress.io/backend-protocol: "HTTPS"`配置请求转发至后端服务使用HTTPS协议,参考Auth0示例中Ingress配置
## 配置示例
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/latest/zh-cn/plugins/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ description: 自定义插件配置参考
tinygo build -o main.wasm -scheduler=none -target=wasi -gc=custom -tags='custommalloc nottinygc_finalizer' ./main.go
```

详细的编译说明,包括要使用更复杂的 Header 状态管理机制,请参考[ Go 开发插件的最佳实践](https://higress.io/docs/latest/user/wasm-go/#3-%E7%BC%96%E8%AF%91%E7%94%9F%E6%88%90-wasm-%E6%96%87%E4%BB%B6)
详细的编译说明,包括要使用更复杂的 Header 状态管理机制,请参考[ Go 开发插件的最佳实践](https://higress.cn/docs/latest/user/wasm-go/#3-%E7%BC%96%E8%AF%91%E7%94%9F%E6%88%90-wasm-%E6%96%87%E4%BB%B6)

### step2. 构建并推送插件的 docker 镜像

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/latest/zh-cn/plugins/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,4 +132,4 @@ https://github.com/higress-group/higress-console/blob/main/backend/sdk/src/main/

## Wasm 插件原理介绍

请查看电子书:[《Wasm插件开发篇》](https://higress.io/docs/ebook/wasm19/)
请查看电子书:[《Wasm插件开发篇》](https://higress.cn/docs/ebook/wasm19/)
2 changes: 1 addition & 1 deletion src/content/docs/latest/zh-cn/user/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ kubectl get svc -n higress-system higress-gateway -o jsonpath='{.status.loadBala
如果 LoadBalancer IP 获取不到,说明您当前的 K8s 集群不支持 LoadBalancer 类型的 Service,可以考虑以下方案:

1. 使用云厂商提供的 K8s 服务,例如[阿里云 ACK](https://www.aliyun.com/product/kubernetes)
2. 参考[运维参数配置](https://higress.io/docs/latest/user/configurations),开启`higress-core.gateway.hostNetwork`,让 Higress 监听本机端口,再通过其他软/硬负载均衡器转发给固定机器 IP
2. 参考[运维参数配置](https://higress.cn/docs/latest/user/configurations),开启`higress-core.gateway.hostNetwork`,让 Higress 监听本机端口,再通过其他软/硬负载均衡器转发给固定机器 IP
3. (生产不建议)使用开源的负载均衡方案 [MetalLB](https://metallb.universe.tf/)

#### 场景二:在本地 K8s 环境中使用
Expand Down
2 changes: 1 addition & 1 deletion src/content/faq/HIGRESS-user-question-history16707.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ keywords: ["higress","获取","用户","真实","访问","IP","方法"]
- **配置灵活性**: Higress 支持多种配置方式,具体实现可能依赖于其内置的功能或通过插件扩展,因此上述配置仅为示例,实际操作时应参照 Higress 最新文档进行。

### 注意
请查阅 Higress 的官方文档,特别是关于配置和服务发现的部分[[Higress 配置](https://higress.io/docs/latest/user/configurations)],以获取最准确和最新的配置指导。如果有关于特定版本或功能的疑问,直接查询文档或社区论坛将是最佳选择。
请查阅 Higress 的官方文档,特别是关于配置和服务发现的部分[[Higress 配置](https://higress.cn/docs/latest/user/configurations)],以获取最准确和最新的配置指导。如果有关于特定版本或功能的疑问,直接查询文档或社区论坛将是最佳选择。


<font color="#949494">---------------</font>
Expand Down
2 changes: 1 addition & 1 deletion src/content/faq/HIGRESS-user-question-history16939.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Higress之所以需要云原生网关,主要是因为以下几个原因,依

相关链接:
- [Higress是什么?](https://link.zhihu.com/?target=https%3A//higress.cn/docs/latest/overview/what-is-higress/)
- [Higress官方文档 - 外部认证插件](https://higress.io/docs/latest/plugins/authentication/ext-auth/?source=plugin)
- [Higress官方文档 - 外部认证插件](https://higress.cn/docs/latest/plugins/authentication/ext-auth/?source=plugin)


<font color="#949494">---------------</font>
Expand Down
2 changes: 1 addition & 1 deletion src/content/faq/HIGRESS-user-question-history16948.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ keywords: ["higress","tcp","代理","配置",""]
确保满足以下条件:
- **Higress安装**:确认Higress已被部署在Kubernetes集群的`higress-system`命名空间下,且其Service名称为`higress-gateway`
- **服务目标**:需要为`default`命名空间下的`tcp-echo`服务配置四层路由,该服务监听端口为9000,与网关监听端口一致。
- **Gateway API支持**:Higress需预先配置以支持Gateway API CRD。[相关文档](https://higress.io/docs/latest/ops/deploy-by-helm/#%E6%94%AF%E6%8C%81-gateway-api-crd%E5%8F%AF%E9%80%89)
- **Gateway API支持**:Higress需预先配置以支持Gateway API CRD。[相关文档](https://higress.cn/docs/latest/ops/deploy-by-helm/#%E6%94%AF%E6%8C%81-gateway-api-crd%E5%8F%AF%E9%80%89)

### 2. **配置步骤**

Expand Down
Loading

0 comments on commit ea37754

Please sign in to comment.