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/shenyu-website.git
The following commit(s) were added to refs/heads/main by this push: new 3ed003f766 [type:fix]enhance namespace doc (#1046) 3ed003f766 is described below commit 3ed003f7668e22e2b87a7f0328ae722bec508237 Author: xcsnx <1192709...@qq.com> AuthorDate: Wed Dec 4 15:57:22 2024 +0800 [type:fix]enhance namespace doc (#1046) * enhance namespace doc * fix --------- Co-authored-by: ‘xcsnx’ <‘1192709...@qq.com’> --- docs/user-guide/admin-usage/namepsace.md | 27 +++++++++++++++- .../current/user-guide/admin-usage/namepsace.md | 34 ++++++++++++++++++--- .../basicConfig/namespace/namespace-change-en.png | Bin 0 -> 109775 bytes .../basicConfig/namespace/namespace-change.png | Bin 0 -> 136856 bytes .../namespace/namespace-generate-plugin-en.png | Bin 0 -> 151373 bytes .../namespace/namespace-generate-plugin.png | Bin 0 -> 153301 bytes .../namespace/namespace-new-plugin-en.png | Bin 0 -> 56828 bytes .../basicConfig/namespace/namespace-new-plugin.png | Bin 0 -> 80029 bytes .../namespace/namespace-other-data-en.png | Bin 0 -> 80877 bytes .../basicConfig/namespace/namespace-other-data.png | Bin 0 -> 84343 bytes 10 files changed, 56 insertions(+), 5 deletions(-) diff --git a/docs/user-guide/admin-usage/namepsace.md b/docs/user-guide/admin-usage/namepsace.md index 9c3f08de8d..13304d0708 100644 --- a/docs/user-guide/admin-usage/namepsace.md +++ b/docs/user-guide/admin-usage/namepsace.md @@ -6,7 +6,7 @@ Currently, when managing gateways for different business line needs, multiple se Note: To facilitate usage, a default namespace already exists in the system; please do not manually delete the default namespace records in the database. -## 2.Usage Process +## 2.Namespace Creation and Enablement ### 1.Create a New Namespace @@ -40,6 +40,31 @@ Note: A gateway can only bind to a single unique namespaceId <img src="/img/shenyu/basicConfig/namespace/namespace-bootstrap.png" width="80%" height="50%" /> +## 3.Plugin Management + +### 1.Add a New Plugin + +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. + +Choose 【PluginTemplate】-【Generate】-【Select Target Namespace】 +<img src="/img/shenyu/basicConfig/namespace/namespace-generate-plugin-en.png" width="80%" height="50%" /> + +### 2.Switch Namespace + +Switch namespaces via the component in the top-right corner. + +<img src="/img/shenyu/basicConfig/namespace/namespace-change-en.png" width="80%" height="50%" /> + +This allows you to manage the plugin status within the current namespace. + +<img src="/img/shenyu/basicConfig/namespace/namespace-new-plugin-en.png" width="80%" height="50%" /> + +### 3.Other Gateway Data Management + +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. + +<img src="/img/shenyu/basicConfig/namespace/namespace-other-data-en.png" width="80%" height="50%" /> + ## 3.Important Changes #### 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. diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/namepsace.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/namepsace.md index 35f4f54417..7a4707451c 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/namepsace.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/namepsace.md @@ -6,9 +6,9 @@ 特别说明:为了方便大家的使用,系统中已经存在默认的命名空间,请不要在数据库中手动删除默认命名空间的记录; -## 2.使用流程 +## 2.命名空间创建与启用 -### 1.创建新命名空间 +### 1.创建命名空间 用户登录shenyu-admin后台,选择【基础配置-命名空间管理】 @@ -40,9 +40,35 @@ <img src="/img/shenyu/basicConfig/namespace/namespace-bootstrap.png" width="80%" height="50%" /> -## 3.重要改动说明 -#### 1.旧版本的【插件】的概念已经变成【插件模板】概念,现在的【插件】模型已经是命名空间下的插件,而在数据库中【插件模板】对应plugin表,【插件】对应namespace_plugin_rel 表 +## 3.插件管理 + +### 1.新增插件 + +新的命名空间下插件组默认为空,如果要为命名空间新增插件,则需要先在插件模板中选中生成到具体命名空间下。 + +选择【插件元数据管理】-【生成】-【选择目标命名空间】 +<img src="/img/shenyu/basicConfig/namespace/namespace-generate-plugin.png" width="80%" height="50%" /> + +### 2.切换命名空间 + +通过右上角的组件,切换命名空间 + +<img src="/img/shenyu/basicConfig/namespace/namespace-change.png" width="80%" height="50%" />、 + +即可管理当前命名空间下的插件状态 + +<img src="/img/shenyu/basicConfig/namespace/namespace-new-plugin.png" width="80%" height="50%" /> + +### 3.其他网关数据管理 + +右上角有显示命名空间切换组件的页面,都支持命名空间隔离,通过组件切换命名空间,即可对特定命名空间下的网关数据进行管理 + +<img src="/img/shenyu/basicConfig/namespace/namespace-other-data.png" width="80%" height="50%" /> + +## 4.重要改动说明 + +#### 1.旧版本的【插件】的概念已经变成【插件元数据】概念,现在的【插件】模型已经是命名空间下的插件,而在数据库中【插件元数据】对应plugin表,【插件】对应namespace_plugin_rel 表 #### 2.Apidoc模块已经与selector、Rule等解绑 diff --git a/static/img/shenyu/basicConfig/namespace/namespace-change-en.png b/static/img/shenyu/basicConfig/namespace/namespace-change-en.png new file mode 100644 index 0000000000..999274ab64 Binary files /dev/null and b/static/img/shenyu/basicConfig/namespace/namespace-change-en.png differ diff --git a/static/img/shenyu/basicConfig/namespace/namespace-change.png b/static/img/shenyu/basicConfig/namespace/namespace-change.png new file mode 100644 index 0000000000..0a034764c6 Binary files /dev/null and b/static/img/shenyu/basicConfig/namespace/namespace-change.png differ diff --git a/static/img/shenyu/basicConfig/namespace/namespace-generate-plugin-en.png b/static/img/shenyu/basicConfig/namespace/namespace-generate-plugin-en.png new file mode 100644 index 0000000000..ef93f7eeaa Binary files /dev/null and b/static/img/shenyu/basicConfig/namespace/namespace-generate-plugin-en.png differ diff --git a/static/img/shenyu/basicConfig/namespace/namespace-generate-plugin.png b/static/img/shenyu/basicConfig/namespace/namespace-generate-plugin.png new file mode 100644 index 0000000000..515c99c978 Binary files /dev/null and b/static/img/shenyu/basicConfig/namespace/namespace-generate-plugin.png differ diff --git a/static/img/shenyu/basicConfig/namespace/namespace-new-plugin-en.png b/static/img/shenyu/basicConfig/namespace/namespace-new-plugin-en.png new file mode 100644 index 0000000000..5684dee5c4 Binary files /dev/null and b/static/img/shenyu/basicConfig/namespace/namespace-new-plugin-en.png differ diff --git a/static/img/shenyu/basicConfig/namespace/namespace-new-plugin.png b/static/img/shenyu/basicConfig/namespace/namespace-new-plugin.png new file mode 100644 index 0000000000..60a1fcf6f1 Binary files /dev/null and b/static/img/shenyu/basicConfig/namespace/namespace-new-plugin.png differ diff --git a/static/img/shenyu/basicConfig/namespace/namespace-other-data-en.png b/static/img/shenyu/basicConfig/namespace/namespace-other-data-en.png new file mode 100644 index 0000000000..0838a4eeb4 Binary files /dev/null and b/static/img/shenyu/basicConfig/namespace/namespace-other-data-en.png differ diff --git a/static/img/shenyu/basicConfig/namespace/namespace-other-data.png b/static/img/shenyu/basicConfig/namespace/namespace-other-data.png new file mode 100644 index 0000000000..dc42848ef1 Binary files /dev/null and b/static/img/shenyu/basicConfig/namespace/namespace-other-data.png differ