Help Center/ Cloud Service Engine/ User Guide（Ally Region）/ ServiceComb Engines/ Configuration Management (Applicable to ServiceComb Engine 2.x)/ Managing Configurations for ServiceComb Engine 2.x
Updated on 2025-12-30 GMT+08:00
View PDF
Share

Managing Configurations for ServiceComb Engine 2.x

Editing a Configuration

You can edit the configuration information of a ServiceComb engine as required. The configuration can be dynamically updated without restarting the service.

  1. Click the target engine.
  2. Choose Configuration Management.

    • For engines with security authentication disabled, go to 4.
    • For engines with security authentication enabled, if the login user is the user imported in Importing an IAM Account, go to 4. For other users, go to 3.

  3. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.
  4. Click Edit in the Operation column of the target configuration item. You can also click the target configuration item and then click Edit on the displayed configuration details page.
  5. Enter the configuration information in the Configuration Content text box and click Save.

Importing Configurations

You can import a local JSON configuration file of a ServiceComb engine on the console to simplify the process of creating configurations manually. To reuse configurations among development, test, and pre-release environments, or to migrate a ServiceComb engine across clouds or platforms, you can export the configurations of the production environment first and then import the configuration file to the target engine to initialize the configurations in batches. This shortens the environment setup. If the configurations are deleted or tampered with, or the ServiceComb engine is faulty, you can import the backup configuration file to quickly rebuild the service configuration environment.

  • After importing the configuration file, the handling of existing configurations will be processed based on the specified processing policy, such as terminating the import, skipping the conflicting configurations, or overwriting them.
  • Before importing the configuration file, back up the existing target environment configurations. Import the file incrementally, and verify core service configurations in a small scope before proceeding with batch imports.
  1. Click the target engine.
  2. Choose Configuration Management.

    • For engines with security authentication disabled, go to 4.
    • For engines with security authentication enabled, if the login user is the user imported in Importing an IAM Account, go to 4. For other users, go to 3.

  3. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.
  4. Click Import in the upper right corner to Import files in different formats as required, and set parameters by referring to the following table.

    Table 1 V2.0 file

    Parameter

    Description

    File Format

    Select a format of the file to be imported. The default format is V2.0.

    Import to Specific Environment
    • Disabled: The imported configuration does not change the environment label.
    • Enabled: Importing the configuration to a specific environment will change the environment label. Select an environment from the drop-down list.

    Same Configuration
    • Terminate: If a configuration is the same as that in the system, the import terminates.
    • Skip: During import, if a configuration is the same as that in the system, the configuration is skipped and other configurations are imported.
    • Overwrite: During import, if a configuration is the same as that in the system, the value of the configuration will be replaced.

    Configuration File

    Click Import and select the target file.

    Only JSON files can be imported and the file size cannot exceed 2 MB.
    Table 2 V1.0 file

    Parameter

    Description

    File Format

    Select V1.0.

    *Import to Specific Environment

    Select a microservice environment.

    Microservice

    Select the microservice to which the configuration is imported from the drop-down list.

    Microservice Version

    Select a version of the microservice to which the configuration is imported from the drop-down list.

    *Configuration File

    Click Import and select the target file.

    Only JSON files can be imported and the file size cannot exceed 2 MB.

  5. Click Close.

Exporting Configurations

You can export the selected configuration file to a local path to prevent data loss (due to such as server faults and manual deletion) and periodically export configurations for restoration.

  1. Click the target engine.
  2. Choose Configuration Management.

    • For engines with security authentication disabled, go to 4.
    • For engines with security authentication enabled, if the login user is the user imported in Importing an IAM Account, go to 4. For other users, go to 3.

  3. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.
  4. Select the configuration items to be exported and click Export.

    • Click Export above the configuration items. In the displayed dialog box, click Export.
    • Click Export in the upper right corner. In the displayed dialog box, select the file format (V2.0 by default) and click OK.

      If the format of the exported configuration file is V1.0, you need to select the microservice environment from the drop-down list.

Viewing Configuration Details

  1. Click the target engine.
  2. Choose Configuration Management.

    • For engines with security authentication disabled, go to 4.
    • For engines with security authentication enabled, if the login user is the user imported in Importing an IAM Account, go to 4. For other users, go to 3.

  3. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.
  4. Click the target configuration item. The configuration item details page shows the configuration details.

Viewing Configurations of a Historical Version

You can view the configurations of different historical versions.

  1. Click the target engine.
  2. Choose Configuration Management.

    • For engines with security authentication disabled, go to 4.
    • For engines with security authentication enabled, if the login user is the user imported in Importing an IAM Account, go to 4. For other users, go to 3.

  3. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.
  4. Click View Historical Version in the Operation column of a configuration item. Alternatively, click Historical Versions on the configuration details page. On the Historical Versions page that is displayed, you can view the historical versions of the configuration item. On this page, you can compare the configuration version with the rollback version.

Comparing Configuration Versions

You can compare different historical versions.

  1. Click the target engine.
  2. Choose Configuration Management.

    • For engines with security authentication disabled, go to 4.
    • For engines with security authentication enabled, if the login user is the user imported in Importing an IAM Account, go to 4. For other users, go to 3.

  3. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.
  4. Click the configuration item to be compared.
  5. Click View Historical Version.
  6. In Historical Versions on the left, select the historical version to be viewed. A maximum of 100 historical versions can be displayed.

    In the Configuration file on the right, you can view the differences between the current and historical versions.

Rolling Back a Version

Roll back to the selected historical version.

  1. Click the target engine.
  2. Choose Configuration Management.

    • For engines with security authentication disabled, go to 4.
    • For engines with security authentication enabled, if the login user is the user imported in Importing an IAM Account, go to 4. For other users, go to 3.

  3. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.
  4. Click the target configuration item.
  5. Click View Historical Version.
  6. In Historical Versions on the left, select the target historical version.
  7. In Configuration file on the right, click Roll Back to the Selected Version.

Disable a configuration item

  1. Click the target engine.
  2. Choose Configuration Management.

    • For engines with security authentication disabled, go to 4.
    • For engines with security authentication enabled, if the login user is the user imported in Importing an IAM Account, go to 4. For other users, go to 3.

  3. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.
  4. In the Operation column of the target configuration item, click More > Disable.
  5. Click OK.

Deleting a Configuration Item

  1. Click the target engine.
  2. Choose Configuration Management.

    • For engines with security authentication disabled, go to 4.
    • For engines with security authentication enabled, if the login user is the user imported in Importing an IAM Account, go to 4. For other users, go to 3.

  3. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.
  4. Click Delete in the Operation column of the target configuration item. You can also click the target configuration item and then click Delete on the displayed configuration details page.
  5. Click OK.