Restoring/Migrating Instance Assets
Scenarios
ROMA Connect allows you to export applications and tasks of an instance as an asset file and import an asset file to restore or migrate integration assets. For details on how to import and export assets, see Importing and Exporting Assets.
- Asset restoration: You can export integration assets from a ROMA Connect instance for data backup. In the event of a faulty instance or data loss, you can import the backup asset file to the instance for restoration.
You are advised to periodically export asset files (for example, on a monthly basis) for data backup and restoration.
- Asset migration: You can import an integration asset file that was exported from existing ROMA Connect instances into a new instance to quickly deploy and reuse existing integration assets.
Only integration asset data can be imported, excluding asset-related instance configuration data. After integration asset import, you need to reconfigure asset-related instance data.
| Category | Item | Description | Processing Method |
|---|---|---|---|
| Public instance information | Integration application secret | The secrets of integration applications are non-asset data. | After assets are imported, ROMA Connect automatically generates new secrets. Notify interworking service applications to update the secrets accordingly. |
| Integration application authorization information | The authorization information of integration applications is non-asset data. | Reconfigure user authorization after assets are imported. | |
| Data integration | Data source connection information | Includes the addresses, accounts, and passwords, which are non-asset data. | Configure connection information for the corresponding data sources after assets are imported. |
| Service integration | APIs that have not been published in the RELEASE environment | Include APIs that have not been published and APIs that have been published in a non-RELEASE environment. These APIs are non-asset data. | Re-create and publish APIs as required after assets are imported. |
| Environment information of APIs | Includes the independent domain names, environment variables, cloud server information of load balance channels, and non-default environments. This information is non-asset data. | Reconfigure environment information after assets are imported. | |
| Control policy information of APIs | Includes request throttling policies, access control policies, client access control policies, and client quota policies. This information is non-asset data. | Reconfigure control policy information after assets are imported. | |
| Secret information of APIs | Includes signature keys, client's AppCodes, and custom backends' configurations of the password or certificate type. This information is non-asset data. | After asset import:
| |
| Blacklist and whitelist specific to API authorization | The blacklist and whitelist specific to API authorization is non-asset data. | Reconfigure blacklist and whitelist information after assets are imported. | |
| Device integration | Device information | The device information is non-asset data. | Re-create devices after assets are imported. |
| Device rule information | The device rule information is non-asset data. | Re-create device rules after assets are imported. |
Restoration/Migration Process
The following table describes the restoration/migration process of integration assets.
| No. | Operation | Description |
|---|---|---|
| 1 | Obtain an integration asset package and collect information about interconnection with peripheral systems (such as data sources, backend services, and service applications). | |
| 2 | Modify the security group and configuration parameters of the instance you want to restore or a new instance. | |
| 3 | Import the integration asset package to the instance you want to restore or a new instance. | |
| 4 | Modify the authorization configurations of integration applications. | |
| 5 | Modify the connection configuration of data sources. | |
| 6 | Modify the environment, control policy, secret, and blacklist/whitelist configurations of APIs. | |
| 7 | Create devices and rules in batches. | |
| 8 | Interconnect with peripheral systems and verify services. |
Preparations
Before you restore or migrate integration assets, make the following preparations:
- Prepare an integration asset package.
- Obtain configuration information of the source instance to which an asset package belongs. This information is required only in asset migration scenarios.
The configuration information includes the security group configuration, instance configuration parameters, and data dictionary information of instances.
- Obtain interconnection information of peripheral systems. The information is required only in asset migration scenarios.
System
Item
Purpose
Data Source
IP address, username, and password for accessing a data source
Used for ROMA Connect to connect to the data source
Service application
Network segment of a service application
Used for ROMA Connect to connect to the service application
Modifying Instance Configurations
Before you import integration assets, modify the parameter configurations of the instance to which you want to import integration assets, including the security groups, routes, instance configuration parameters, and data dictionaries.
In asset migration scenarios, the instance configuration parameters must be the same as those of the source instance to which the asset package belongs. Otherwise, the assets cannot be imported.
- Log in to the ROMA Connect console. In the navigation pane on the left, choose Resource. On the displayed page, click the instance to access its console.
- Modify the security group configuration. This step is performed only in asset migration scenarios. Otherwise, skip this step.
- On the Basic Information tab page of the Instance Information page, click the security group name.
- On the security group configuration page, modify the security group rule based on the source instance information obtained in Preparations and the actual networking requirements of the new instance.
- (Optional) Modify instance routes. Mandatory only in asset migration scenarios.
On the basic information tab page, modify the route information.
- Modify instance configuration parameters. This step is performed only in asset migration scenarios. Otherwise, skip this step.
On the Instance Information page, click the Configuration Parameters tab and modify the configuration parameters based on the source instance information obtained in Preparations.
- Add data dictionaries.
On the Instance Information page, click the Data Dictionaries tab and add data dictionaries based on the source instance information obtained in Preparations.
For details about how to create a data dictionary, see Creating a Data Dictionary.
Importing Integration Assets
You can use the asset import function to quickly import an integration asset package to the ROMA Connect instance.
- On the Instances page, click Import Asset in the upper right.
- In the Import Asset dialog box, select Append or Overwrite based on the site requirements.
- In asset restoration scenarios, select Overwrite.
- In asset migration scenarios, select Append.
- If you select Overwrite, set whether to override the environment configurations.
- Override: The imported data source will overwrite the existing data source with the same name.
- Not Override: The imported data source will not overwrite the existing data source with the same name.
- Enter a prefix.
FDI tasks in the same instance must have different names. To import FDI tasks with same name, enter a prefix for each task before importing.
-
In the dialog box displayed, select a local asset file and import it.
- After the import is complete, click Close. You can view the imported assets in the instance.
Modifying Integration Application Configurations
User authorization information of integration applications is non-asset data, which must be reconfigured after you import integration assets.
- In asset restoration scenarios, you need to configure the imported integration applications.
- In asset migration scenarios, you can configure the integration applications based on the site requirements.
- On the Integration Applications page of the ROMA Connect instance console, click Application Authorization Management on the right of an integration application.
- In the dialog box displayed, configure authorization information for the application.
For details about how to configure authorization information, see Configuring Integration Application Authorization.
- Click OK.
Modifying Data Source Configurations
Data source connection information includes the connection address, account, and password, which is non-asset data. After you complete importing integration assets, you must reconfigure the data source connection information.
- On the Data Sources page of the ROMA Connect console, click Edit on the right of the target data source.
- On the Edit Data Source page, modify connection information about the data source.
- In asset restoration scenarios, change the password.
- In asset migration scenarios, change the IP address, username, and password of the data source.
For details about the data source parameters, see Overview.
- After the modification is complete, click Check Connectivity to verify the connectivity between ROMA Connect and the data source.
- Click Save.
Modifying API Configurations
The environment information, control policy information, secret information, blacklist and whitelist for API authorization, and APIs that are not published in the RELEASE environment are not asset data. You need to reconfigure this information after importing integration assets.
- Environment information includes the independent domain names, environment variables, cloud server information of load balance channels, and non-default environments.
- Control policy information includes request throttling policies, access control policies, client access control policies, and client quota policies.
- Secret information includes clients' AppCodes and custom backends' configurations of the password or certificate type.
Configuring Environment Information
- Bind an independent domain name.
- On the instance console, choose API Connect > API Groups. Click the name of an API group to view details.
- Choose Group Information and click Bind Independent Domain Name in the Independent Domain Names area to bind an independent domain name to the API group.
For details about the parameters, see Binding a Domain Name to an API Group.
- Click OK.
- Create an environment.
- On the instance console, choose API Connect > API Policies, and click the Environments tab.
- Click Create and create an environment for publishing APIs.
- Click OK.
- Add environment variables.
- On the instance console, choose API Connect > API Groups. Click the name of an API group to view details.
- Click the Group Information tab in the upper left corner. In the Environment Variables area, select the environment to which you want to add variables, and click Add Environment Variable.
For details about the parameters, see Creating an Environment Variable.
- Click OK.
- Modify a load balance channel server.
- On the instance console, choose API Connect > API Policies, and click the Load Balance Channels tab.
- Click Modify on the right of a load balance channel.
- Modify the server configuration.
- For channels whose mode is set to Select cloud servers, click Add Cloud Server to add servers.
- For channels whose mode is set to Specify IP addresses, modify the backend service addresses as required.
For details about the parameters, see (Optional) Creating a Load Balance Channel.
- After the configuration is complete, click Finish.
Configuring Control Policy Information
- Configure a request throttling policy.
- On the instance console, choose API Connect > API Policies, and click the Policies tab.
- Click Create Policy. On the Select Policy Type page, select Request Throttling in the Traditional Policies area.
For details about the parameters, see Creating a Request Throttling Policy.
- Click OK.
- Bind the request throttling policy to the API, application, or tenant by following the procedure described in API Request Throttling.
- Configure an access control policy.
- On the instance console, choose API Connect > API Policies, and click the Policies tab.
- Click Create Policy. On the Select Policy Type page, select Access Control in the Traditional Policies area.
For details about the parameters, see Creating an Access Control Policy.
- Click OK.
- Bind an access control policy to the API by following the procedure described in API Access Control.
- Configure a credential access control policy.
- On the instance console, choose API Connect > Credentials, and click the Credentials tab.
- Click Set Access Control on the right of a credential.
For details about the parameters, see API Credential Access Control.
- Click OK.
- Configure a credential quota policy.
- On the instance console, choose API Connect > Credentials, and click the Credential Quota Policies tab.
- Click Create Credential Quota Policy.
For details about the parameters, see Creating a Credential Quota Policy.
- Click OK.
- Bind the quota policy to a credential by following the procedure described in API Credential Quotas.
Configuring Secret Information
- Add a credential for simple authentication.
- On the instance console, choose API Connect > Credentials, and click the Credentials tab.
- Click the name of a credential.
- In the AppCode area, click Add AppCode to add an AppCode for the credential.
- Click OK.
- Add the configurations of the password or certificate type for custom backends.
- On the instance console, choose API Connect > Custom Backends, and click the Configurations tab.
- Click Modify on the right of a configuration item.
- For configuration of the password type, change the password.
- For configuration of the certificate type, modify the certificate content and private key.
- Click OK.
Modifying Blacklist and Whitelist Configurations of API Authorization
Only APIs that are accessed using App authentication support authorization configuration.
- On the instance console, choose API Connect > APIs. Choose More > Authorize Credentials of an API.
- On the page displayed, click Enable Green Channel > Modify on the right of an authorized credential to modify the blacklist and whitelist.
- Click OK.
Creating an API and Publishing It in a Non-RELEASE Environment
- On the instance console, choose API Connect > APIs and click Create API.
For details about the parameters, see Creating a RESTful API.
- Publish the API to an environment other than RELEASE by following the procedure described in Publishing an API.
Modifying Device Configurations
Device and device rule information is not asset data. Reconfigure the information after importing integration assets. You can use the import function to restore or create devices and rules in batches.
- (Optional) Prepare one device file and one rule file.
Obtain the exported device file and rule file from the source instance to which the asset package belongs.
- Create a device.
- On the ROMA Connect console, choose LINK > Device Management.
- If you have obtained a device file, click Import to create a device by importing the file.
- If you have not obtained a device file, click Create Device to manually create a device.
For details about the parameters, see Creating a Device.
- After the import is successful, you can view the imported device in the device list.
- On the ROMA Connect console, choose LINK > Device Management.
- Create a rule.
- On the ROMA Connect console, choose LINK > Rule Engine.
- If you have obtained a rule file, click Import to create a rule by importing the file.
- If you have not obtained a rule file, click Create Rule to manually create a rule.
For details about the parameters, see Creating a Rule.
- After the import is successful, you can view the imported rule in the rule list.
- On the ROMA Connect console, choose LINK > Rule Engine.
Service Interconnection Adaptation and Verification
After you have restored or migrated integration assets in the ROMA Connect instance, notify the service applications interworking with ROMA Connect to update their interconnection configurations so that they can process services properly.
The following table describes the interconnection configurations to update on the service applications or devices connected to ROMA Connect.
| Category | Scenarios | Configuration Data |
|---|---|---|
| Service integration | Calling an API |
|
| Message integration | Sending and receiving messages |
|
| Device integration | Reporting messages and delivering commands |
|
After you update the interconnection configurations, check whether service applications can process services properly.
- Check whether a service application can call APIs.
- Check whether a service application can send messages to and receive messages from topics of ROMA Connect.
- Check whether a device can send data to and receive data from ROMA Connect and whether the rule engine can forward data.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.