Install, upgrade, roll back, and uninstall OCP

This topic describes how to install, upgrade, roll back, 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 in as a super administrator or an O&M engineer. For more information, see Install OAT.
• You have added a server to install OCP. For more information, see Add a server.
• The server meets the requirements for installing OCP.
• You have created the MetaDB component for OCP. For more information, see Create MetaDB.

Install OCP

To install OCP, 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 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 service, which must be unique.
   Multi-zone Mode	Specifies whether to enable multi-zone installation.
   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. The value is a virtual IP address. This parameter is displayed only when the multi-zone mode is enabled.
   OCP Proxy Port	The port for accessing OCP in the current zone. Default value: 80. The value is a virtual port, and the actual port is an HTTP port. This parameter is displayed only when the multi-zone mode is enabled.
   CPU	The number of CPU cores available to OCP. Default value: 8.
   Memory	The size of memory available to OCP, in GB. Default value: 20.
   HTTP Port	The HTTP port number of OCP. Default value: 8080.
   Multi-Cluster Mode	Specifies whether to enable the multi-cluster installation mode.
   Log Directory	The log storage path of OCP.

   The following table describes the MetaDB parameters of OCP.

   Parameter	Description
   MetaDB Type	The type of MetaDB.
   Select Created MetaDB	The existing MetaDB component to be used for OCP.
   OCP Meta Tenant	The dedicated tenant for MetaDB.
   OCP Monitor Tenant	The dedicated tenant for MonitorDB.
   Tenant Name	The name of the tenant.
   Tenant Password	The password of the tenant.
   CPU	The number of CPU cores available to MetaDB. Default value: 2.
   Memory	The size of memory available to MetaDB, in GB. Default value: 5.
   CPU	The number of CPU cores available to MonitorDB. Default value: 4.
   Memory	The size of memory available to MonitorDB, in GB. Default value: 16.
   Take over the MetaDB Cluster	Specifies whether to 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 instance.

   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 TCP address for connecting to MetaDB.
   MetaDB TCP Proxy Port	The TCP port number.
   OCP HTTP Proxy Domain Name	The HTTP address for accessing the OCP console.
   OCP HTTP Proxy Port	The HTTP port number.

   Configure OpenSearch:

   OAT V4.1.2 allows you to configure OpenSearch when you install OCP.

   You can configure OpenSearch by using one of the following methods:

   • Select the OpenSearch component created by using OAT from the drop-down list. For more information about how to create OpenSearch, see Create and uninstall OpenSearch.
   • Select an external OpenSearch component. In this case, you must enter the URL, username, and password of the external OpenSearch component.
   • Do not the OpenSearch component.

4. After you configure 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 > Products.

2. Find the OCP 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 OCP 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	Upgrade with Services Stopped: During the upgrade, OAT disables OCP of the previous version and OCP cannot provide services to external applications. This upgrade method applies to services without business continuity requirements. Rolling upgrade: During the upgrade, the OCP nodes that are not being upgraded are accessible and povide read-only services. Note To upgrade OCP V4.0.1 or later to V4.3.0, you do not need to enter the OCP username and password, and the related parameters are not displayed. Rolling upgrades are supported only for OCP V4.3.0 or later with the multi-node deployment architecture.
   Select an image file for the upgrade	The image file to be used for the upgrade.
   Username	The username of OCP.
   Password	The password corresponding to the username.

5. Click OK.

   Note

   If OCP V4.1.0 or later is installed, you are prompted to set an initial password for OCP. If OCP of a version earlier than V4.1.0 is installed, this prompt is not displayed.

Roll back OCP

Supported scenarios

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

Limits

• Only service upgrade tasks in OAT V4.3.0 or later support version rollbacks.
• You can roll back OCP only within three days after an OCP upgrade task is initiated.
• The metadata backup subtask must be completed before you can roll back OCP in an OCP upgrade task.
• For OCP in multi-cluster mode, you must roll back the primary and standby clusters in sequence.
• The version of OCP before the upgrade is V3.2.0 or later.

Procedure

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

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

2. Find the OCP 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 OCP 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 all monitoring and diagnostic data	The parameter for confirmation. Select the check box. Note The amount of data in the ocp_monitor tenant is excessively large and cannot be backed up.
   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

• OCP is unavailable during the rollback.
• The data of O&M operations performed on the new version is lost, and the metadata of two versions may be inconsistent.
• The monitoring and diagnostic data of the new version is lost.
• Tasks of the new version may be displayed in the task list.
• After the rollback, specific features and services provided by the new version may be unavailable. For example, the previous version does not support the binlog service provided by the new version.

Uninstall OCP

To uninstall OCP, perform the following steps:

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

2. Find the OCP instance that you want to install and click its name in the Name column to go to the details page.

   Note

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