Install, Upgrade, Modify, and Uninstall OBSharding

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

Prerequisites

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

• You have installed and logged on to OAT. For more information, see Install OAT.
• You have added a server where OBSharding is to be installed. For more information, see Add a server.
• The server meets the requirements for installing OBSharding.
• You have created the MetaDB component for OBSharding. For more information, see Create MetaDB.

Install OBSharding

To install OBSharding, perform the following steps:

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

2. On the Product Management page, click Install Product in the upper-right corner, and choose Install OBSharding.

3. On the Install OBSharding page, configure the parameters.

   The following table describes the basic parameters of OBSharding.

   Parameter	Description
   OBSharding Console Image	The Docker image of the OBSharding console.
   Product Name	The name of the product, which must be unique.
   Server	The IP address of the server where OBSharding is to be installed.
   CPU	The number of CPU cores on the server available for OBSharding. Default value: 4C.
   Memory	The memory on the server available for OBSharding. Default value: 8G.
   HTTP Port	The HTTP port number of OBSharding. Default value: 8080.
   Log Directory	The log storage path of OBSharding. Default value: /home/admin/logs/sharding_console.

   The following table describes the parameters of the OBSharding server.

   Parameter	Description
   OBSharding Server Image	The Docker image of the OBSharding server.
   Server	The IP address of the server where the OBSharding server is to be installed.
   CPU	The number of CPU cores on the server available for OBSharding. Default value: 8C.
   Memory	The memory on the server available for OBSharding. Default value: 16G.
   Log Directory	The log storage path of OBSharding. Default value: /home/admin/logs/sharding_server.

   The following table describes the MetaDB parameters of OBSharding.

   Parameter	Description
   MetaDB Type	Select the type of MetaDB.
   Tenant Name	The name of the tenant.
   Tenant Password	The password of the tenant.
   Tenant CPU	The number of CPU cores on the server available for the tenant. Default value: 2C.
   Tenant Memory	The memory on the server available for the tenant. Default value: 5G.

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

   Parameter	Description
   Load Balancing Mode	Select the load balancing mode.
   MetaDB TCP Proxy IP	The proxy IP address or domain name used by the OBSharding console to connect to MetaDB.
   MetaDB TCP Proxy Port	The proxy port used by the OBSharding console to connect to MetaDB. Default value: 3306.
   OBSharding Console HTTP Proxy IP	The IP address for accessing the OBSharding console.
   OBSharding Console HTTP Proxy Port	The port for accessing the OBSharding console. Default value: 80.

4. After you set the parameters, click Submit.

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

Upgrade OBSharding

To upgrade OBSharding, perform the following steps:

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

2. Find the target OBSharding service and click the service name in the Name column to go to the details page.

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

3. In the upper-right corner of the details page, click Upgrade.

4. In the Upgrade dialog box, enter the required information.

   The fields are described as follows:

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

5. Click OK.

Modify OBSharding

You can replace the OBSharding container or migrate the OBSharding container from one server to another.

To modify OBSharding, perform the following steps:

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

2. Find the target OBSharding service and click the service name in the Name column to go to the details page.

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

3. In the upper-right corner of the details page, click Change.

4. In the Change dialog box, enter the required information.

   The fields are described as follows:

   Field	Description
   Server	The IP address of the OBSharding server.
   Port	The port number of the OBSharding server.

5. Click OK.

Uninstall OBSharding

To uninstall OBSharding, perform the following steps:

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

2. Find the target OBSharding service and click the service name in the Name column to go to the details page.

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

3. In the upper-right corner of the details page, click Uninstall.

4. 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.

What to do next

After you install OBSharding, you can use the OBSharding proxy service.