Install, upgrade, and uninstall MetaDB|V4.5.2|OceanBase Admin Tool|docs|OceanBase Documentations

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

Prerequisites

Before you install MetaDB, 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 the server to install MetaDB. For more information, see Add a server.
The server meets the requirements for installing MetaDB.

To install MetaDB, perform the following steps:

In the left-side navigation pane, choose Product Service > Components.
On the Components page, click Create Component in the upper-right corner and choose Create MetaDB.

On the Create MetaDB page, configure the parameters.

The following table describes the basic parameters of MetaDB.

Parameter	Description
MetaDB Image	The Docker image of MetaDB.
Component Name	The name of the component, which must be unique. Default value: `metadb`.
Server	The IP address of the server on which you want to install MetaDB.
Custom Zone	Specifies whether to use a custom zone. If you enable this parameter, you need to specify information about the custom zone, including the zone name, IDC, server, and location of the root server. Note If you enable this parameter, the Server parameter is automatically hidden.
Arbitration Service	Specifies whether to enable the arbitration service. If you enable the arbitration service, you must enter the IP address of the arbitration service. Example: xxx.xxx.xxx.xxx:xxxx. Note You can configure the arbitration service only if you specify an image of MetaDB V4.X for the MetaDB Image parameter.
CPU	The number of CPU cores available to MetaDB. Default value: 32.
Memory	The size of memory available to MetaDB, in GB. Default value: 90.
MetaDB Cluster Name	The name of the MetaDB cluster.
root@sys Password	The password of the root user of the sys tenant.
Log Directory	The log storage path of MetaDB.

The following table describes the parameters related to the installation path of MetaDB.

Parameter	Description
Installation Directory	The installation path of MetaDB. Default value: `/home/admin/oceanbase`.
Data Directory	The data storage path of MetaDB. Default value: `/data/1`.
Log Directory	The log storage path of MetaDB. Default value: `/data/log/1`.
Backup Directory	Optional. The backup path of MetaDB. By default, this parameter is left empty.

The following table describes the startup parameters of MetaDB.

Parameter	Description
MySQL Port	The MySQL port of MetaDB. Default value: 2881.
RPC Port	The RPC port of MetaDB. Default value: 2882.
OB Proxy Service Port	The service port of the OceanBase database proxy (ODP). Default value: 2883.
SSHD Port	The SSHD port in the MetaDB container. Default value: 2022. OceanBase Cloud Platform (OCP) deploys OCP Agent by connecting to the SSHD port.
root Password	The password of the root user in the MetaDB container.

You can modify or add the startup parameters of MetaDB and ODP based on your business requirements.

After you configure the parameters, click Submit.

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

You can upgrade only MetaDB V4.X on a GUI.
Before you initiate an upgrade task, you must complete major compaction and data backup in OCP.
When you upgrade MetaDB that is associated with an arbitration service, if the arbitration service is managed by OAT, you must initiate an upgrade of the arbitration service in OAT and complete the upgrade before you initiate an upgrade of MetaDB.

To upgrade MetaDB, perform the following steps:

In the left-side navigation pane, choose Product Service > Components.
On the Components page, click MetaDB.
Find the MetaDB component that you want to modify and click its name in the Name column to go to the details page.

Note

You can also search for the required MetaDB component 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 of MetaDB. By default, the upgrade method is automatically selected. Note If MetaDB is deployed in single node mode, only Upgrade with Services Stopped is supported. If MetaDB is deployed in multi-node mode, only Rolling upgrade is supported.
Select an image file for the upgrade	The image file to be used for the upgrade.
Major compaction is completed by using OCP./Data backup is completed by using OCP.	The parameters for confirmation. You can initiate the upgrade only after you select the check boxes.

To uninstall MetaDB, perform the following steps:

In the left-side navigation pane, choose Product Service > Components.
Find the MetaDB component that you want to uninstall and click Uninstall in the Actions column.

Note

You can also search for the required MetaDB component by name at the top of the page.
In the message that appears, click Uninstall.

Then, OAT displays a message indicating that the component is being uninstalled and creates an uninstallation task. You can click the task ID in the message to view the task progress.

Note

If the MetaDB component is associated with another service, the uninstallation fails.

After you install MetaDB, you can install other services in the OceanBase ecosystem.