Help Center/ ServiceStage/ User Guide/ Configuration Management/ Creating a Configuration File
Updated on 2024-12-16 GMT+08:00

Creating a Configuration File

This section describes how to create a configuration file and fill the system variables of the component environment and application in the variables in the configuration file, to deploy and upgrade multiple components of different applications in different environments.

A maximum of 1000 configuration files can be created in a project.

Creating a Configuration File

  1. Log in to ServiceStage.
  2. Choose Configuration Management > Create Configuration.
  3. In the Basic Info area, configure the configuration file by referring to the following table.

    Parameter

    Description

    Configuration Name

    Configuration file name, which cannot be modified after being created.

    Enter 2 to 64 characters. Start with a letter and end with a letter or digit. Only use letters, digits, underscores (_), and hyphens (-).

    Group

    Groups are used to manage configuration files by category. The configuration file name must be unique in a group.

    • Click Create Group to create a group. A maximum of 100 groups can be created in a project.

      Enter 2 to 64 characters. Start with a letter and end with a letter or digit. Only use letters, digits, underscores (_), and hyphens (-).

    • Click Manage Configuration Group to delete a configuration group that is no longer used.

      Configuration groups that have been associated with a configuration file cannot be deleted. To delete them, perform Deleting a Configuration File to disassociate the configuration groups from the configuration file.

    Description

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

  4. In the Configuration Content area, select a configuration file format.

    • Yaml: used for configuration files and data exchange. In a YAML file, attributes are usually in key-value pairs, where the key and value are separated by a colon (:).
    • Properties: used for configuration management. It is a simple key-value pair set used to store configuration information. Each line contains a key-value pair. The key and value are separated by an equal sign (=).

  5. In the Configuration Content area, set whether to encrypt data.

    If the configuration file contains sensitive data such as passwords, you can enable data encryption to protect your sensitive information from being disclosed.

    • Click to enable data encryption.
    • Click to disable data encryption.

    Only container-deployed components support data encryption. If data encryption is enabled, the configuration file is mounted using secret. If data encryption is disabled, the configuration file is mounted using ConfigMap.

  6. In the Configuration Content area, set the system variables.

    1. Click System Variables.
    2. Select the variable to be written into the configuration file from the Variable list.

      ServiceStage provides environment, application, and component variables listed in Table 1. These system variables can be used in configuration files and will be automatically replaced with actual values during component deployment.

    3. Click Insert and insert the variable into the text box under Configuration Content.

    You can also perform the following operations to quickly set system variables using the example provided by ServiceStage:

    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. Click , paste the copied example to the editing box in Configuration Content, and edit the example.

  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 created, you can view it in the Configuration Management list.