租户端 互联网中间件 微服务框架（TSF） 操作指南 全局配置

全局配置

最近更新时间: 2024-09-05 15:09:00

操作场景

全局配置功能用于动态更新应用代码中的配置。全局配置可以保证配置内容在某个集群或者命名空间中全局生效。 全局配置包括管理配置和发布配置两部分。管理配置包括创建配置、生成新版本配置和删除配置。配置可以发布到命名空间下的所有应用。

前提条件

在使用全局配置功能之前，请确保已经按照 【分布式配置开发文档】添加了代码注释。

操作步骤

创建配置

  1. 登录 【TSF 控制台】 。

  2. 在左侧导航栏，单击【配置管理】>【全局配置】。

  3. 在配置列表页，单击【新建配置】，进入配置界面。

  4. 填写配置内容。配置可以按照 YAML 方式进行编辑。YAML 格式规范参考 [YAML 格式介绍] 。

注意：

单个全局配置版本的大小不能超过65535个字节，如果实际使用的配置超过了该上限值，可以分成多个全局配置项发布到同一个命名空间，多个配置会合并成一份配置。

  1. 单击【完成】，完成创建。

生成新版本配置

  1. 单击配置项名称，进入配置详情页。

  2. 单击配置列表右侧的【生成新版本】。

  3. 填写变更的配置内容和版本号。

注意：

新版本配置的版本号不能与原版本相同。

  1. 单击【完成】，即可生成新版本。

删除配置

  1. 单击配置项名称，进入配置详情页。

  2. 删除每个配置版本，删除最后一个配置版本后，配置项将被删除。

注意：

对于已经发布的配置，需要在【发布情况】页面中先删除配置，然后再删除配置版本，避免配置被误删除。

  1. 在弹框中，单击【确认】。

发布配置

  1. 在配置列表中，单击配置项名称，进入配置版本页面。

  2. 单击版本号后面的【发布】，在弹框中选择命名空间，填写发布描述。

  3. 单击【提交】。

配置合并逻辑说明

按照配置下发时间排序执行合并（merge）。不同名的配置项中如果存在相同 key 会进行合并。合并规则：按照配置下发时间排序，离当前时间近的优先级较高。举例如下：

1. 创建配置项 config-abc，配置内容是 custom-key: value-1，发布时间 15:00:00
2. 创建配置项 config-bcd，配置内容是 custom-key: value-2， 发布时间15:00:01

最终在实例上生效的配置：custom-key: value-2

查看命名空间对应配置发布历史

  1. 在配置列表中，单击操作的【查看发布信息】。

  2. 展开所需查看的命名空间，即可查看该命名空间的配置发布历史。

  3. 单击其中一条发布历史，可查看配置发布前后区别。

配置回滚

  1. 进入【发布情况】 界面，查看 命名空间对应配置发布历史。

  2. 在相应命名空间的操作中，单击【回滚】。

  3. 可查看回滚前后配置变化，单击【提交】。