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 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 the ODC is to be installed. For more information, see Add a server.

• The server meets the requirements for installing 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 > 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, 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 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: 4C.
   Memory	The memory on the server available for ODC. Default value: 8G.
   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	Select the type of MetaDB.
   Select Created MetaDB	Select an existing 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: 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 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 you set the parameters, 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 > Product Management.

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

   You can also search for the required ODC 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 only Downtime Upgrade. Downtime Upgrade applies to services without business continuity requirements. During the upgrade, OAT disables the old version of ODC, and ODC cannot provide services to external applications.
   Upgraded Image File	The target image file for the upgrade.

5. Click OK.

Uninstall ODC

To uninstall ODC, perform the following steps:

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

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

   You can also search for the required ODC 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 ODC, you can use it for database development. For more information, see the ODC documentation.