配置管理(适用于2.x版本)
ServiceComb引擎定义了一套与开发框架无关的配置机制。配置项由key、label和value组成,通过label区分配置项属于全局配置、微服务配置等作用范围,label也可以表示value的类型。
配置项使用明文存储,请勿附带敏感数据。
操作名称 |
操作说明 |
---|---|
将新建的配置关联到某一应用,并添加应用名称和所在环境标签。 |
|
将新建的配置关联到某一微服务,并添加微服务名称、应用名称和环境。 |
|
当应用级配置、微服务级配置不能满足使用需求时,可自定义配置文件。 |
|
导入本地配置文件。 |
|
导出选定的配置文件到本地。 |
|
提供了不同历史版本之间差异比对。 |
|
从当前版本回滚到选择的历史版本。 |
|
可查看不同历史版本的配置。 |
|
可通过需要编辑配置项配置内容。 |
|
禁用某配置项。 |
|
删除某一配置项。 |
当引擎规格限定的配置条目配额即将用完时,为了保证尽量可用,引擎允许超出剩余配额的新建配置项操作同时成功。请尽快扩容引擎,避免后续新建配置失败。
创建应用级配置
- 登录微服务引擎控制台。
- 在左侧导航栏选择“ServiceComb引擎专享版”。
- 单击待操作的引擎。
- 选择“配置管理”。
- 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”。
- 首次连接ServiceComb引擎,请输入root账号名及创建ServiceComb引擎时输入的密码。
- 创建账号请参考新增账号。
- 单击“新建配置”,参考下表设置配置参数。参数前面带*号的是必须设置的参数。
参数名称
参数说明
*配置项
输入配置项。
配置项为该配置的全局ID,在编码阶段通过配置项对配置进行索引及操作。建议采用类Java包命名方式(如cse.service.registry.address)的命名规则来保证配置项的可读性和唯一性。
说明:创建应用级配置时不允许创建以“servicecomb.matchGroup.”开头的配置项,此开头的配置会与创建业务场景治理生成的配置冲突,导致业务场景无法显示。
配置范围
选择“应用级配置”。
*应用
- 选择或输入应用名称。
- 选择环境。
配置格式
选择配置格式,支持TEXT、YAML、JSON、Properties、INI、XML常见配置格式在线编辑。默认为:TEXT。
*配置内容
输入配置内容。
是否启用
选择是否启用配置:
- 现在启用:创建成功后,配置立即生效。
- 暂不启用:创建成功后,配置暂不生效。
- 单击“立即创建”,启用该配置项。
创建微服务级配置
- 登录微服务引擎控制台。
- 在左侧导航栏选择“ServiceComb引擎专享版”。
- 单击待操作的引擎。
- 选择“配置管理”。
- 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”。
- 首次连接ServiceComb引擎,请输入root账号名及创建ServiceComb引擎时输入的密码。
- 创建账号请参考新增账号。
- 单击“新建配置”,参考下表设置配置参数。参数前面带*号的是必须设置的参数。
参数名称
参数说明
*配置项
输入配置项。
配置项为该配置的全局ID,在编码阶段通过配置项对配置进行索引及操作。建议采用类Java包命名方式(如cse.service.registry.address)的命名规则来保证配置项的可读性和唯一性。
配置范围
选择“微服务级配置”。
*微服务
- 选择或者输入微服务名称。
- 选择或输入应用名称。
- 选择环境。
配置格式
选择配置格式,支持TEXT、YAML、JSON、Properties、INI、XML常见配置格式在线编辑。默认为:TEXT。
*配置内容
输入配置内容。
是否启用
选择是否启用配置:
- 现在启用:创建成功后,配置立即生效。
- 暂不启用:创建成功后,配置暂不生效。
- 单击“立即创建”,启用该配置项。
创建自定义配置
- 登录微服务引擎控制台。
- 在左侧导航栏选择“ServiceComb引擎专享版”。
- 单击待操作的引擎。
- 选择“配置管理”。
- 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”。
- 首次连接ServiceComb引擎,请输入root账号名及创建ServiceComb引擎时输入的密码。
- 创建账号请参考新增账号。
- 单击“新建配置”,参考下表设置配置参数。参数前面带*号的是必须设置的参数。
参数名称
参数说明
*配置项
输入配置项。
配置项为该配置的全局ID,在编码阶段通过配置项对配置进行索引及操作。建议采用类Java包命名方式(如cse.service.registry.address)的命名规则来保证配置项的可读性和唯一性。
配置范围
选择“自定义配置”。
标签
当应用级配置、微服务级配置不能满足使用需求,可通过标签创建自定义配置。
配置格式
选择配置格式,支持TEXT、YAML、JSON、Properties、INI、XML常见配置格式在线编辑。默认为:TEXT。
*配置内容
输入配置内容。
是否启用
选择是否启用配置:
- 现在启用:创建成功后,配置立即生效。
- 暂不启用:创建成功后,配置暂不生效。
- 单击“立即创建”,启用该配置项。
导入配置
- 登录微服务引擎控制台。
- 在左侧导航栏选择“ServiceComb引擎专享版”。
- 单击待操作的引擎。
- 选择“配置管理”。
- 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”。
- 首次连接ServiceComb引擎,请输入root账号名及创建ServiceComb引擎时输入的密码。
- 创建账号请参考新增账号。
- 单击右上角的“导入”,根据需要导入不同文件格式,参考下表设置导入参数。
表1 导入文件格式为V2.0 参数名称
参数说明
文件格式
可选择导入文件的格式,默认是V2.0。
导入至特定环境
- 关闭:导入的配置不改变环境标签。
- 开启:把配置导入至特定环境,将会改变环境标签。在下拉列表中选择特定环境。
相同配置
- 终止导入:导入过程中,如果遇到和系统中相同的配置,导入终止。
- 跳过:导入过程中,如果遇到和系统中相同的配置,该配置会被跳过,继续导入其余配置。
- 覆盖:导入过程中,如果遇到和系统中相同的配置,该配置的值会被替换。
配置文件
单击“导入文件”,选择待导入配置文件。
说明:待导入的配置文件大小不超过2MB。
表2 导入文件格式为V1.0 参数名称
参数说明
文件格式
可选择导入文件的格式,选择文件格式为V1.0。
*导入至特定环境
在下拉列表中选择微服务环境。
微服务名称
在下拉列表中选择将配置导入到的微服务。
微服务版本
在下拉列表中选择将配置导入到的微服务的版本。
*配置文件
单击“导入文件”,选择待导入配置文件。
说明:待导入的配置文件大小不超过2MB。
- 单击“关闭”,完成导入。
导出配置
- 登录微服务引擎控制台。
- 在左侧导航栏选择“ServiceComb引擎专享版”。
- 单击待操作的引擎。
- 选择“配置管理”。
- 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”。
- 首次连接ServiceComb引擎,请输入root账号名及创建ServiceComb引擎时输入的密码。
- 创建账号请参考新增账号。
- 勾选待导出的配置项,单击“导出”。
- 单击配置项上方的“导出”,在弹出框中单击“导出”,配置文件导出成功。
- 单击右上方的“导出”,在“导出配置”弹出框中,选择导出配置的文件格式,默认为V2.0,单击“确定”,配置文件导出成功。
当选择导出配置的文件格式为V1.0时,需在下拉框中选择微服务环境、微服务名称和微服务版本。
对比配置版本
- 登录微服务引擎控制台。
- 在左侧导航栏选择“ServiceComb引擎专享版”。
- 单击待操作的引擎。
- 选择“配置管理”。
- 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”。
- 首次连接ServiceComb引擎,请输入root账号名及创建ServiceComb引擎时输入的密码。
- 创建账号请参考新增账号。
- 单击待对比的配置项名称。
- 单击“历史版本”。
- 在左侧“历史版本”列表选择待查看的历史版本。
在右侧“配置文件”列,可查看历史版本和当前版本的差异。
在“历史版本”列表中最多可显示100个历史版本。
回滚版本
- 登录微服务引擎控制台。
- 在左侧导航栏选择“ServiceComb引擎专享版”。
- 单击待操作的引擎。
- 选择“配置管理”。
- 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”。
- 首次连接ServiceComb引擎,请输入root账号名及创建ServiceComb引擎时输入的密码。
- 创建账号请参考新增账号。
- 单击待操作的配置项名称。
- 单击“历史版本”。
- 在左侧“历史版本”列表,选择待回滚到的历史版本。
- 在右侧“配置文件”列,单击“回滚到此版本”。
查看历史版本
- 登录微服务引擎控制台。
- 在左侧导航栏选择“ServiceComb引擎专享版”。
- 单击待操作的引擎。
- 选择“配置管理”。
- 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”。
- 首次连接ServiceComb引擎,请输入root账号名及创建ServiceComb引擎时输入的密码。
- 创建账号请参考新增账号。
- 单击某配置项右侧“操作”列的“查看历史版本”,进入“历史版本”页面可查看该配置项的历史版本,在该页面也可对比配置版本和回滚版本操作。
编辑配置项
- 登录微服务引擎控制台。
- 在左侧导航栏选择“ServiceComb引擎专享版”。
- 单击待操作的引擎。
- 选择“配置管理”。
- 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”。
- 首次连接ServiceComb引擎,请输入root账号名及创建ServiceComb引擎时输入的密码。
- 创建账号请参考新增账号。
- 单击待编辑的配置项右侧“操作”列的“编辑”,也可单击待编辑的配置项名称,在配置详情页面,单击“编辑”。
- 在“配置内容”输入框输入配置信息,单击“保存”编辑配置项完成。
禁用配置项
- 登录微服务引擎控制台。
- 在左侧导航栏选择“ServiceComb引擎专享版”。
- 单击待操作的引擎。
- 选择“配置管理”。
- 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”。
- 首次连接ServiceComb引擎,请输入root账号名及创建ServiceComb引擎时输入的密码。
- 创建账号请参考新增账号。
- 在待禁用的配置项右侧“操作”列选择“更多 > 禁用”。
- 在弹出框中单击“确定”禁用该配置项。
删除配置项
- 登录微服务引擎控制台。
- 在左侧导航栏选择“ServiceComb引擎专享版”。
- 单击待操作的引擎。
- 选择“配置管理”。
- 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”。
- 首次连接ServiceComb引擎,请输入root账号名及创建ServiceComb引擎时输入的密码。
- 创建账号请参考新增账号。
- 在待删除的配置项右侧“操作”列选择“更多 > 删除”,也可单击待删除的配置项名称,在配置详情页面,单击“删除”。
- 在弹出框中单击“确定”删除该配置项。