Install, upgrade, and uninstall OCP

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

Prerequisites

Before you install OCP, 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 a server for installing OCP. For more information, see Add a server.

• The server meets the requirements for installing OCP.

• You have installed the MetaDB component for OCP. For more information, see Create MetaDB.

OCP installation

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

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

   The following table describes the basic parameters of OCP.

   Parameter	Description
   OCP Image	The Docker image of OCP. Note OpenSearch is not supported for versions earlier than OCP V3.3.0.
   Product Name	The name of the product, which cannot be the same as that of another product.
   Multi-zone Mode	Specifies whether to enable the multi-zone mode.
   Server	The IP address of the server on which OCP is to be installed.
   OCP Proxy IP	The IP address for accessing OCP in the current zone, when the multi-zone mode is enabled. The value is a virtual IP address.
   OCP Proxy Port	The port for accessing OCP in the current zone, when the multi-zone mode is enabled. The default value is 80. The value is a virtual port, which is actually an HTTP port.
   CPU	The number of CPU cores on the server available for OCP. Default value: 8.
   Memory	The size of memory on the server available for OCP. Default value: 20 GB.
   HTTP Port	The HTTP port number of OCP. Default value: 8080.
   Multi-Cluster Mode	Specifies whether to enable the multi-cluster deployment mode.
   Log Directory	The log storage path of OCP.

   The following table describes the parameters of MetaDB for OCP.

   Parameter	Description
   MetaDB Type	Select the type of MetaDB.
   Select Created MetaDB	Select an existing MetaDB for OCP.
   OCP Meta Tenant	The dedicated tenant for OCP MetaDB.
   OCP Monitor Tenant	The dedicated tenant for OCP MonitorDB.
   Tenant Name	The name of the tenant.
   Tenant Password	The password of the tenant.
   CPU	The number of CPU cores on the server available for MetaDB. Default value: 2.
   Memory	The size of memory on the server available for MetaDB. Default value: 5 GB.
   CPU	The number of CPU cores on the server available for MonitorDB. Default value: 4C.
   Memory	The size of memory on the server available for MonitorDB. Default value: 16 GB.
   Take over the MetaDB Cluster	You can select this option to take over the MetaDB cluster. You can view the MetaDB cluster in OCP after the takeover. Each MetaDB cluster can be taken over by only one OCP.

   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 TCP address for connecting to MetaDB.
   MetaDB TCP Proxy Port	The TCP port.
   OCP HTTP Proxy Domain Name	The HTTP proxy domain name that is used to access the OCP console.
   OCP HTTP Proxy Port	The HTTP port number.

   Configure OpenSearch:

   OAT allows you to configure OpenSearch in V4.1.2. You can choose to configure OpenSearch when you install OCP.

   Three configuration modes are supported for OpenSearch:

   • Select an OpenSearch service installed by using OAT from the drop-down list. For more information about how to install an OpenSearch service, see Install and uninstall OpenSearch.
   • Select an external OpenSearch service. Specifically, you must enter the URL, username, and password of the external OpenSearch service.
   • Choose not to use OpenSearch.

4. After you set the parameters, click Submit. You can also click Reset to restore to the default configurations.

Upgrade OCP

To upgrade OCP, perform the following steps:

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

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

   You can also search for the required OCP 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. If the username and password of OCP are no longer required after you upgrade OCP to V4.0.1 or later, they are automatically deleted from the form.
   Upgraded Image File	The target image file for the upgrade.
   Username	The username of OCP.
   Password	The password of OCP.

5. Click OK.

Uninstall OCP

To uninstall OCP, perform the following steps:

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

2. Find the target OCP and click its name in the Name column to go to the details page.

   You can also search for the required OCP 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 OCP is installed, you can monitor and maintain OceanBase Database in OCP. For more information, see the OCP documentation.