Install, upgrade, roll back, modify, and uninstall OB Sharding

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

Prerequisites

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

• You have installed and logged in to OAT. For more information, see Install OAT.
• You have added a server to install OB Sharding. For more information, see Add a server.
• The server meets the requirements for installing OB Sharding.
• You have created the MetaDB component for OB Sharding. For more information, see Create MetaDB.

Install OB Sharding

To install OB Sharding, perform the following steps:

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

2. On the Products 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 OB Sharding.

   Parameter	Description
   OBSharding Console Image	The Docker image of the OB Sharding console.
   Product Name	The name of the service, which must be unique.
   Server	The IP address of the server on which you want to install the OB Sharding console.
   CPU	The number of CPU cores available to the OB Sharding console. Default value: 4.
   Memory	The size of memory available to the OB Sharding console, in GB. Default value: 8.
   HTTP Port	The HTTP port number of the OB Sharding console. Default value: 8080.
   Log Directory	The log storage path of the OB Sharding console. Default value: /home/admin/logs/sharding_console.

   The following table describes the parameters of the OB Sharding server.

   Parameter	Description
   OBSharding Server Image	The Docker image of the OB Sharding server.
   Server	The IP address of the server on which you want to install the OB Sharding server.
   CPU	The number of CPU cores available to the OB Sharding server. Default value: 8.
   Memory	The size of memory available to the OB Sharding server, in GB. Default value: 16.
   Log Directory	The log storage path of the OB Sharding server. Default value: /home/admin/logs/sharding_server.

   The following table describes the MetaDB parameters of OB Sharding.

   Parameter	Description
   MetaDB Type	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 available to the tenant. Default value: 2.
   Tenant Memory	The size of memory available to the tenant, in GB. Default value: 5.

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

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

4. After the parameters are configured, click Submit.

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

Upgrade OB Sharding

To upgrade OB Sharding, perform the following steps:

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

2. Find the OB Sharding 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 OB Sharding 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 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 OB Sharding of the previous version and OB Sharding cannot provide services to external applications.
   Select an image file for the upgrade	The image file to be used for the upgrade.

5. Click OK.

Roll back OB Sharding

Supported scenarios

• OB Sharding fails to be upgraded by using OAT and the issue persists. In this case, you can create a service rollback task on the Mission Center page.
• OB Sharding is upgraded by using OAT. However, an error occurs in OB Sharding of the new version.

Limits

• Only service upgrade tasks in OAT V4.3.0 or later support version rollbacks.
• You can roll back OB Sharding only within three days after an OB Sharding upgrade task is initiated.
• The metadata backup subtask must be completed before you can roll back OB Sharding in an OB Sharding upgrade task.
• The overall OB Sharding is rolled back to the previous version in a unified manner, regardless of whether canary upgrade is performed.
• The version of OB Sharding before the upgrade is V3.2.8 or later.

Procedure

If OB Sharding is upgraded, perform the following steps to roll back OB Sharding:

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

2. Find the OB Sharding that you want to roll back and click its name in the Name column to go to the details page.

   Note

   You can also search for the required OB Sharding by name at the top of the page.

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

4. In the Version rollback dialog box, enter the required information.

   The following table describes the related parameters.

   Parameter	Description
   Select a metadata backup file	Optional. The metadata file used for the rollback. The version of the metadata file must meet the requirements.
   Select an image file that is rolled back from version Console.	The image file used to roll back the OB Sharding console. The version of the image file must meet the requirements.
   Select a Server version to roll back the image file.	The image file used to roll back the OB Sharding server. The version of the image file must meet the requirements.
   Version rollback will lose data records generated during the running of the current version. New Features/services added to the current version may be abnormal.	The parameter for confirmation. Select the check box.

5. Click OK.

Impacts

1. OB Sharding is unavailable during the rollback.
2. All operation data of OB Sharding of the new version is lost.
3. After the rollback, specific features and services provided by OB Sharding of the new version may be unavailable.

Modify OB Sharding

You can replace the OB Sharding container or migrate the OB Sharding container between servers.

To modify OB Sharding, perform the following steps:

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

2. Find the OB Sharding 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 OB Sharding 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 following table describes the related parameters.

   Parameter	Description
   Server	The IP address of the server on which OB Sharding is installed.
   Port	The port number of the OB Sharding server.

5. Click OK.

Uninstall OB Sharding

To uninstall OB Sharding, perform the following steps:

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

2. Find the OB Sharding 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 OB Sharding by name at the top of the page.

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

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

What to do next

After you install OB Sharding, you can use OB Sharding based on your business requirements. For more information, see OB Sharding documentation.