Skip to content

Commit

Permalink
namespace doc
Browse files Browse the repository at this point in the history
  • Loading branch information
‘xcsnx’ committed Sep 28, 2024
1 parent ac0bce3 commit 671aea3
Showing 1 changed file with 48 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# 命名空间(namespace)管理

## 1. 背景与说明

目前在管理不同业务线需求的网关时,常常需要同时部署多套 ShenYu Admin 和 ShenYu Gateway。为了确保数据独立性,通常每个网关只能连接一 个 ShenYu Admin。但是,这样的架构会增加用户使用成本和运维成本。 为了提供更便捷的使用体验,ShenYu Admin 引入了命名空间来实现数据隔离,用 于管理不同业务线的网关数据。企业或个人用户只需配置一套ShenYu Admin 和 ShenYu Bootstrap 服务,然后通过命名空间来管理不同业务线的网关数据。

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

## 2.使用流程

### 1.创建新命名空间

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

![](/img/shenyu/basicConfig/namepsace/namespace-manager.png)

命名空间管理模块下点击添加数据即可新增命名空间,,只需填写【名字】和【描述】系统会自动生成namespaceId

![](/img/shenyu/basicConfig/namepsace/namespace-add.png)

创建成功后会自动生成唯一namespaceId

![](/img/shenyu/basicConfig/namepsace/namespace-Id.png)

### 2.下游服务配置命名空间(shenyu-client)

得到namespaceId以后,我们可以在下游服务(已经引入shenyu-client),配置文件中配置单个或多个namespaceId

![](/img/shenyu/basicConfig/namepsace/namespace-shenyu-client.png)

### 3.管理命名空间下的数据

在Shenyu-client的数据注册到Shenyu-admin指定的命名空间下后。在后台管理端中,支持命名空间隔离的网关数据,用户可以通过右上角按钮切换到不同命名空间下进行操作

![](/img/shenyu/basicConfig/namepsace/namespace-divide.png)

### 4.网关配置命名空间(bootstrap)

注意:一个网关只能绑定唯一namespaceId

![](/img/shenyu/basicConfig/namepsace/namespace-bootstrap.png)

## 3.重要改动说明

#### 1.旧版本的【插件】的概念已经变成【插件模板】概念,现在的【插件】模型已经是命名空间下的插件,而在数据库中【插件模板】对应plugin表,【插件】对应namespace_plugin_rel 表

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

0 comments on commit 671aea3

Please sign in to comment.