Install, upgrade, roll back, and uninstall ODC

This topic describes how to install, upgrade, roll back, and uninstall OceanBase Developer Center (ODC) in the OceanBase Admin Toolkit (OAT) console.

Prerequisites

Before you install ODC, 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 a server to install ODC. For more information, see Add a server.
• The server meets the requirements for installing ODC. For more information, see Plan resources for ODC.
• You have created the MetaDB component for ODC. For more information, see Create MetaDB.

Install ODC

To install ODC, 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 ODC.

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

   The following table describes the basic parameters of ODC.

   Parameter	Description
   ODC Image	The Docker image of ODC.
   Product Name	The name of the service, which must be unique.
   Server	The IP address of the server on which ODC is to be installed.
   CPU	The number of CPU cores available to ODC. Default value: 4.
   Memory	The size of memory available to ODC, in GB. Default value: 8.
   HTTP Port	The HTTP port number of ODC. Default value: 8989.
   Log Directory	The log storage path of ODC. Default value: /home/admin/logs/odc.

   The following table describes the MetaDB parameters of ODC.

   Parameter	Description
   MetaDB Type	The type of MetaDB.
   Select Created MetaDB	The existing MetaDB component to be used for ODC.
   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 ODC to connect to MetaDB.
   MetaDB TCP Proxy Port	The proxy port used by ODC to connect to MetaDB. Default value: 3306.
   ODC HTTP Proxy IP	The IP address for accessing ODC.
   HTTP Proxy Port	The port for accessing ODC. Default value: 80.

4. After the parameters are configured, click Submit.

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

Upgrade ODC

To upgrade ODC, perform the following steps:

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

2. Find the ODC instance 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 ODC instance 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 ODC of the previous version and ODC 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 ODC

Supported scenarios

• ODC 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.
• ODC is upgraded by using OAT. However, an error occurs in ODC of the new version.

Limits

• Only service upgrade tasks in OAT V4.3.0 or later support version rollbacks.
• You can roll back ODC only within three days after an ODC upgrade task is initiated.
• The metadata backup subtask must be completed before you can roll back ODC in an ODC upgrade task.
• The version of ODC before the upgrade is V3.2.0 or later.

Procedure

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

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

2. Find the ODC instance 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 ODC instance 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.
   Please select the image file whose version is rolled back.	The image file used for the rollback. 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. ODC is unavailable during the rollback.
2. All operation data of ODC of the new version is lost.
3. After the rollback, specific features and services provided by ODC of the new version may be unavailable.

Uninstall ODC

To uninstall ODC, perform the following steps:

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

2. Find the ODC instance 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 ODC instance 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 ODC, you can use ODC for database development. For more information, see ODC documentation.