更新时间:2024-09-26 GMT+08:00

配置管理(适用于2.x版本)

微服务引擎定义了一套与开发框架无关的配置机制。配置项由key、label和value组成,通过label区分配置项属于全局配置、微服务配置等作用范围,label也可以表示value的类型。

配置项使用明文存储,请勿附带敏感数据。

您可以根据需要参考下表选择需要执行的操作。

操作名称

操作说明

创建应用级配置

将新建的配置关联到某一应用,并添加应用名称和所在环境标签。

创建微服务级配置

将新建的配置关联到某一微服务,并添加微服务名称、应用名称和环境。

创建自定义配置

当应用级配置、微服务级配置不能满足使用需求时,可自定义配置文件。

导入配置

导入本地配置文件。

导出配置

导出选定的配置文件到本地。

对比配置版本

提供了不同历史版本之间差异比对。

回滚版本

从当前版本回滚到选择的历史版本。

查看历史版本

可查看不同历史版本的配置。

编辑配置项

可通过需要编辑配置项配置内容。

禁用配置项

禁用某配置项。

删除配置项

删除某一配置项。

当引擎规格限定的配置条目配额即将用完时,为了保证尽量可用,引擎允许超出剩余配额的新建配置项操作同时成功。请尽快扩容引擎,避免后续新建配置失败。

创建应用级配置

  1. 登录ServiceStage控制台,选择“微服务引擎 > 引擎实例”。
  2. 在页面上方“微服务引擎”下拉列表,选择待操作的微服务引擎。
  3. 选择“配置管理”

    • 未开启安全认证的微服务引擎,请执行5
    • 开启安全认证的微服务引擎,请执行4

  4. 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”

  5. 单击“新建配置”,参考下表设置配置参数。参数前面带*号的是必须设置的参数。

    参数名称

    参数说明

    *配置项

    输入配置项。

    配置项为该配置的全局ID,在编码阶段通过配置项对配置进行索引及操作。建议采用类Java包命名方式(如cse.service.registry.address)的命名规则来保证配置项的可读性和唯一性。

    说明:

    创建应用级配置时不允许创建以“servicecomb.matchGroup.”开头的配置项,此开头的配置会与创建业务场景治理生成的配置冲突,导致业务场景无法显示。

    配置范围

    选择“应用级配置”

    *应用

    1. 选择或输入应用名称。
    2. 选择环境。

    配置格式

    选择配置格式,支持TEXT、YAML、JSON、Properties、INI、XML常见配置格式在线编辑。默认为:TEXT。

    *配置内容

    输入配置内容。

    是否启用

    选择是否启用配置:

    • 现在启用:创建成功后,配置立即生效。
    • 暂不启用:创建成功后,配置暂不生效。

  6. 单击“立即创建”,启用该配置项。

创建微服务级配置

  1. 登录ServiceStage控制台,选择“微服务引擎 > 引擎实例”。
  2. 在页面上方“微服务引擎”下拉列表,选择待操作的微服务引擎。
  3. 选择“配置管理”

    • 未开启安全认证的微服务引擎,请执行5
    • 开启安全认证的微服务引擎,请执行4

  4. 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”

  5. 单击“新建配置”,参考下表设置配置参数。参数前面带*号的是必须设置的参数。

    参数名称

    参数说明

    *配置项

    输入配置项。

    配置项为该配置的全局ID,在编码阶段通过配置项对配置进行索引及操作。建议采用类Java包命名方式(如cse.service.registry.address)的命名规则来保证配置项的可读性和唯一性。

    配置范围

    选择“微服务级配置”

    *微服务

    1. 选择或者输入微服务名称。
    2. 选择或输入应用名称。
    3. 选择环境。

    配置格式

    选择配置格式,支持TEXT、YAML、JSON、Properties、INI、XML常见配置格式在线编辑。默认为:TEXT。

    *配置内容

    输入配置内容。

    是否启用

    选择是否启用配置:

    • 现在启用:创建成功后,配置立即生效。
    • 暂不启用:创建成功后,配置暂不生效。

  1. 单击“立即创建”,启用该配置项。

创建自定义配置

  1. 登录ServiceStage控制台,选择“微服务引擎 > 引擎实例”。
  2. 在页面上方“微服务引擎”下拉列表,选择待操作的微服务引擎。
  3. 选择“配置管理”

    • 未开启安全认证的微服务引擎,请执行5
    • 开启安全认证的微服务引擎,请执行4

  4. 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”

  5. 单击“新建配置”,参考下表设置配置参数。参数前面带*号的是必须设置的参数。

    参数名称

    参数说明

    *配置项

    输入配置项。

    配置项为该配置的全局ID,在编码阶段通过配置项对配置进行索引及操作。建议采用类Java包命名方式(如cse.service.registry.address)的命名规则来保证配置项的可读性和唯一性。

    配置范围

    选择“自定义配置”

    标签

    当应用级配置、微服务级配置不能满足使用需求,可通过标签创建自定义配置。

    配置格式

    选择配置格式,支持TEXT、YAML、JSON、Properties、INI、XML常见配置格式在线编辑。默认为:TEXT。

    *配置内容

    输入配置内容。

    是否启用

    选择是否启用配置:

    • 现在启用:创建成功后,配置立即生效。
    • 暂不启用:创建成功后,配置暂不生效。

  6. 单击“立即创建”,启用该配置项。

导入配置

  1. 登录ServiceStage控制台,选择“微服务引擎 > 引擎实例”。
  2. 在页面上方“微服务引擎”下拉列表,选择待操作的微服务引擎。
  3. 选择“配置管理”

    • 未开启安全认证的微服务引擎,请执行5
    • 开启安全认证的微服务引擎,请执行4

  4. 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”

  5. 单击右上角的“导入”,参考下表设置导入参数。

    参数名称

    参数说明

    导入至特定环境

    • 关闭:导入的配置不改变环境标签。
    • 开启:把配置导入至特定环境,将会改变环境标签。

    相同配置

    • 终止导入:导入过程中,如果遇到和系统中相同的配置,导入终止。
    • 跳过:导入过程中,如果遇到和系统中相同的配置,该配置会被跳过,继续导入其余配置。
    • 覆盖:导入过程中,如果遇到和系统中相同的配置,该配置的值会被替换。

    配置文件

    单击“导入文件”,选择待导入配置文件。

    说明:

    待导入的配置文件大小不超过2MB。

  6. 单击“关闭”,完成导入。

导出配置

  1. 登录ServiceStage控制台,选择“微服务引擎 > 引擎实例”。
  2. 在页面上方“微服务引擎”下拉列表,选择待操作的微服务引擎。
  3. 选择“配置管理”

    • 未开启安全认证的微服务引擎,请执行5
    • 开启安全认证的微服务引擎,请执行4

  4. 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”

  5. 勾选待导出的配置项,单击“导出”,在弹出框中单击“导出”,配置文件导出成功。也可单击右上方的“全部导出”导出所有配置信息。

对比配置版本

  1. 登录ServiceStage控制台,选择“微服务引擎 > 引擎实例”。
  2. 在页面上方“微服务引擎”下拉列表,选择待操作的微服务引擎。
  3. 选择“配置管理”

    • 未开启安全认证的微服务引擎,请执行5
    • 开启安全认证的微服务引擎,请执行4

  4. 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”

  5. 单击待对比的配置项名称。
  6. 单击“历史版本”
  7. 在左侧“历史版本”列表选择待查看的历史版本。

    在右侧“配置文件”列,可查看历史版本和当前版本的差异。

    在“历史版本”列表中最多可显示100个历史版本。

回滚版本

  1. 登录ServiceStage控制台,选择“微服务引擎 > 引擎实例”。
  2. 在页面上方“微服务引擎”下拉列表,选择待操作的微服务引擎。
  3. 选择“配置管理”

    • 未开启安全认证的微服务引擎,请执行5
    • 开启安全认证的微服务引擎,请执行4

  4. 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”

  5. 单击待操作的配置项名称。
  6. 单击“历史版本”
  7. 在左侧“历史版本”列表,选择待回滚到的历史版本。
  8. 在右侧“配置文件”列,单击“回滚到此版本”

查看历史版本

  1. 登录ServiceStage控制台,选择“微服务引擎 > 引擎实例”。
  2. 在页面上方“微服务引擎”下拉列表,选择待操作的微服务引擎。
  3. 选择“配置管理”

    • 未开启安全认证的微服务引擎,请执行5
    • 开启安全认证的微服务引擎,请执行4

  4. 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”

  5. 单击某配置项右侧“操作”列的“查看历史版本”,进入“历史版本”页面可查看该配置项的历史版本,在该页面也可对比配置版本和回滚版本操作。

编辑配置项

  1. 登录ServiceStage控制台,选择“微服务引擎 > 引擎实例”。
  2. 在页面上方“微服务引擎”下拉列表,选择待操作的微服务引擎。
  3. 选择“配置管理”

    • 未开启安全认证的微服务引擎,请执行5
    • 开启安全认证的微服务引擎,请执行4

  4. 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”

  5. 单击待编辑的配置项右侧“操作”列的“编辑”,也可单击待编辑的配置项名称,在配置详情页面,单击“编辑”。
  6. 在“配置内容”输入框输入配置信息,单击“保存”编辑配置项完成。

禁用配置项

  1. 登录ServiceStage控制台,选择“微服务引擎 > 引擎实例”。
  2. 在页面上方“微服务引擎”下拉列表,选择待操作的微服务引擎。
  3. 选择“配置管理”

    • 未开启安全认证的微服务引擎,请执行5
    • 开启安全认证的微服务引擎,请执行4

  4. 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”

  5. 在待禁用的配置项右侧“操作”列选择“更多 > 禁用”。
  6. 在弹出框中单击“确定”禁用该配置项。

删除配置项

  1. 登录ServiceStage控制台,选择“微服务引擎 > 引擎实例”。
  2. 在页面上方“微服务引擎”下拉列表,选择待操作的微服务引擎。
  3. 选择“配置管理”

    • 未开启安全认证的微服务引擎,请执行5
    • 开启安全认证的微服务引擎,请执行4

  4. 在弹出的“安全认证”对话框输入账号名及其密码,单击“确定”

  5. 在待删除的配置项右侧“操作”列选择“更多 > 删除”,也可单击待删除的配置项名称,在配置详情页面,单击“删除”。
  6. 在弹出框中单击“确定”删除该配置项。