Install, upgrade, and uninstall OMS|V4.3.0| docs|Distributed Database

Install, upgrade, and uninstall OMS

Last Updated：2025-01-16 11:38:13 Updated

This topic describes how to install, upgrade, and uninstall OceanBase Migration Service (OMS) in the OceanBase Admin Toolkit (OAT) console.

Prerequisites

Before you install OMS, make sure that the following conditions are met:

You have installed OAT and logged in as a super administrator or an O&M engineer. For more information, see Install OAT.
You have added a server to install OMS. For more information, see Add a server.
The server meets the requirements for installing OMS. For more information, see Resource configuration specifications of OMS.
You have created the MetaDB component for OMS. For more information, see Create MetaDB.

To install OMS, perform the following steps:

In the left-side navigation pane, choose Product Service > Products.
On the Products page, click Install Product in the upper-right corner and choose Install OMS.

On the Install OMS page, configure the parameters.

The following table describes the basic parameters of OMS.

Parameter	Description
OMS Image	The Docker image of OMS.
Product Name	The name of the service, which must be unique.
Server	The IP address of the server on which you want to install OMS.
CPU	The number of CPU cores available to OMS. Default value: 8.
Memory	The size of memory available to OMS, in GB. Default value: 32.
HTTP Port	The HTTP port number of OMS. Default value: 8089.
Data Directory	The data storage path of OMS. Default value: `/data/oms`.

The following table describes the MetaDB parameters of OMS.

Parameter	Description
MetaDB Type	The type of MetaDB.
Select Created MetaDB	The existing MetaDB component to be used for OMS.
Tenant Name	The name of the tenant.
Tenant Password	The password of the tenant.
Tenant CPU	The number of CPU cores available to the tenant. Default value: 2.
Memory	The size of memory available to the tenant, in GB. Default value: 5.

The following table describes the InfluxDB parameters of OMS.

Parameter	Description
Time Series Database Storage	The type of InfluxDB.
Select Created InfluxDB	The existing InfluxDB component to be used for OMS.
Database Account	The InfluxDB username for OMS. Default value: `oms_monitor`.
Database Password	The password corresponding to the InfluxDB username.

The following table describes the load balancing parameters. The parameters are optional.

Parameter	Description
Load Balancing Mode	The load balancing mode.
Layer 4 IP	The TCP address for connecting to MetaDB.
Layer 4 Service Port	The TCP port number.
Layer 7 IP	The HTTP address for accessing the OMS console.
Layer 7 Service Port	The HTTP port for accessing the OMS console.

After the parameters are configured, click Submit.

You can also click Reset to restore to the default configurations.

To upgrade OMS, perform the following steps:

In the left-side navigation pane, choose Product Service > Products.
Find the OMS instance that you want to upgrade and click its name in the Name column to go to the details page.

Note

You can also search for the required OMS instance by name at the top of the page.
In the upper-right corner of the details page, click Upgrade.

In the Upgrade dialog box, enter the required information.

The following table describes the related parameters.

Parameter	Description
Upgrade Mode	The upgrade method. OAT V4.3.0 supports only Upgrade with Services Stopped. This mode applies to services without business continuity requirements. During the upgrade, OAT disables OMS of the previous version and OMS cannot provide services to external applications.
Select an image file for the upgrade	The image file to be used for the upgrade.

To uninstall OMS, perform the following steps:

In the left-side navigation pane, choose Product Service > Products.
Find the OMS instance that you want to uninstall and click its name in the Name column to go to the details page.

Note

You can also search for the required OMS instance by name at the top of the page.
In the upper-right corner of the details page, click Uninstall.
In the message that appears, click Uninstall. Then, OAT displays a message indicating that the service is being uninstalled and creates an uninstallation task. You can click the task ID in the message to view the task progress.

After you install OMS, you can use it to migrate data. For more information, see OMS documentation.