Install and uninstall MetaDB

This topic describes how to install 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 on as either a super administrator or an O&M engineer. For more information, see Install OAT.
• You have added the server where MetaDB is to be installed. For more information, see Add a server.
• The server meets the requirements for installing MetaDB.

Install MetaDB

To install MetaDB, perform the following steps:

1. In the left-side navigation pane, choose Product Service > Component Management.

2. On the Component Management page, click Create Component in the upper-right corner, and choose Create MetaDB.

3. 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 where the MetaDB is to be installed.
   Custom Zone	The zone name and addresses of the IDC, server, and Root Server. Notice If you choose to specify this parameter, the Server parameter is automatically hidden.
   Arbitration Service	The IP address of the arbitration service. Example: xxx.xxx.xxx.xxx:xxxx. Notice You can configure the arbitration service only if you set the MetaDB Image parameter to a version of MetaDB V4.X.
   CPU	The number of CPU cores on the server available for the MetaDB. Default value: 32C.
   Memory	The memory on the server available for the MetaDB. Default value: 90G.
   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 the MetaDB.

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

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

   The following table describes the startup parameters of the MetaDB.

   Parameter	Description
   MySQL Port	The MySQL port of the MetaDB. Default value: 2881.
   RPC Port	The RPC port of the 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 the OCP Agent by connecting to the SSHD port.
   root Password	The password of the root user in the MetaDB container.

   Note

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

4. After you set the parameters, click Submit.

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

Uninstall MetaDB

To uninstall MetaDB, perform the following steps:

1. In the left-side navigation pane, choose Product Service > Product Management.

2. Find the target MetaDB service and click Uninstall in the Actions column.

   You can also search for the MetaDB service by name at the top of the page.

3. In the confirmation dialog box that appears, click Uninstall.

   OAT displays a message indicating that the service is being uninstalled. OAT also creates an uninstallation task. In the confirmation dialog box that appears, you can click the task ID to view the task progress.

   Notice

   If MetaDB is associated with another product, the uninstall will fail.

What to do next

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