This is an automated email from the ASF dual-hosted git repository.
xiaoyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new fe05217bc4 [#ISSUE 471] divide plugin cn (#553)
fe05217bc4 is described below
commit fe05217bc4a96a8bb2558dc33db00c3fb04cf015
Author: AhahaGe <[email protected]>
AuthorDate: Tue Apr 26 14:30:53 2022 +0800
[#ISSUE 471] divide plugin cn (#553)
* divide 插件中文版
* divide 插件中文版
---
.../current/plugin-center/proxy/divide-plugin.md | 171 ++++++++++++++-------
static/img/shenyu/plugin/divide/disable-cn.png | Bin 0 -> 211395 bytes
static/img/shenyu/plugin/divide/disable-en.png | Bin 0 -> 218978 bytes
static/img/shenyu/plugin/divide/enable-cn.png | Bin 0 -> 216112 bytes
static/img/shenyu/plugin/divide/enable-en.png | Bin 0 -> 222172 bytes
static/img/shenyu/plugin/divide/procedure-cn.png | Bin 0 -> 74431 bytes
static/img/shenyu/plugin/divide/procedure-en.png | Bin 0 -> 68989 bytes
static/img/shenyu/plugin/divide/rule-cn.png | Bin 0 -> 117660 bytes
static/img/shenyu/plugin/divide/rule-en.png | Bin 0 -> 110212 bytes
.../shenyu/plugin/divide/select-and-rule-cn.png | Bin 0 -> 337375 bytes
.../shenyu/plugin/divide/select-and-rule-en.png | Bin 0 -> 335125 bytes
static/img/shenyu/plugin/divide/selector-cn.png | Bin 0 -> 146761 bytes
static/img/shenyu/plugin/divide/selector-en.png | Bin 0 -> 140856 bytes
13 files changed, 114 insertions(+), 57 deletions(-)
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/proxy/divide-plugin.md
b/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/proxy/divide-plugin.md
index a01d2009cb..b87c8a5966 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/proxy/divide-plugin.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/proxy/divide-plugin.md
@@ -4,85 +4,142 @@ keywords: ["divide"]
description: divide插件
---
-## 说明
+# 1. 概述
-`divide`插件是网关用于处理 `http协议`请求的核心处理插件。
+## 1.1 插件名称
-## 插件设置
+* `divide`插件
-* 引入相关依赖，开启插件，请参考：[Http快速开始](../../quick-start/quick-start-http) 。
+## 1.2 适用场景
-* `Http`应用客户端接入，请参考：[Http服务接入](../../user-guide/http-proxy) 。
+* 处理 `http协议` 请求
+* 支持流量治理，例如a/b 测试、灰度测试
+* 服务负载均衡
+* 设置接口的超时时间
-## 插件讲解
+## 1.3 插件功能
-`divide`插件是进行`http`正向代理的插件，所有`http`类型的请求，都是由该插件进行负载均衡的调用。
+* 支持根据 uri、header、query 等请求信息做流量的治理
+* 支持设置请求的负载均衡策略，同时支持服务预热，目前支持三种策略：ip
hash（带虚拟节点的一致性哈希）、round-robbin（加权轮询）、random（加权随机）
+* 支持设置接口级别请求头最大值、请求体最大值、请求超时时间
+* 支持设置超时重试策略和重试次数，目前重试策略支持：current（重试之前失败的服务器）和failover（重试其它服务器）
-<img src="/img/shenyu/basicConfig/pluginHandle/selector_example.png"
width="80%" height="80%" />
+## 1.4 插件代码
-客户端接入`Apache
ShenYu`网关后，会自动注册选择器和规则信息，关于选择器和规则配置，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
+* 核心模块 ```shenyu-plugin-divide```
+* 核心类 ```org.apache.shenyu.plugin.divide.DividePlugin```
+# 2. 如何使用插件
-#### 选择器处理
+## 2.1 插件使用流程图
-<img src="/img/shenyu/basicConfig/pluginHandle/selector_add.png" width="80%"
height="80%" />
+
+## 2.2 导入 pom
-选择器处理:
对应[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)的`handle`字段，是网关匹配到流量以后，真实调用的`http`配置，可以配置多个，设置负载均衡权重，具体的负载均衡策略，在规则中指定。更多信息请参考插件管理中的
[插件处理管理](../plugin-handle-explanation) 。
+- 在网关的 `pom.xml` 文件中添加插件 maven 配置。
-* 处理配置详解：
+```xml
+ <dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-gateway</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+```
- * `host`：填写 `localhost`，该字段暂时没使用。
+## 2.3 启用插件
- * `ip:port`：`ip` 与端口，这里填写你真实服务的 `ip` + 端口。
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `divide` 设置为开启。
- * `protocol`：：`http` 协议，填写 `http://` 或者 `https://` ，不填写默认为:`http://`
+
- * `startupTime`： 启用时间。
+## 2.4 配置插件
- * `weight`：负载均衡权重。
+### 2.4.1 在客户端项目配置文件中配置接入参数
- * `warmupTime`：预热时间。
-
- * `status`：开启或关闭。
+ * 客户端接入方式和服务器地址，下面的示例使用了 http
接入方式，目前客户端支持的接入的方式有以下几种：http、zookeeper、etcd、nacos、consul，详细的接入配置参数请参考[客户端接入配置](../../user-guide/register-center-access)。
+ * 客户端配置，包含协议名称以及服务的路由地址，这里请使用 http 协议，并且必须配置 contextPath 的值作为每个服务的路由地址。
+
+```yaml
+ shenyu:
+ register:
+ registerType: http
+ serverLists: http://localhost:9095
+ props:
+ username: admin
+ password: 123456
+ client:
+ http: # http 协议
+ props:
+ contextPath: /http # 每个服务的路由地址
+```
- * `ip + port` 检测
+### 2.4.2 在 shenyu-admin 配置文件中配置 upstream 有效性的检测参数
- * 在 `shenyu-admin` 会有一个定时任务来扫描 配置的`ip`端口，如果发现下线，则会删除该 `ip + port`
+下面的示例使用了 http
接入方式，目前客户端支持的接入的方式有以下几种：http、zookeeper、etcd、nacos、consul，详细的接入配置参数请参考[客户端接入配置](../../user-guide/register-center-access)。
- * 可以进行如下配置 ：
+> 只有 http 类型的注册中心才支持 upstream 检测
```yaml
-shenyu:
- register:
- registerType: http
- serverLists:
- props:
- sessionTimeout: 5000
- connectionTimeout: 2000
- checked: true # 默认为 ture，设置为false，不检测
- zombieCheckTimes: 5
- scheduledTime: 10 # 定时检测时间间隔，默认10秒
-
- ```
-
-#### 规则处理
-
- <img src="/img/shenyu/basicConfig/pluginHandle/rule_handle.png" width="80%"
height="80%" />
-
-规则处理，即`handle`字段，是网关对流量完成最终匹配后，采取何种处理规则。更多信息请参考插件管理中的
[插件处理管理](../../user-guide/admin-usage/plugin-handle-explanation) 。
-
-* 处理配置详解：
- * `loadStrategy`：如果`http`客户端是一个集群，`Apache ShenYu`网关调用时采取哪种负载均衡策略，当前支持
`roundRobin`、`random`和`hash`。
- * `retryCount`：调用`http`客户端的重试次数。
- * `timeout`：调用`http`客户端的超时时间。
- * `headerMaxSize`：请求的`header`的最大值。
- * `requestMaxSize`：请求体的最大值。
- * `retryStrategy`：从`2.4.3版本`开始支持，失败后的重试策略，默认`current`保持对低版本的兼容。
-
-
比如下游有3个服务`http://localhost:1111`、`http://localhost:1112`和`http://localhost:1113`，假设第一次负载均衡到`http://localhost:1111`并且`调用失败`。
-
- 使用`current`策略会继续重试调用`http://localhost:1111`；
-
-
使用`failover`策略会通过`负载均衡`重试调用到其他服务如`http://localhost:1112`，此时如果又失败了，则调用到`http://localhost:1113`，直到没有可用的服务为止。
-
\ No newline at end of file
+ shenyu:
+ register:
+ registerType: http # 只有 http 类型的注册中心才支持检测 upstream
+ serverLists:
+ props:
+ checked: true # 默认为 ture，设置为 false，不检测
+ zombieCheckTimes: 5 # 僵尸 upstream 最大检测次数，超过 5 次不再检测其有效性，默认为 5
+ scheduledTime: 10 # 定时检测时间间隔，默认 10 秒
+ zombieRemovalTimes: 60 # upstream 多少秒不在线认定为僵尸 upstream，默认 60 秒
+```
+
+### 2.4.3 在 shenyu-admin 配置 divide 插件的选择器和规则信息
+
+客户端启动之后会在 shenyu-admin -> 插件列表 -> Proxy -> Divide
自动注册[选择器和规则](../../user-guide/admin-usage/selector-and-rule)信息。
+
+
+#### 2.4.3.1 选择器的配置
+
+divide
选择器示例，通用选择器配置请参考[选择器和规则](../../user-guide/admin-usage/selector-and-rule)。
+
+
+
+##### 2.4.3.1.1 选择器处理信息配置
+
+- `host`：填写 `localhost`，该字段暂时没使用。
+- `ip:port`：`ip` 与端口，这里填写你真实服务的 `ip` + 端口。
+- `protocol`：：`http` 协议，填写 `http://` 或者 `https://`，不填写默认为：`http://`
+- `startupTime`： 启动时间，单位毫秒。
+- `weight`：负载均衡权重，服务启动自动注册的默认值为 50。
+- `warmupTime`：预热时间，单位毫秒，在预热中的服务器会计算瞬时权重，计算值会小于实际配置的权重，以保护刚启动的服务器，服务启动注册的默认值为
10。举个例子预热时间 100 毫秒，目前启动了 50 毫秒，配置的权重 50， 实际的权重是 25。
+- `status`：开启或关闭，开始状态此处理器才有效。
+
+#### 2.4.3.2 规则的处理信息配置
+
+divide 规则示例，通用规则配置请参考[选择器和规则](../../user-guide/admin-usage/selector-and-rule)。
+
+
+
+##### 2.4.3.2.1 规则处理信息配置
+
+- `loadStrategy`：如果`http`客户端是一个集群，`Apache ShenYu`网关调用时采取哪种负载均衡策略，当前支持
`roundRobin`、`random` 和 `hash`。
+- `timeout`：调用`http`客户端的超时时间。
+- `retryCount`：调用`http`客户端超时失败的重试次数。
+- `headerMaxSize`：请求`header`的最大值。
+- `requestMaxSize`：请求体的最大值。
+- `retryStrategy`：从`2.4.3版本`开始支持，失败后的重试策略，默认`current`以保持对低版本的兼容。
比如下游有3个服务`http://localhost:1111`、`http://localhost:1112`和`http://localhost:1113`，假设第一次负载均衡到`http://localhost:1111`并且`调用失败`。使用`current`策略会继续重试调用`http://localhost:1111`；使用`failover`策略会通过`负载均衡`重试调用到其他服务如`http://localhost:1112`，此时如果又失败了，则调用到`http://localhost:1113`，直到没有可用的服务为止。
+
+## 2.5 示例
+
+### 2.5.1 示例 A/B 测试
+
+待补充
+
+### 2.5.2 示例 灰度测试
+
+待补充
+
+# 3. 如何禁用插件
+
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `divide` 设置为禁用。
+
+
diff --git a/static/img/shenyu/plugin/divide/disable-cn.png
b/static/img/shenyu/plugin/divide/disable-cn.png
new file mode 100644
index 0000000000..88caee7d5e
Binary files /dev/null and b/static/img/shenyu/plugin/divide/disable-cn.png
differ
diff --git a/static/img/shenyu/plugin/divide/disable-en.png
b/static/img/shenyu/plugin/divide/disable-en.png
new file mode 100644
index 0000000000..feb4b0619e
Binary files /dev/null and b/static/img/shenyu/plugin/divide/disable-en.png
differ
diff --git a/static/img/shenyu/plugin/divide/enable-cn.png
b/static/img/shenyu/plugin/divide/enable-cn.png
new file mode 100644
index 0000000000..ec2fc20b14
Binary files /dev/null and b/static/img/shenyu/plugin/divide/enable-cn.png
differ
diff --git a/static/img/shenyu/plugin/divide/enable-en.png
b/static/img/shenyu/plugin/divide/enable-en.png
new file mode 100644
index 0000000000..9ff2f83567
Binary files /dev/null and b/static/img/shenyu/plugin/divide/enable-en.png
differ
diff --git a/static/img/shenyu/plugin/divide/procedure-cn.png
b/static/img/shenyu/plugin/divide/procedure-cn.png
new file mode 100644
index 0000000000..130f2602c6
Binary files /dev/null and b/static/img/shenyu/plugin/divide/procedure-cn.png
differ
diff --git a/static/img/shenyu/plugin/divide/procedure-en.png
b/static/img/shenyu/plugin/divide/procedure-en.png
new file mode 100644
index 0000000000..b00be75073
Binary files /dev/null and b/static/img/shenyu/plugin/divide/procedure-en.png
differ
diff --git a/static/img/shenyu/plugin/divide/rule-cn.png
b/static/img/shenyu/plugin/divide/rule-cn.png
new file mode 100644
index 0000000000..89eb8d1f6d
Binary files /dev/null and b/static/img/shenyu/plugin/divide/rule-cn.png differ
diff --git a/static/img/shenyu/plugin/divide/rule-en.png
b/static/img/shenyu/plugin/divide/rule-en.png
new file mode 100644
index 0000000000..7639f19e52
Binary files /dev/null and b/static/img/shenyu/plugin/divide/rule-en.png differ
diff --git a/static/img/shenyu/plugin/divide/select-and-rule-cn.png
b/static/img/shenyu/plugin/divide/select-and-rule-cn.png
new file mode 100644
index 0000000000..6a982383a6
Binary files /dev/null and
b/static/img/shenyu/plugin/divide/select-and-rule-cn.png differ
diff --git a/static/img/shenyu/plugin/divide/select-and-rule-en.png
b/static/img/shenyu/plugin/divide/select-and-rule-en.png
new file mode 100644
index 0000000000..1e9017c0bc
Binary files /dev/null and
b/static/img/shenyu/plugin/divide/select-and-rule-en.png differ
diff --git a/static/img/shenyu/plugin/divide/selector-cn.png
b/static/img/shenyu/plugin/divide/selector-cn.png
new file mode 100644
index 0000000000..e1a179b552
Binary files /dev/null and b/static/img/shenyu/plugin/divide/selector-cn.png
differ
diff --git a/static/img/shenyu/plugin/divide/selector-en.png
b/static/img/shenyu/plugin/divide/selector-en.png
new file mode 100644
index 0000000000..9fa25508d7
Binary files /dev/null and b/static/img/shenyu/plugin/divide/selector-en.png
differ
