Install, upgrade, and uninstall ODC

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

Prerequisites

Before you install ODC, make sure the following:

• You have installed and logged on to OAT using a super admin account or an O&M account. For more information, see Install OAT.
• You have added the server where the ODC is to be installed. For more information, see Add a server.
• The server meets the requirements for installing ODC. For more information, see ODC resource planning.
• 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 Products > Product Management.

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

3. On the Install ODC page, specify the related parameters.

   The following table describes the basic parameters for ODC.

   Parameter	Description
   ODC Image	The Docker image of ODC.
   Product Name	The name of the product, which must be unique.
   Server	The IP address of the server where ODC is to be installed.
   CPU	The number of CPU cores on the server available for ODC. Default value: 4.
   Memory	The size of memory on the server available for ODC. Default value: 8 GB.
   HTTP Port	The HTTP port number for 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 for ODC.

   Parameter	Description
   MetaDB Type	Select the type of MetaDB.
   Select Created MetaDB	Select a created MetaDB for ODC.
   Tenant Name	The name of the tenant.
   Tenant Password	The password of the tenant.
   Tenant CPU	The number of CPU cores allocated to the tenant. Default value: 2.
   Tenant Memory	The size of memory allocated to the tenant. Default value: 5 GB.

   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 for ODC to connect to MetaDB.
   MetaDB TCP Proxy Port	The proxy port used for ODC to connect to MetaDB. Default value: 3306.
   ODC HTTP Proxy IP	The IP address for accessing ODC.
   ODC HTTP Proxy Port	The port for accessing ODC. Default value: 80.

4. After you set the parameters, click Submit.

   You can also click Reset to restore the default configuration.

Upgrade ODC

To upgrade ODC, perform the following steps:

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

2. Find the target ODC and click the product name in the Name column to go to the details page.

   If there are too many products, you can search by product 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 fields.

   Field	Description
   Upgrade Mode	The current version of OAT only supports Upgrade with Services Stopped, which applies to products that do not require business continuity. During the upgrade, OAT disables the old version of ODC, which cannot provide services externally.
   Image File for Upgrade	The image file of the target version.

5. Click OK.

Uninstall ODC

To uninstall ODC, perform the following steps:

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

2. Find the target ODC and click the product name in the Name column to go to the details page.

   If there are too many products, you can search by product 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 will prompt that the ODC is being uninstalled. At the same time, OAT will create an uninstall task, and you can click on the task ID in the confirmation dialog box to view the execution progress of the current uninstall task.

What to do next

After you install ODC, you can use it for database development. For more information, see the ODC documentation.