Help Center/ ServiceStage/ User Guide (Kuala Lumpur Region)/ Microservice Engine/ Using Microservice Engines/ Configuration Management (Applicable to Microservice Engine 2.x)
Updated on 2024-08-05 GMT+08:00
View PDF
Share

Configuration Management (Applicable to Microservice Engine 2.x)

CSE defines a configuration mechanism that is irrelevant to development frameworks. A configuration item consists of a key, label, and value. The label is used to identify whether a configuration item belongs to global configuration or microservice configuration. The label can also indicate the value type.

You can refer to the following table to select the operations to be performed.

Operation

Description

Creating an Application-Level Configuration

Associates the new configuration with an application, and adds the application name and environment label.

Creating a Microservice-Level Configuration

Associates the new configuration with a microservice, and adds the microservice name, application name, and environment.

Creating a Customized Configuration Item

If application-level and microservice-level configurations cannot meet service requirements, you can customize configuration files.

Importing Configurations

Imports the local configuration file.

Exporting Configurations

Exports the selected configuration file to the local host.

Comparing Configuration Versions

Compares differences between historical versions.

Rolling Back a Version

Rolls back to the selected historical version.

Viewing Historical Versions

Displays configurations of different historical versions.

Editing a Configuration Item

Edits a configuration item.

Disabling a Configuration Item

Disables a configuration item.

Deleting a Configuration Item

Deletes a configuration item.

When the configuration item quota specified by the engine specifications is about to be used up, the engine allows new configuration items that exceed the remaining quota to be created at the same time to ensure availability. Expand the capacity of the engine as soon as possible to prevent configuration creation failures.

Creating an Application-Level Configuration

  1. Log in to ServiceStage and choose Cloud Service Engine > Engines.
  2. Select the microservice engine where the application has been deployed but is to be governed from the Microservice Engine drop-down list in the upper part of the page.

  3. Click Configuration Management.

    • For microservice engines with security authentication disabled, go to 5.
    • For microservice engines with security authentication enabled, go to 4.

  4. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.

  1. Click Create Configuration Item and set parameters based on the following table. Parameters marked with an asterisk (*) are mandatory.

    Parameter

    Description

    *Configuration Item

    Enter a configuration item.

    The configuration item is the global ID of the configuration. In the coding phase, the configuration item is used to index and operate the configuration. You are advised to use the Java package naming rule (for example, cse.service.registry.address) to ensure the readability and uniqueness of the configuration.

    Configuration Range

    Select Application-level.

    *Application
    1. Select or enter an application name.
    2. Select an environment.

    Configuration Format

    Select a configuration format.

    *Configuration Content

    Enter the configuration content.

    Enable Configuration

    Determine whether to enable the configuration item.

    • Enable now: The configuration item takes effect immediately once created.
    • Not Enabled: The configuration item does not take effect.

  2. Click Create Now to enable the configuration item.

Creating a Microservice-Level Configuration

  1. Log in to ServiceStage and choose Cloud Service Engine > Engines.
  2. Select the microservice engine where the microservice has been deployed but is to be governed from the Microservice Engine drop-down list in the upper part of the page.

  3. Click Configuration Management.

    • For microservice engines with security authentication disabled, go to 5.
    • For microservice engines with security authentication enabled, go to 4.

  4. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.

  1. Click Create Configuration Item and set parameters based on the following table. Parameters marked with an asterisk (*) are mandatory.

    Parameter

    Description

    *Configuration Item

    Enter a configuration item.

    The configuration item is the global ID of the configuration. In the coding phase, the configuration item is used to index and operate the configuration. You are advised to use the Java package naming rule (for example, cse.service.registry.address) to ensure the readability and uniqueness of the configuration.

    Configuration Range

    Select Microservice-level.

    *Microservice
    1. Select or enter a microservice name.
    2. Select or enter an application name.
    3. Select an environment.

    Configuration Format

    Select a configuration format.

    *Configuration Content

    Enter the configuration content.

    Enable Configuration

    Determine whether to enable the configuration item.

    • Enable now: The configuration item takes effect immediately once created.
    • Not Enabled: The configuration item does not take effect.

  2. Click Create Now to enable the configuration item.

Creating a Customized Configuration Item

  1. Log in to ServiceStage and choose Cloud Service Engine > Engines.
  2. Select the target microservice engine from the Microservice Engine drop-down list in the upper part of the page.

  3. Click Configuration Management.

    • For microservice engines with security authentication disabled, go to 5.
    • For microservice engines with security authentication enabled, go to 4.

  4. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.

  1. Click Create Configuration Item and set parameters based on the following table. Parameters marked with an asterisk (*) are mandatory.

    Parameter

    Description

    *Configuration Item

    Enter a configuration item.

    The configuration item is the global ID of the configuration. In the coding phase, the configuration item is used to index and operate the configuration. You are advised to use the Java package naming rule (for example, cse.service.registry.address) to ensure the readability and uniqueness of the configuration.

    Configuration Range

    Select Customize.

    *Labels

    If application-level and microservice-level configurations cannot meet service requirements, you can use labels to customize configurations.

    Configuration Format

    Select a configuration format.

    *Configuration Content

    Enter the configuration content.

    Enable Configuration

    Determine whether to enable the configuration item.

    • Enable now: The configuration item takes effect immediately once created.
    • Not Enabled: The configuration item does not take effect.

  2. Click Create Now to enable the configuration item.

Importing Configurations

  1. Log in to ServiceStage and choose Cloud Service Engine > Engines.
  2. Select the target microservice engine from the Microservice Engine drop-down list in the upper part of the page.

  3. Click Configuration Management.

    • For microservice engines with security authentication disabled, go to 5.
    • For microservice engines with security authentication enabled, go to 4.

  4. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.

  1. Click Import in the upper right corner and set parameters by referring to the following table.

    Parameter

    Description

    Import to a 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.

    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.

    NOTE:

    The file size cannot exceed 2 MB.

  2. Click Close.

Exporting Configurations

  1. Log in to ServiceStage and choose Cloud Service Engine > Engines.
  2. Select the target microservice engine from the Microservice Engine drop-down list in the upper part of the page.

  3. Click Configuration Management.

    • For microservice engines with security authentication disabled, go to 5.
    • For microservice engines with security authentication enabled, go to 4.

  4. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.

  1. Select the configuration items to be exported and click Export.

Comparing Configuration Versions

  1. Log in to ServiceStage and choose Cloud Service Engine > Engines.
  2. Select the target microservice engine from the Microservice Engine drop-down list in the upper part of the page.

  3. Click Configuration Management.

    • For microservice engines with security authentication disabled, go to 5.
    • For microservice engines with security authentication enabled, go to 4.

  4. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.

  1. Click the configuration item to be compared.
  2. Click View Historical Version.
  3. In Historical Versions on the left, select the historical version to be viewed.

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

Rolling Back a Version

  1. Log in to ServiceStage and choose Cloud Service Engine > Engines.
  2. Select the target microservice engine from the Microservice Engine drop-down list in the upper part of the page.

  3. Click Configuration Management.

    • For microservice engines with security authentication disabled, go to 5.
    • For microservice engines with security authentication enabled, go to 4.

  4. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.

  1. Click the target configuration item.
  2. Click View Historical Version.
  3. In Historical Versions on the left, select the target historical version.
  4. In Configuration file on the right, click Roll Back to the Selected Version.

Viewing Historical Versions

  1. Log in to ServiceStage and choose Cloud Service Engine > Engines.
  2. Select the target microservice engine from the Microservice Engine drop-down list in the upper part of the page.

  3. Click Configuration Management.

    • For microservice engines with security authentication disabled, go to 5.
    • For microservice engines with security authentication enabled, go to 4.

  4. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.

  1. Click View Historical Version in the Operation column of a configuration item. 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.

Editing a Configuration Item

  1. Log in to ServiceStage and choose Cloud Service Engine > Engines.
  2. Select the target microservice engine from the Microservice Engine drop-down list in the upper part of the page.

  3. Click Configuration Management.

    • For microservice engines with security authentication disabled, go to 5.
    • For microservice engines with security authentication enabled, go to 4.

  4. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.

  1. 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.
  2. Enter the configuration information in the Configuration Content text box and click Save.

Disabling a Configuration Item

  1. Log in to ServiceStage and choose Cloud Service Engine > Engines.
  2. Select the target microservice engine from the Microservice Engine drop-down list in the upper part of the page.

  3. Click Configuration Management.

    • For microservice engines with security authentication disabled, go to 5.
    • For microservice engines with security authentication enabled, go to 4.

  4. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.

  1. In the Operation column of the target configuration item, click More > Disable.
  2. Click OK.

Deleting a Configuration Item

  1. Log in to ServiceStage and choose Cloud Service Engine > Engines.
  2. Select the target microservice engine from the Microservice Engine drop-down list in the upper part of the page.

  3. Click Configuration Management.

    • For microservice engines with security authentication disabled, go to 5.
    • For microservice engines with security authentication enabled, go to 4.

  4. In the displayed Security Authentication dialog box, enter the account name and password, and click OK.

  1. 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.
  2. Click OK.