This topic describes how to deploy OceanBase Migration Service (OMS) by using an obd configuration file in an x86-based CentOS Linux 7.9 environment.
Note
Currently, obd supports only OMS Community Edition V4.2.11 and later.
Prerequisites
Before you start, make sure that you have met the following conditions:
You have installed obd V4.0.0 or later. We recommend that you install the latest version. For more information, see Install obd.
The server where you want to deploy OMS meets the deployment requirements.
Docker is installed on the server where you want to deploy OMS.
You have prepared a database to store the metadata of OMS Community Edition. You can use MySQL or OceanBase Database. We recommend that you use OceanBase Database Community Edition.
Note
To improve system reliability, we recommend that you implement a high-availability database solution for MetaDB. This will ensure the 7x24-hour stable operation of OMS core services and reduce the risk of business interruption.
If you want OMS to collect and display monitoring data, you need to deploy and configure a time-series database. Currently, only InfluxDB V1.8 is supported.
Considerations
The High Availability (HA) feature is disabled by default in OceanBase Migration Service Community Edition. If you need to enable it, you can modify the enable parameter in the ha.config file to true after deployment.
Procedure
Note
This topic provides an example of the operation instructions in the CentOS Linux 7.9 x86 architecture image environment. The operation interface may vary in different environments and obd versions. Please refer to the actual interface for details.
Step 1: Load the OMS Community Edition package
Note
If you plan to deploy OMS in a multi-node architecture, you need to perform the following steps on each node.
Obtain the OMS installation package
You can download the OMS Community Edition installation package from the OceanBase Download Center. The installation package is typically a
tar.gzfile that starts withoms, such asoms_4.2.11-ce.tar.gz.Load the downloaded OMS installation package into the local image repository of the Docker container.
[admin@test ~]$ sudo docker load -i oms_4.2.11-ce.tar.gzVerify that the package is loaded successfully.
[admin@test ~]$ sudo docker imagesThe output is as follows:
REPOSITORY TAG IMAGE ID CREATED SIZE reg.docker.alibaba-inc.com/oceanbase/oms-ce feature_4.2.11_ce 26f5f1554fc5 2 days ago 12.5GB
Step 2: Start the web interface
Run the
obd webcommand to start the web interface, and click the provided address to access the graphical user interface (GUI) of obd.[admin@test001 ~]$ obd web start OBD WEB in 0.0.0.0:8680 please open http://10.10.10.1:8680Note
The web interface by default uses port 8680. You can use the
obd web -p <PORT>command to specify a port, which must be in the range [1025, 65535].In Alibaba Cloud or other cloud environments, the program may fail to obtain the public IP address and instead output the internal IP address. This IP address is not a public IP address, so you need to use the correct IP address to access the web interface.
The
obd webcommand is bound to 0.0.0.0. In a multi-network interface deployment, you can access the web interface using any accessible IP address.You can use the nohup or screen command to run the
obd webcommand in the background.
(Optional) Place the cursor on the Chinese character in the top-right corner of the GUI and click to switch between Chinese and English interfaces based on the displayed language.
Click Start Your Experience in the GUI. In the Welcome to OceanBase Deployment Wizard interface, select the OceanBase Data Migration module and click Install to enter the OMS deployment interface.
Step 3: Configure deployment
On the Deployment Configuration page, you can configure the deployment name and mode of OMS, and set the node, port, and directory information. The following table describes the parameters on the Deployment Configuration page.
Module |
Parameter |
Description |
|---|---|---|
| Basic Configuration | Deployment Name | The unique name of the OMS deployment. The default value is myoms. You can customize the name, but it must be unique. The cluster name must start with an English letter and end with an English letter or a digit. It can contain English letters, digits, and underscores, and must be 2 to 32 characters in length. You can run the obd cluster list command to view the clusters managed by obd. |
| Deployment Mode | Deployment Mode | You can set the deployment mode to single-node, multi-node in a single region, or multi-node in multiple regions. |
| Node Configuration | Region Identifier | 1 in single-region mode and auto-incrementing from 1 in multi-region mode. This parameter cannot be modified. |
| English Region Identifier | default in single-region mode and default-x in multi-region mode, where x is an auto-incrementing integer. You can customize the English region identifier.
NoticeIf you use the MSHA service of Alibaba Cloud in a disaster recovery active-active scenario, use the region information of Alibaba Cloud as the |
|
| Access Priority | Appears only in multi-region mode. This parameter specifies the priority region for access. If this parameter is not selected, region 1 is the priority region for access. | |
| Node | Specify the IP address of the OMS node. In single-node mode, you can specify only one IP address. In multi-node mode, you can specify multiple IP addresses. You cannot specify the same IP address for different regions. | |
| CM Access Address | The address of the OMS cluster management service. You must specify a value in the format of http://IP address or domain name:port. You cannot specify the same CM access address for different regions. If no VIP is deployed, the port must be consistent with the value of the CM Service Port parameter.
NoteIn single-node deployment, the IP address of the current OMS server is usually specified. We recommend that you do not use |
|
| Port Configuration | HTTP Service Port | Specify the port number of the Nginx service. The default value is 8089, and the value must be in the range [1025, 65535]. |
| CM Service Port | Specify the port number of the CM service. The default value is 8088, and the value must be in the range [1025, 65535]. |
|
| Supervisor Service Port | Specify the port number of the Supervisor service. The default value is 9000, and the value must be in the range [1025, 65535]. |
|
| Ghana Service Port | Specify the port number of the GHANA service. The default value is 8090, and the value must be in the range [1025, 65535]. |
|
| SSHD Service Port | Specify the port number of the SSHD service. The default value is 2023, and the value must be in the range [1025, 65535]. |
|
| Data Directory | Path | Specify the data path of OMS. The directory must have at least 500 GB of available storage space. The path must be an absolute path that starts with / and contains only letters, digits, and special characters (-_:@/.). For example, /data/oms. |
| Deployment User Configuration | Username | Specify the username of the operating system of the host so that the installation program can perform automated configuration. The specified user must exist on all nodes, have the privilege to execute sudo commands without a password, and have the read and write permissions on the path specified in the preceding parameter. |
| Password (Optional) | Specify the password of the username. If the user has been configured to execute sudo commands without a password, you can skip this parameter. | |
| SSH Port | The default value is 22. You can customize the value. | |
| Validation | Click the Validate button to check whether the user configuration meets the requirements. If the validation succeeds, Current validation succeeded is displayed. If the validation fails, the specific reason for the failure is displayed. | |
| Version Selection | Product | Specifies the product to be deployed. The default value is OMS, and you cannot modify it. |
| Version | Specify the version of OMS to be deployed. You can select the version only after you specify all the preceding parameters and complete the validation. | |
| Description | Describes the OMS product. Click Learn More to go to the OMS documentation. |
After you configure the parameters, click Next to go to the MetaDB Configuration page.
Step 4: Configure MetaDB
You can configure MetaDB information on the MetaDB Configuration page. The following describes how to configure MetaDB.
Access configuration
The Access Configuration module is used to configure the access information of MetaDB. The interface is as follows:
ParameterDescriptionAccess Address The IP address for accessing MetaDB. Port The port for accessing MetaDB, which is 2881by default.Access Account The account for accessing MetaDB, such as root. When OceanBase Database is used as MetaDB, the account must be a user under the sys tenant, and the tenant name does not need to be specified.Password The password for connecting to the MetaDB account. Validate Click Validate to check whether the configured information is accessible. Monitoring configuration
This module is optional. If you want OMS to collect and display monitoring data, you can configure the access information of the time series database after deploying it. The interface is as follows:
ParameterDescriptionInfluxDB Address The IP address for accessing the time series database. Port The port for accessing the time series database, which is 8086by default.Username The username for accessing the time series database. Password The password corresponding to the username. Validate Click Validate to check whether the configured information is accessible. More configurations
This module is optional. If you want to customize the database names corresponding to each service in MetaDB, you can expand this module to configure the settings. The interface is as follows:
ParameterDescriptiondrc_rm_db The database name for the management console. If not configured, it defaults to oms_rm, and you can customize it. When deploying OMS, obd will create the corresponding database in MetaDB based on the configuration.drc_cm_db The name of the metadata database for the cluster management service. If not configured, it defaults to oms_cm, and you can customize it. When deploying OMS, obd will create the corresponding database in MetaDB based on the configuration.drc_cm_heartbeat_db The name of the heartbeat database for the cluster management service. If not configured, it defaults to oms_cm_heartbeat_x, wherexstarts from 1 and increments based on the number of regions of OMS. You can customize it. When deploying OMS, obd will create the corresponding database in MetaDB based on the configuration.
After all configurations are completed, click Next to go to the Configuration Confirmation page.
Step 5: Configuration confirmation
On the Configuration Confirmation page, you can view all configuration information. If you find any issues, click Previous to modify them. After confirming that everything is correct, click Next to go to the Precheck page. The system will verify whether your environment and configurations meet all the requirements for installing OMS.
Step 6: Precheck
The Precheck page displays the system check results. If the precheck fails, you can click View More Solutions to jump to the error code documentation and modify the configurations accordingly. After all errors are resolved, click Recheck to perform the precheck again.
After the precheck is successful, click Next to go to the Deployment page and start deploying OMS.
Step 7: Deployment
During the deployment, the Deployment page will display the deployment logs. You can view the detailed installation logs in the Deployment Logs module.
If the deployment fails, please check the log information to determine the cause of the failure and contact technical support for assistance. Our on-duty engineers will help you solve the problem. After identifying and fixing the installation failure, click Redeploy. In the confirmation window that appears, click OK. The system will clean up the failed OMS installation environment and re-execute the installation program.
If the deployment is successful, click Copy Information to copy and save the access address and account credentials of OMS. Then, click Complete to exit the deployment program.