Creating a Configuration for ServiceComb Engine 2.x
ServiceComb engines define 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.
Restrictions
- Configuration items are stored in plaintext. Do not include sensitive data.
- 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 to ensure capacity availability. Expand the capacity of the engine as soon as possible to prevent configuration creation failures.
- When editing or deleting a configuration item used by a microservice, the microservice may fail to read the configuration or read an incorrect configuration, causing service exceptions. Therefore, back up the configuration before modifying or deleting configuration items.
Creating an Application-Level Configuration
Associates the new configuration with an application, and adds the application name and environment label.
- Click the target engine.
- Choose Configuration Management.
- For engines with security authentication disabled, go to 4.
- For engines with security authentication enabled, if the login VDC user is the user imported in Importing an IAM Account, go to 4. For other users, go to 3.
- In the displayed Security Authentication dialog box, enter the account name and password, and click OK.
- If you connect to the ServiceComb engine for the first time, enter the account name root and the password entered when Creating a ServiceComb Engine.
- For details about how to create an account, see Adding an Account.
- Click Create Configuration Item and set parameters by referring to 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 items starting with servicecomb.matchGroup. cannot be created during application-level configuration creation. Such configuration items conflict with the configuration generated during service scenario governance creation, so the service scenario cannot be displayed.
Configuration Scope
Select Application-level.
*Application
- Select or enter an application name.
- Select an environment.
Configuration Format
Select a configuration format. Common configuration formats such as TEXT, YAML, JSON, Properties, INI and XML can be edited online. The default value is TEXT.
*Configuration Content
Enter the configuration content.
Enable Configuration
Determine whether to enable the configuration item.
- Enable now: The configuration item takes effect immediately once being created.
- Not Enabled: The configuration item does not take effect.
- Click Create Now to enable the configuration item.
Creating a Microservice-Level Configuration
Associates the new configuration with a microservice, and adds the microservice name, application name, and environment.
- Click the target engine.
- Choose Configuration Management.
- For engines with security authentication disabled, go to 4.
- For engines with security authentication enabled, if the login VDC user is the user imported in Importing an IAM Account, go to 4. For other users, go to 3.
- In the displayed Security Authentication dialog box, enter the account name and password, and click OK.
- If you connect to the ServiceComb engine for the first time, enter the account name root and the password entered when Creating a ServiceComb Engine.
- For details about how to create an account, see Adding an Account.
- Click Create Configuration Item and set parameters by referring to 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 Scope
Select Microservice-level.
*Microservice
- Select or enter a microservice name.
- Select or enter an application name.
- Select an environment.
Configuration Format
Select a configuration format. Common configuration formats such as TEXT, YAML, JSON, Properties, INI and XML can be edited online. The default value is TEXT.
*Configuration Content
Enter the configuration content.
Enable Configuration
Determine whether to enable the configuration item.
- Enable now: The configuration item takes effect immediately once being created.
- Not Enabled: The configuration item does not take effect.
- Click Create Now to enable the configuration item.
Creating a Customized Configuration Item
If application-level and microservice-level configurations cannot meet service requirements, you can customize configuration files.
- Click the target engine.
- Choose Configuration Management.
- For engines with security authentication disabled, go to 4.
- For engines with security authentication enabled, if the login VDC user is the user imported in Importing an IAM Account, go to 4. For other users, go to 3.
- In the displayed Security Authentication dialog box, enter the account name and password, and click OK.
- If you connect to the ServiceComb engine for the first time, enter the account name root and the password entered when Creating a ServiceComb Engine.
- For details about how to create an account, see Adding an Account.
- Click Create Configuration Item and set parameters by referring to 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 Scope
Select Customize.
Tag
If application-level and microservice-level configurations cannot meet service requirements, you can use labels to customize configurations.
Configuration Format
Select a configuration format. Common configuration formats such as TEXT, YAML, JSON, Properties, INI and XML can be edited online. The default value is TEXT.
*Configuration Content
Enter the configuration content.
Enable Configuration
Determine whether to enable the configuration item.
- Enable now: The configuration item takes effect immediately once being created.
- Not Enabled: The configuration item does not take effect.
- Click Create Now to enable the configuration item.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot