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

Install, upgrade, and uninstall OMS

Last Updated：2023-08-23 02:57:00 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:

You have installed and logged on to OAT as a super administrator or an O&M engineer. For more information, see Install OAT.
You have added a server where OMS is to be installed. For more information, see Add a server.
The server meets the requirements for installing OMS. For more information, see OMS resource configuration specifications.
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 > Product Management.
On the Product Management page, click Install Product in the upper-right corner, and choose Install OMS.

On the Install OMS page, specify the related 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 product, which must be unique.
Server	The IP address of the server where OMS is to be installed.
CPU	The number of CPU cores allocated to OMS. Default value: `8C`.
Memory	The memory allocated to OMS. Default value: `32G`.
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	Select the type of MetaDB.
Select Created MetaDB	Select an existing MetaDB for OMS.
Tenant Name	The name of the tenant.
Tenant Password	The password of the tenant.
Tenant CPU	The number of CPU cores allocated to the tenant. Default value: `2C`.
Memory	The memory allocated to the tenant. Default value: `5G`.

(Optional) The following table describes the parameters of InfluxDB.

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

(Optional) The following table describes the load balancing parameters.

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

After you set the parameters, click Submit.

You can also click Reset to restore the default configurations.

To upgrade OMS, perform the following steps:

In the left-side navigation pane, choose Product Service > Product Management.
Find the target OMS service and click the service name in the Name column to go to the details page.

You can also search for the service by name.
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 fields.

Field	Description
Upgrade Method	The current version of OAT supports only Downtime Upgrade. Downtime Upgrade applies to services without business continuity requirements. During the upgrade, OAT disables the old version of OMS, and OMS cannot provide services to external applications.
Upgraded Image File	The image file of the target version.

To uninstall OMS, perform the following steps:

In the left-side navigation pane, choose Product Service > Product Management.
Find the target OMS service and click the service name in the Name column to go to the details page.

You can also search for the service by name.
In the upper-right corner of the details page, click Uninstall.
In the confirmation dialog box that appears, click Uninstall. OAT displays a message indicating that the service is being uninstalled. OAT also creates an uninstall task. In the confirmation dialog box that appears, you can click the task ID to view the task progress.

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