概述
配置相关的管理操作,主要包括创建配置、同步配置、管理配置、查看历史版本、监听查询、查询推送轨迹、配置加密、配置灰度发布等,下面逐项介绍。
前提条件
- 已开通微服务引擎MSE,参考章节:创建Nacos实例
- 已开通Nacos实例并且状态正常
创建配置
配置就是将应用中的参数、变量等从具体的代码逻辑中提取出来,集中保存到一个文件中。这样在需要变更时只需要修改配置文件即可。Nacos可以集中托管配置文件,客户端监听配置,当配置变更时,自动推送至应用客户端。
操作步骤
- 登录微服务引擎MSE注册配置中心管理控制台,选择资源池。
- 在左侧导航栏,选择注册配置中心 > 实例列表。
- 在实例列表页面,单击目标实例ID、实例名称或者目标行“管理”按钮均可跳转至实例基础信息页面。
- 在基础信息页面,点击配置管理>配置列表,选择命名空间,查看当前配置。
- 配置列表页面左上角点击创建配置,在弹出框中填写配置的DataId、分组、配置格式、配置内容等信息,点击发布即可创建配置,成功后显示在配置列表。
字段 | 说明 |
---|---|
命名空间 | 不可编辑,在创建配置前,在配置列表页面下拉框选择。 |
Data Id | 配置ID。配置的标识。建议按照业务规范命名。 |
Group | 分组。可以通过分组对配置进行细粒度分类。 |
数据加密 | 配置数据是否加密。加密配置的DataId会自动加上cipher-前缀。详情请参见配置加密。 |
配置格式 | 配置内容的格式,默认为text,支持text、json、properties、yaml、xml、html格式。 |
配置内容 | 配置文件的内容。配置的内容常见建议不要大于100KB,若配置内容过大,可拆成多个小配置。 |
描述 | 配置的描述信息。 |
应用 | 配置归属应用的名称。 |
标签 | 配置的标签。 |
同步配置
当业务部署在多个环境或者业务环境迁移时,可能会需要将配置同步到其他Nacos实例或者命名空间。MSE Nacos支持支持将配置批量同步至指定命名空间或指定实例。
同资源池配置同步
- 登录微服务引擎MSE注册配置中心管理控制台,选择资源池。
- 在左侧导航栏,选择注册配置中心 > 实例列表。
- 在实例列表页面,单击目标实例ID、实例名称或者目标行“管理”按钮均可跳转至实例基础信息页面。
- 在基础信息页面,点击配置管理>配置列表,选择命名空间,查看当前配置。
- 点击需要同步的目标配置的单选按钮,选中配置,或者点击表哥表头的单选框选中批量选中。
- 然后点击配置同步按钮,打开同步配置弹出框,选择目标实例(不选则默认本实例),选择目标命名空间,再选择相同配置的处理策略,可以修改同步之后的配置名称和分组名称。
- 点击同步按钮,提交同步操作。返回的结果包括同步成功的数量、跳过以及覆盖的数量。
提示:
- 相同配置策略分为三种。
策略 | 说明 |
---|---|
终止导入 | 遇到相同Data ID和Group的配置,直接终止导入,后续的导入操作不再执行。 |
跳过 | 遇到相同Data ID和Group的配置直接跳过,不覆盖配置继续执行。 |
覆盖 | 遇到相同Data ID和Group的配置直接覆盖配置,继续执行。 |
- 在同步配置的弹出框中,可以修改待同步的配置的Data ID和分组,修改后的值仅在目标实例命名空间下生效,原配置不会被改变。
管理配置
MSE 注册配置中心Nacos 提供配置的增删改改查操作。您可以通过控制台页面管理配置,发布之后,可以动态生效,无需重启应用。
查询配置
- 登录微服务引擎MSE注册配置中心管理控制台,选择资源池。
- 在左侧导航栏,选择注册配置中心 > 实例列表,单击实例ID 或者管理按钮跳转至基础信息页面。
- 在基础信息页面,左侧菜单点击配置管理>配置列表,选择命名空间,查看当前配置。
- 在配置列表页面可以根据Data ID、Group 、归属应用和标签维度筛选,然后点击查询。
查看和编辑配置
- 在配置列表页面,点击编辑按钮,进入配置详情页面。
- 在配置详情页面,可以查看配置的具体信息。
- 相较于创建配置的页面,编辑配置页面额外提供了Beta发布和配置内容对比的高级特性。
- 在创建Beta配置时,需要同时配置beta发布的IP或者IP段,多个配置可使用英文逗号分隔
- 当创建一个Beta配置后,点击编辑配置,会出现两个tab, 一个tab为发布beta之前的正式配置,另一个tab为beta配置,在Beta这个tab可以选择将beta发布为正式配置,或者将beta配置停止,停止后配置内容恢复到创建beta之前的正式内容。
- 当修改完配置,点击发布按钮时,会弹出一个对比框,对比配置内容变化的地方,供用户参考,降低误操作的可能性。
删除配置
- 在配置列表页面,点击目标配置行操作列的删除按钮。
- 在删除配置的对话框中确认需要删除的配置后点击确定。
查看历史版本
MSE 注册配置中心提供了配置历史查询功能。目前默认仅保存30天以内的变更记录。本文介绍如何查看配置历史版本。
查看历史版本
- 登录微服务引擎MSE注册配置中心管理控制台,选择资源池。
- 在左侧导航栏,选择注册配置中心 > 实例列表,单击实例ID 或者管理按钮跳转至基础信息页面。
- 在基础信息页面,左侧菜单点击配置管理>配置列表,选择命名空间,查看当前配置。
- 在左侧导航栏,选择历史版本。
- 在历史版本页面选择命名空间、分组、和Data ID,点击搜索,即可查看配置的历史。
字段 | 说明 |
---|---|
Data ID | 配置的Data ID |
Group | 配置的Group |
更新时间 | 配置更新发布的时间 |
所属应用 | 配置所属应用 |
操作类型 | 配置操作类型:插入、更新 |
- 最右侧操作列提供查看和会滚的操作。点击查看可以查看所选的历史版本的配置的详细信息。
- 点击回滚会弹出框对比所选历史版本和当前最新版本的对比信息。点击确认回滚,即可将配置回滚至历史版本。
监听查询
客户端注册监听配置,服务端在内存中维护一个监听客户端列表,当配置信息变更后,自动推送至客户端。
监听查询
- 登录微服务引擎MSE注册配置中心管理控制台,选择资源池。
- 在左侧导航栏,选择注册配置中心 > 实例列表,单击实例ID 或者管理按钮跳转至基础信息页面。
- 在基础信息页面,左侧菜单点击配置管理> 监听查询,选择命名空间。
- 可以根据需要选择查询维度:配置或则IP。配置维度查询需要输入或选择分组和Data ID,点击查询该配置推送到机器的状态。
- IP维度查询该机器监听的所有配置,需要填入IP作为参数查询。
配置透视
MSE 注册配置中心提供了配置透视功能。支持查看配置监听客户端的信息以及客户端与服务端配置内容的对比。
操作步骤
- 登录微服务引擎MSE注册配置中心管理控制台,选择资源池。
- 在左侧导航栏,选择注册配置中心 > 实例列表,单击实例ID 或者管理按钮跳转至基础信息页面。
- 在基础信息页面,左侧菜单点击配置管理> 监听查询,选择命名空间。
- 可以根据需要选择查询维度:配置或则IP。配置维度查询需要输入或选择分组和Data ID,点击查询监听该配置的客户端信息,包括客户端IP、客户端当前配置的MD5和客户端当前Nacos版本等信息。
- IP维度查询该机器监听的所有配置,需要填入IP作为参数查询。
查询推送轨迹
客户端监听配置,当配置变更时,服务端将变更推送至客户端。如果修改某个客户端配置未生效,则可以借助推送轨迹定位问题。
操作步骤
- 登录微服务引擎MSE注册配置中心管理控制台,选择资源池。
- 在左侧导航栏,选择注册配置中心 > 实例列表,单击实例ID 或者管理按钮跳转至基础信息页面。
- 在基础信息页面,左侧菜单点击配置管理> 推送轨迹,选择命名空间。
- 找到目标配置所在行,点击推送轨迹按钮,可以快速查看该配置服务的推送轨迹。也可以直接点击配置管理> 推送轨迹,然后选择命名空间,选择Data ID和分组,查看对应配置的推送轨迹数据。
- 在推送轨迹页面,还可以根据需要选择查询维度:配置或则IP。配置维度查询需要输入或选择分组和Data ID,选择时间或者自定义时间,点击查询。IP维度查询客户端收到的全部推送信息,需要输入客户端IP作为查询参数.
配置加密
MSE注册配置中心的配置文件一般都是以明文的格式存储,但是对于部分敏感数据可能需要加密存储,通过SPI插件机制实现配置加密和解密,从而减少数据泄露风险。
创建加密配置
- 登录微服务引擎MSE注册配置中心管理控制台,选择资源池。
- 在左侧导航栏,选择注册配置中心 > 实例列表,单击实例ID 或者管理按钮跳转至基础信息页面。
- 在基础信息页面,左侧菜单点击配置管理> 配置列表,选择命名空间,点击创建配置。
- 在创建配置面板,开启数据加密开关,选择加密算法,默认为AES-256加密算法。
- 选择配置格式,填写配置内容,然后点击发布。
- 加密配置默认dataId增加cipher-aes前缀,在MSE管理控制台查看加密配置时看到的解密后的明文。
配置灰度发布
MSE 注册配置中心支持配置灰度发布功能,即创建一个beta配置,指定使用范围,经过验证后可以发布为正式配置或者回滚。缩小配置变更的影响范围。
背景
使用Nacos作为配置中心集中托管配置,当配置变更时自动推送给所有监听的应用客户端,非常方便。但同时也使得误操作影响的范围更大,一个误操作,可能导致众多的应用出现问题。
因此为了避免大范围出现问题,可以在进行配置变更时,使用Beta配置功能,指定一小部分范围的应用作为验证,仅指定范围的应用能收到更新推送。如果验证无误,则可以将Beta配置发布为正式配置,推送到全量客户端。如果验证存在问题,则可以停止Beta配置,配置将恢复到上一个正式配置。整个过程如下图所示:
创建Beta配置
- 登录微服务引擎MSE注册配置中心管理控制台,选择资源池。
- 在左侧导航栏,选择注册配置中心 > 实例列表,单击实例ID 或者管理按钮跳转至基础信息页面。
- 在基础信息页面,左侧菜单点击配置管理> 配置列表,选择命名空间,查看配置列表。
- 在目标配置的操作列,点击编辑,打开编辑面板,打开Beta发布开关。
- 点击IP输入框,在输入框中填写灰度推送的IP地址。既可以填写IP,也可以配置IP段。
- 修改完配置后,点击发布。
查看Beta配置
- 登录微服务引擎MSE注册配置中心管理控制台,选择资源池。
- 在左侧导航栏,选择注册配置中心 > 实例列表,单击实例ID 或者管理按钮跳转至基础信息页面。
- 在基础信息页面,左侧菜单点击配置管理> 配置列表,选择命名空间,查看配置列表。
- 在发布了Beta配置的目标配置的操作列点击编辑,打开编辑面板。
- 在编辑配置面板的Beta 页中,查看Beta发布信息。
- 在验证完毕后可以点击正式发布,将beta发布为正式配置,或者点击停止beta,取消Beta发布,配置内容恢复到创建beta之前的正式内容。
配置导入导出
MSE Nacos提供Nacos配置的导入导出功能。本文介绍如何使用Nacos导入和导出数据。
配置导入
- 登录微服务引擎MSE注册配置中心管理控制台,选择资源池。
- 在左侧导航栏,选择注册配置中心 > 实例列表,单击实例ID 或者管理按钮跳转至基础信息页面。
- 在基础信息页面,左侧菜单点击配置管理> 配置列表,选择命名空间,查看配置列表。
- 点击导入配置按钮,弹出框会显示本次导入配置的命名空间。
- 选择对应的相同配置策略,点击上传文件按钮,上传需要导入的配置文件。
- 点击确定导入按钮开始导入配置,稍等片刻即可完成导入。
- 导入完成后,会在弹出框显示导入结果。
相同配置策略说明:
相同配置策略,即在配置导入的过程中,目标命名空间已存在相同配置的处理策略。三种策略的说明如下:
相同配置策略 | 说明 |
---|---|
终止导入 | 终止本次导入 |
跳过导入 | 跳过已存在的配置 |
覆盖导入 | 覆盖已存在的配置 |
配置导出
- 登录微服务引擎MSE注册配置中心管理控制台,选择资源池。
- 在左侧导航栏,选择注册配置中心 > 实例列表,单击实例ID 或者管理按钮跳转至基础信息页面。
- 在基础信息页面,左侧菜单点击配置管理> 配置列表,选择命名空间,查看配置列表。
- 选择需要导出的配置项,点击导出配置按钮,弹出框会显示本次待导出的配置项。
- 点击开始导出按钮,即可下载导出的配置文件。