Skip to content

Commit 3ed003f

Browse files
xcsnx‘xcsnx’
and
‘xcsnx’
authored
[type:fix]enhance namespace doc (#1046)
* enhance namespace doc * fix --------- Co-authored-by: ‘xcsnx’ <‘[email protected]’>
1 parent 793c500 commit 3ed003f

File tree

10 files changed

+56
-5
lines changed

10 files changed

+56
-5
lines changed

docs/user-guide/admin-usage/namepsace.md

+26-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Currently, when managing gateways for different business line needs, multiple se
66

77
Note: To facilitate usage, a default namespace already exists in the system; please do not manually delete the default namespace records in the database.
88

9-
## 2.Usage Process
9+
## 2.Namespace Creation and Enablement
1010

1111
### 1.Create a New Namespace
1212

@@ -40,6 +40,31 @@ Note: A gateway can only bind to a single unique namespaceId
4040

4141
<img src="/img/shenyu/basicConfig/namespace/namespace-bootstrap.png" width="80%" height="50%" />
4242

43+
## 3.Plugin Management
44+
45+
### 1.Add a New Plugin
46+
47+
The plugin group under a new namespace is empty by default. To add a plugin to a namespace, you first need to select the option to generate it under the specific namespace in the plugin template.
48+
49+
Choose 【PluginTemplate】-【Generate】-【Select Target Namespace】
50+
<img src="/img/shenyu/basicConfig/namespace/namespace-generate-plugin-en.png" width="80%" height="50%" />
51+
52+
### 2.Switch Namespace
53+
54+
Switch namespaces via the component in the top-right corner.
55+
56+
<img src="/img/shenyu/basicConfig/namespace/namespace-change-en.png" width="80%" height="50%" />
57+
58+
This allows you to manage the plugin status within the current namespace.
59+
60+
<img src="/img/shenyu/basicConfig/namespace/namespace-new-plugin-en.png" width="80%" height="50%" />
61+
62+
### 3.Other Gateway Data Management
63+
64+
Pages that display the namespace switch component in the top-right corner support namespace isolation. By switching namespaces via the component, you can manage gateway data for a specific namespace.
65+
66+
<img src="/img/shenyu/basicConfig/namespace/namespace-other-data-en.png" width="80%" height="50%" />
67+
4368
## 3.Important Changes
4469

4570
#### 1. The concept of Plugins in the old version has changed to Plugin Templates. The current Plugin model is now under the namespace, while in the database, Plugin Templates correspond to the plugin table, and Plugins correspond to the namespace_plugin_rel table.

i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/namepsace.md

+30-4
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
特别说明:为了方便大家的使用,系统中已经存在默认的命名空间,请不要在数据库中手动删除默认命名空间的记录;
88

9-
## 2.使用流程
9+
## 2.命名空间创建与启用
1010

11-
### 1.创建新命名空间
11+
### 1.创建命名空间
1212

1313
用户登录shenyu-admin后台,选择【基础配置-命名空间管理】
1414

@@ -40,9 +40,35 @@
4040

4141
<img src="/img/shenyu/basicConfig/namespace/namespace-bootstrap.png" width="80%" height="50%" />
4242

43-
## 3.重要改动说明
4443

45-
#### 1.旧版本的【插件】的概念已经变成【插件模板】概念,现在的【插件】模型已经是命名空间下的插件,而在数据库中【插件模板】对应plugin表,【插件】对应namespace_plugin_rel 表
44+
## 3.插件管理
45+
46+
### 1.新增插件
47+
48+
新的命名空间下插件组默认为空,如果要为命名空间新增插件,则需要先在插件模板中选中生成到具体命名空间下。
49+
50+
选择【插件元数据管理】-【生成】-【选择目标命名空间】
51+
<img src="/img/shenyu/basicConfig/namespace/namespace-generate-plugin.png" width="80%" height="50%" />
52+
53+
### 2.切换命名空间
54+
55+
通过右上角的组件,切换命名空间
56+
57+
<img src="/img/shenyu/basicConfig/namespace/namespace-change.png" width="80%" height="50%" />、
58+
59+
即可管理当前命名空间下的插件状态
60+
61+
<img src="/img/shenyu/basicConfig/namespace/namespace-new-plugin.png" width="80%" height="50%" />
62+
63+
### 3.其他网关数据管理
64+
65+
右上角有显示命名空间切换组件的页面,都支持命名空间隔离,通过组件切换命名空间,即可对特定命名空间下的网关数据进行管理
66+
67+
<img src="/img/shenyu/basicConfig/namespace/namespace-other-data.png" width="80%" height="50%" />
68+
69+
## 4.重要改动说明
70+
71+
#### 1.旧版本的【插件】的概念已经变成【插件元数据】概念,现在的【插件】模型已经是命名空间下的插件,而在数据库中【插件元数据】对应plugin表,【插件】对应namespace_plugin_rel 表
4672

4773
#### 2.Apidoc模块已经与selector、Rule等解绑
4874

Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)