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