hf400159 commented on code in PR #7933:
URL: https://github.com/apache/apisix/pull/7933#discussion_r973713383
##########
docs/zh/latest/plugins/traffic-split.md:
##########
@@ -1,5 +1,10 @@
---
title: traffic-split
+keywords:
+ - APISIX
+ - API 网关
+ - Traffic Split
+description: 本文介绍了 Apache APISIX limit-conn 插件的相关操作，你可以使用此插件动态地将部分流量引导至各种上游服务。
Review Comment:
```suggestion
description: 本文介绍了 Apache APISIX traffic-split 插件的相关操作，你可以使用此插件动态地将部分流量引导至各种上游服务。
```
##########
docs/zh/latest/plugins/traffic-split.md:
##########
@@ -23,53 +28,54 @@ title: traffic-split
## 描述
-traffic-split 插件使用户可以逐步引导各个上游之间的流量百分比。
+`traffic-split` 插件可以通过配置 `match` 和 `weighted_upstreams` 属性，从而动态地将部分流量引导至各种上游服务。`match` 是用于分割流量的自定义规则，`weighted_upstreams` 是用于引导流量的一组上游服务。当一个请求被 `match` 属性匹配时，它将根据配置的 `weights` 属性被引导到上游服务。你也可以不使用 `match` 属性，而根据 `weighted_upstreams` 属性引导所有流量。
-注：由于加权循环算法（特别是在重置 wrr 状态时）的缺点，因此每个上游之间的比率可能不太准确。
+:::note 注意
+
+由于使用了加权循环算法（特别是在重置 `wrr` 状态时），上游服务之间的流量比例可能不太准确。
+
+:::
## 属性
| 参数名 | 类型 | 可选项 | 默认值 | 有效值 | 描述 |
| ---------------------- | --------------| ------ | ------ | ------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| rules.match | array[object] | 可选 | | | 匹配规则列表，默认为空且规则将被无条件执行。 |
-| rules.match.vars | array[array] | 可选 | | | 由一个或多个{var, operator, val}元素组成的列表，类似这样：{{var, operator, val}, {var, operator, val}, ...}}。例如：{"arg_name", "==", "json"}，表示当前请求参数 name 是 json。这里的 var 与 Nginx 内部自身变量命名是保持一致，所以也可以使用 request_uri、host 等；对于 operator 部分，目前已支持的运算符有 ==、~=、~~、>、<、in、has 和 ! 。操作符的具体用法请看 [lua-resty-expr](https://github.com/api7/lua-resty-expr#operator-list) 的 `operator-list` 部分。 |
-| rules.weighted_upstreams | array[object] | 可选 | | | 上游配置规则列表。 |
-| weighted_upstreams.upstream_id | string / integer | 可选 | | | 通过上游 id 绑定对应上游。 |
-| weighted_upstreams.upstream | object | 可选 | | | 上游配置信息。 |
-| upstream.type | enum | 可选 | roundrobin | [roundrobin, chash] | roundrobin 支持权重的负载，chash 一致性哈希，两者是二选一。 |
-| upstream.hash_on | enum | 可选 | vars | | `hash_on` 支持的类型有 `vars`（Nginx 内置变量），`header`（自定义 header），`cookie`，`consumer`，`vars_combinations`，默认值为 `vars`。更多详细信息请参考 [upstream](../admin-api.md#upstream) 用法。 |
-| upstream.key | string | 可选 | | | 该选项只有类型是 `chash` 才有效。根据 `key` 来查找对应的 node `id`，相同的 `key` 在同一个对象中，永远返回相同 id。更多详细信息请参考 [upstream](../admin-api.md#upstream) 用法。 |
-| upstream.nodes | object | 可选 | | | 哈希表，内部元素的 key 是上游机器地址 列表，格式为地址 + Port，其中地址部 分可以是 IP 也可以是域名，⽐如 192.168.1.100:80、foo.com:80 等。 value 则是节点的权重，特别的，当权重 值为 0 有特殊含义，通常代表该上游节点 失效，永远不希望被选中。 |
-| upstream.timeout | object | 可选 | 15 | | 设置连接、发送消息、接收消息的超时时间（时间单位：秒，都默认为 15 秒）。 |
-| upstream.pass_host | enum | 可选 | "pass" | ["pass", "node", "rewrite"] | `pass`：将客户端的 host 透传给上游； `node`：使用 `upstream` node 中配置的 host； `rewrite`：使用配置项 `upstream_host` 的值 |
-| upstream.name | string | 可选 | | | 标识上游服务名称、使⽤场景等。 |
-| upstream.upstream_host | string | 可选 | | | 只在 pass_host 配置为 rewrite 时有效。 |
-| weighted_upstreams.weight | integer | 可选 | weight = 1 | | 根据 `weight` 值做流量划分，多个 weight 之间使用 roundrobin 算法划分。 |
-
-目前在 `weighted_upstreams.upstream` 的配置中，不支持的字段有：
-service_name、discovery_type、checks、retries、retry_timeout、desc、scheme、labels、create_time 和 update_time。但是你可以通过 `weighted_upstreams.upstream_id` 绑定 `upstream` 对象来实现他们。
-
-traffic-split 插件主要由 `match` 和 `weighted_upstreams` 两部分组成，`match` 是自定义的条件规则，`weighted_upstreams` 是 upstream 的配置信息。如果配置 `match` 和 `weighted_upstreams` 信息，那么在 `match` 规则校验通过后，会根据 `weighted_upstreams` 中的 `weight` 值；引导插件中各个 upstream 之间的流量比例，否则，所有流量直接到达 `route` 或 `service` 上配置的 `upstream`。当然你也可以只配置 `weighted_upstreams` 部分，这样会直接根据 `weighted_upstreams` 中的 `weight` 值，引导插件中各个 upstream 之间的流量比例。
-
-注：1、在 `match` 里，vars 中的表达式是 `and` 的关系，多个 `vars` 之间是 `or` 的关系。2、在插件的 weighted_upstreams 域中，如果存在只有 `weight` 的结构，表示 `route` 或 `service` 上的 upstream 流量权重值。例如：
-
-```json
-"weighted_upstreams": [
- ......
- {
- "weight": 2
- }
-]
-```
+| rules.match | array[object] | 否 | | | 匹配规则列表，默认为空且规则将被无条件执行。 |
+| rules.match.vars | array[array] | 否 | | | 由一个或多个 `{var, operator, val}` 元素组成的列表，例如：`{"arg_name", "==", "json"}`，表示当前请求参数 `name` 是 `json`。这里的 `var` 与 NGINX 内部自身变量命名是保持一致，所以也可以使用 `request_uri`、`host` 等；对于 operator 部分，目前已支持的运算符有 `==`、`~=`、`~~`、`>`、`<`、`in`、`has` 和 `!` ，具体用法请看 [lua-resty-expr](https://github.com/api7/lua-resty-expr#operator-list) 的 `operator-list` 部分。 |
+| rules.weighted_upstreams | array[object] | 否 | | | 上游配置规则列表。 |
+| weighted_upstreams.upstream_id | string/integer | 否 | | | 通过上游 id 绑定对应上游。 |
+| weighted_upstreams.upstream | object | 否 | | | 上游配置信息。 |
+| upstream.type | enum | 否 | roundrobin | [roundrobin, chash] | 流量分割机制的类型，`roundrobin` 支持权重的负载，`chash` 使用一致性哈希。 |
+| upstream.hash_on | enum | 否 | vars | | 该属性仅当 `upstream.type` 是 `chash` 时有效。支持的类型有 `vars`（NGINX 内置变量），`header`（自定义 header），`cookie`，`consumer`，`vars_combinations`。更多详细信息请参考 [Upstream](../admin-api.md#upstream) 用法。 |
+| upstream.key | string | 否 | | | 该属性仅当 `upstream.type` 是 `chash` 时有效。根据 `hash_on` 和 `key` 来查找对应的 node `id`。更多详细信息请参考 [Upstream](../admin-api.md#upstream) 用法。 |
+| upstream.nodes | object | 否 | | | 一个哈希表，键是上游节点的 IP 地址与可选端口的组合，值是节点的权重。将 `weight` 设置为 `0` 表示一个请求永远不会被转发到该节点。 |
+| upstream.timeout | object | 否 | 15 | | 设置连接、发送消息、接收消息的超时时间（时间单位：秒，都默认为 15 秒）。 |
+| upstream.pass_host | enum | 否 | "pass" | ["pass", "node", "rewrite"] | 当请求被转发到上游时配置 `host`。`pass` 代表将客户端的 `host` 透明传输给上游；`node` 代表使用 `upstream` node 中配置的 `host`； `rewrite` 代表使用配置项 `upstream_host` 的值。 |
+| upstream.name | string | 否 | | | 标识上游服务名称、使⽤场景等。 |
+| upstream.upstream_host | string | 否 | | | 上游服务请求的 `host`，仅当 `pass_host` 属性配置为 `rewrite` 时有效。 |
+| weighted_upstreams.weight | integer | 否 | weight = 1 | | 根据 `weight` 值做流量划分，多个 `weight` 之间使用 roundrobin 算法划分。 |
+
+:::note 注意
+
+目前在 `weighted_upstreams.upstream` 的配置中，尚不支持的字段有：`service_name`、`discovery_type`、`checks`、`retries`、`retry_timeout`、`desc`、`scheme`、`labels`、`create_time` 和 `update_time`。但是你可以创建一个 Upstream 对象，并在 `weighted_upstreams.upstream_id` 属性中配置以实现这些功能。
Review Comment:
```suggestion
目前 `weighted_upstreams.upstream` 的配置不支持 `service_name`、`discovery_type`、`checks`、`retries`、`retry_timeout`、`desc`、`scheme`、`labels`、`create_time` 和 `update_time` 等字段。如果你需要使用这些字段，可以在创建上游对象时指定这些字段，然后在该插件中配置 `weighted_upstreams.upstream_id` 属性即可。
```
##########
docs/zh/latest/plugins/traffic-split.md:
##########
@@ -23,53 +28,54 @@ title: traffic-split
## 描述
-traffic-split 插件使用户可以逐步引导各个上游之间的流量百分比。
+`traffic-split` 插件可以通过配置 `match` 和 `weighted_upstreams` 属性，从而动态地将部分流量引导至各种上游服务。`match` 是用于分割流量的自定义规则，`weighted_upstreams` 是用于引导流量的一组上游服务。当一个请求被 `match` 属性匹配时，它将根据配置的 `weights` 属性被引导到上游服务。你也可以不使用 `match` 属性，而根据 `weighted_upstreams` 属性引导所有流量。
Review Comment:
```suggestion
`traffic-split` 插件可以通过配置 `match` 和 `weighted_upstreams` 属性，从而动态地将部分流量引导至各种上游服务。你可以使用该插件进行灰度发布、蓝绿发布。
`match` 是用于分割流量的自定义规则，`weighted_upstreams` 是用于引导流量的一组上游服务。当一个请求被 `match` 属性匹配时，它将根据配置的 `weights` 属性被引导到上游服务。你也可以不使用 `match` 属性，而根据 `weighted_upstreams` 属性引导所有流量。
```
##########
docs/zh/latest/plugins/traffic-split.md:
##########
@@ -1,5 +1,10 @@
---
title: traffic-split
+keywords:
+ - APISIX
+ - API 网关
+ - Traffic Split
Review Comment:
```suggestion
- Traffic Split
- 灰度发布
- 蓝绿发布
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org