管理员指南

为满足不同用户需求，提供两种微服务框架部署模式。

• 多租户共享模式：系统管理员或“系统租户&目标集群”的租户管理员部署共享微服务框架，可授权给平台其他租户使用。
• 单租户独享模式：租户管理员也可自行部署独享微服务框架（普通租户&目标集群），仅供自己租户使用。 但同一时间同一集群，租户只能选择一种框架使用，如下图所示。

微服务环境配置

可查看开放的API地址(只读)，包括微服务引擎API、Spring Cloud API。 可配置微服务开发Artifactory地址，即微服务开发中依赖组件所在的私服地址。 仅系统管理员可见可操作。

微服务框架部署模式

用户可结合多租户应用模式和资源合理利用两方面来考虑采用共享模式还是独享模式。使用平台时，租户实际是对应子公司、业务域、公司部门或项目组，应用模式不同，选择结果也会不同。

前提条件

• 数据库、Redis用户自定义配置：注册与配置中心安装使用数据库，Redis微服务网关安装使用redis。
• 数据库兼容MySQL、OceanDB
• 使用第三方中间件服务，版本兼容说明
  • MySQL版本支持5.7及以上
  • OceanDB版本支持3.2.3.1
  • Redis版本支持4.0及以上
• 使用TCE中间件，详细说明请参考容器云-中间件应用。使用平台中间件的注意事项如下：
  • TCE平台中间件MySQL：集群模式仅支持多主模式，版本支持5.7及以上。
  • TCE平台中间件Redis：不支持。

共享微服务框架

系统管理员（或“系统租户&目标集群”的租户管理员）可为目标集群部署共享微服务框架，包括注册与配置中心、微服务网关等，然后再授权给其它普通租户使用。

前提条件

• 共享微服务框架默认部署位置：系统租户，指定项目（命名空间需定义为system-mf，项目名称可自定义）。免费版不支持自定义部署位置。
• 系统租户需要授权目标集群。
• 项目（命名空间system-mf）需授权目标集群。

安装微服务框架

操作步骤如下：

1. 进入[管理工作台/配置管理/微服务配置/微服务框架管理]页面，选择目标集群，选择系统租户。

2. 若该集群暂未安装共享微服务框架，框架安装情况显示“安装”，点击安装，弹出安装面板，如下图所示。

图 微服务框架部署

3. 安装位置：共享微服务框架默认安装到系统租户下的项目（命名空间为system-mf）中

4. 注册与配置中心

• 默认开通
• 默认高可用3，可选3，5，7，9，11；否，只部署1个实例
• 自定义组件（spring-cloud-discovery）资源：内存、CPU（request、limit值）

5. 微服务网关

• 默认不开通，按用户需求进行设置。
• 勾选开通后，可自定义组件（spring-cloud-gateway）资源：内存、CPU（request、limit值）。

6. 数据库配置

• 填写IP/host、端口（选填，默认3306）、用户名、密码、数据库名称
• 数据库主要用于存储微服务治理相关的数据，兼容MySQL、OceanDB

7. 配置完成后，单击确定，安装操作完成。显示注册与配置中心、微服务网关、存储配置、安装位置、组件状态等信息。

• 注册与配置中心
  • 展示高可用设置。
  • 管理员账号/密码，登录nacos原生页面查看其所有namespace内数据。
  • 访问地址：默认显示集群内地址，可为注册中心设置集群外可访问地址，用于跨集群关联等能力。
• 微服务网关
  • 支持独立开通或卸载。
  • 开通后，默认显示网关集群内访问地址，也可为其设置外网地址，用于路由访问。
• 存储配置，显示数据库、Redis的配置
  • 支持编辑数据库，编辑完成，初始化Job执行成功后，需要手动重启微服务组件（spring-cloud-discovery）方可生效。
  • 支持编辑Redis，编辑完成，需要手动重启微服务组件（spring-cloud-gateway）方可生效。
• 安装位置，显示框架组件部署所在的项目。
• 组件状态：点击查看详情，展示框架组件的详细信息，组件名称、状态、实例数量、安装时间、操作启动/停止。

说明

• 如果对组件服务重启、删除等敏感操作，会影响所有注册到此框架的微服务，进而影响用户业务，用户需关注其权限设置。
• IP/host支持数字、小写字母、“.”、“-”随意组合。支持使用集群service名称进行通信。
• 当不同微服务框架使用同一个数据库时，数据库的名称（例MySQL的database名称），需要唯一。

卸载微服务框架

操作步骤如下：

1. 进入[管理工作台/配置管理/微服务配置/微服务框架管理]页面，选择目标集群，选择系统租户。

2. 点击红色按钮“卸载”，弹框提示“卸载治理框架组件后，注册到该框架的服务，将无法继续进行服务治理，请谨慎操作！”

3. 弹框中手动输入“卸载”再次确认后，卸载成功。

说明

• 如需要将微服务组件spring-cloud-discovery、spring-cloud-gateway接入链路，请部署链路追踪组件。参考应用性能监控TAPM产品。
• 通过设置黑名单屏蔽或者减少对非必要调用的采样，例注册中心心跳调用。

修改数据库场景说明

修改数据库支持两种场景：

• 安装新框架时，数据库信息填写有误导致安装失败，支持手动修改数据库相关信息，编辑成功，job会初始化表结构。
• 用户已完成数据迁移，并确保库表中数据正确，然后手动修改数据库相关信息，编辑成功，job会提示是否连接数据库成功，数据库中应有的表是否存在，如果有问题，也会展示相关报错信息。 编辑完成，待Job执行完成后，需要手动重启微服务组件（spring-cloud-discovery）方可生效。

微服务框架授权

目标集群部署了共享微服务框架后，可授权其它租户使用。

授权租户

操作步骤如下：

1. 进入[管理工作台/配置管理/微服务配置/微服务框架授权]页面，列表展示已经部署了共享微服务框架的集群，包括集群名称、授权租户数、租户名称（接入服务数）、授权租户/解除授权。

2. 选择目标集群，点击“授权租户”，弹框中选择当前集群已授权的租户，确定后，授权成功。授权租户后，将租户&目标集群中部署的业务服务接入TMF（参考快速入门），使用微服务框架相关治理能力。

备注

注册与配置中心服务（spring-cloud-discovery）停止或被删除，即其状态不是运行中时，授权租户按钮置灰不可点击，hover提示“注册与配置中心服务异常，暂无法授权使用”

解除授权

操作步骤如下：

1. 进入[管理工作台/配置管理/微服务配置/微服务框架授权]页面，列表展示已经部署了共享微服务框架的集群。
2. 找到目标集群，点击“解除授权”，弹框中勾选需要解除授权的租户，输入“解除授权”，点击确定后，解除授权成功。
3. 解除授权后，受权租户&目标集群将不能再使用共享微服务框架，注册中心会删除已分配的空间，请谨慎操作。

独享微服务框架

为满足不同用户需求，租户管理员可为某个集群部署独享微服务治理框架，仅供租户内各项目使用。

• 位置说明：[管理工作台/配置管理/微服务配置/微服务框架管理]。
• 权限说明：租户管理员、系统管理员可见、可操作。

前提条件

• 判断是否已授权使用共享微服务框架，如果已被授权，需要解除授权后才可部署独享微服务框架。
• 选择部署项目，需确认是当前租户下已创建并授权目标集群的项目。

安装及卸载均和共享框架一致，参考共享微服务框架。

微服务系统配置

微服务框架部署成功后，可按需进行微服务系统配置。主要包括三块能力，页面展示如下图

• 微服务自动接入配置：租户管理员为项目开启微服务治理开关，开启后，容器部署的微服务注册到TMF时，会自动注入相关环境变量，快速接入微服务治理
• 跨集群关联配置：设置多个集群互相关联(需暴露注册中心外网地址)，关联后的集群可支持跨集群服务发现
  • 一个项目授权给不同的集群，用户在每个集群的项目内创建相同的服务，并为该服务设置跨集群访问地址，当其中一个集群的服务出现异常，可调度到另一个集群的同名服务，从而实现跨集群的服务调用。
  • 注册中心设置外网地址后方可进行跨集群关联，取消关联将不再支持服务跨集群注册与发现，请谨慎操作！
• 微服务网关配置：设置敏感Header，路由访问时，不向下游的服务传递设置的敏感 Header，若未添加敏感 Header 代表向下游服务传递所有Header。

图 微服务系统配置

微服务自动接入配置

操作步骤如下：

1. 进入[管理工作台/配置管理/微服务配置/微服务框架管理]页面，选择目标集群，选择目标租户，卸载按钮旁有快速链接“微服务系统配置>>”
2. 或直接进入[管理工作台/配置管理/微服务配置/微服务系统配置]页面，选择目标集群，选择目标租户。
3. 点击微服务自动接入配置模块的“编辑”按钮，进入其详情页面，展示目标集群&目标租户下，项目的接入情况
4. 找到目标项目&集群，默认关闭状态。开启完成后，点击返回，微服务系统配置模块处展示已开启自动注入环境变量的项目名称。

跨集群关联配置

操作步骤如下：

1. 进入[管理工作台/配置管理/微服务配置/微服务系统配置]页面，选择目标集群，选择目标租户。
2. 跨集群关联配置：点击编辑，弹框中选择集群，确定后，展示添加的集群名称
3. 目标集群的注册中心需设置对外访问地址，保证两个集群的注册中心可连通

图 跨集群关联弹框

微服务网关配置

操作步骤如下：

1. 进入[管理工作台/配置管理/微服务配置/微服务系统配置]页面，选择目标集群，选择目标租户。
2. 如开通微服务网关后，显示“微服务网关配置”，支持设置默认敏感Header，可添加多个header。
3. 用户创建路由时，选择“默认敏感Header”会显示步骤2已添加的header

微服务框架拓扑

可视化查看平台上微服务框架的部署和使用情况。 操作步骤如下：

1. 进入[管理工作台/配置管理/微服务配置/微服务框架拓扑]页面，页面分集群展示，集群内默认仅展示已安装独享框架或已授权共享框架使用的租户。
2. 点击勾选“展示未安装框架或未授权框架使用的租户”，拓扑图灰色展示租户名称。
3. hover租户图标，展示租户名称、已接入服务数量。

图 微服务框架拓扑

备注

• 同一租户不同集群的框架可跨集群关联。
• 系统租户安装共享框架，可授权其他普通租户使用。
• 普通租户可安装独享框架，或被授权使用共享框架。