Updated on 2025-08-12 GMT+08:00

Editing a Configuration File

This section describes how to edit a configuration file.

Prerequisites

The configuration file to be edited is available.

Editing a Configuration File

  1. Log in to ServiceStage.
  2. Choose Configuration Management > List.
  3. Use either of the following methods to go to the editing page:

    • Directly edit: Click Edit in the Operation column of the target configuration file.
    • Edit after viewing details: Click the target configuration file, view the details, and click Edit.

  4. In the Basic Info area, modify the configuration description.

    1. Click .
    2. Enter the configuration file description, which can contain up to 128 characters.
    3. Click .

  5. In the Configuration Content area, set configuration file parameters by referring to the following table.

    Parameter

    Description

    Associate Key

    If sensitive information such as passwords needs to be encrypted in your configuration items, you can interconnect with DEW and use a custom key to encrypt and decrypt sensitive information.

    1. Click Bind Associated Key.
    2. Select a created key from the Key drop-down list.

      To use a new key, click Create a Key. For details, see Creating a Key.

    3. Click OK.

    Mount Mode

    This parameter is available only for container-deployed components.

    • secret: If the configuration file contains sensitive data such as passwords, the configuration file can be mounted in this mode.
    • configmap: If the configuration file does not contain sensitive data, the configuration file can be mounted in this mode.

  6. In the Configuration Content area, set configuration file parameters by referring to the following table.

    Method

    Description

    Manual enter

    Manually enter the configuration file content in the editing area.

    Determine whether to encrypt variables (for example, xxx).

    • xxx indicates that encryption is disabled. During component deployment, actual values will be used as variables.
    • #{xxx} indicate that encryption is enabled. During component deployment, variables' actual values will be encrypted using a DEW key.

    Modify the example

    Modify the example provided by ServiceStage to set the configuration file.

    1. Click View Example. The Example dialog box is displayed.
    2. Click to copy the example.
    3. Click to close the Example dialog box.
    4. Paste the copied example to the editing box in Configuration Content, and edit the example.

      Determine whether to encrypt variables (for example, ${xxx}).

      • ${xxx} indicates that encryption is disabled. During component deployment, actual values will be used as variables.
      • #{${xxx}} indicate that encryption is enabled. During component deployment, variables' actual values will be encrypted using a DEW key.

    Insert system variables

    ServiceStage provides variables related to environments, applications, and components, as shown in Table 1. You can use these system variables in the configuration file.

    1. Click System Variables.
    2. Move the cursor to the variable to be written into the configuration file in the variable list, for example, xxx.
      • Click Insert to insert ${xxx} into the editing area under Configuration Content. During component deployment, actual values will be used as variables.
      • Click Insert and Encrypt to insert #{${xxx}} to the editing area under Configuration Content. # indicates that encryption is enabled. During component deployment, variables' actual values will be encrypted using a DEW key.

  7. (Optional) Click Verify Content and modify the configuration as prompted.
  8. Click Release. The system automatically verifies the content correctness. Modify the content as prompted.

    After the configuration file is edited, you can view the version details of the configuration file in the Configuration Management list. For details, see Viewing Version Details of a Configuration File.