Install OCP

This section describes how to install OCP in OAT.

Prerequisites

Before you install OCP, confirm the following:

• 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 the server where OCP is to be installed. For more information, see Add a server.
• Your server meets the requirements for installing OCP. For details, see OCP service configuration requirements.
• You have created the MetaDB component for OCP. For details, see Create MetaDB.

Considerations

Single-node OCP can be deployed in environments with different time zones, but the time zone for all nodes within the same OCP deployment must be consistent. In high-availability mode, primary and standby OCP clusters can also be deployed in different time zones, but the time zone for all OCP nodes in each cluster must be consistent. During OCP operation, modifying the MetaDB time zone is prohibited. From a management perspective, OCP supports managing OceanBase clusters and tenants across different time zones, as well as primary/standby clusters and tenants that span time zones. However, it is important to note that due to the internal table and view time zone conversion logic of OceanBase Database, the values of the tenant's system_time_zone and time_zone parameters must be consistent. Otherwise, OCP functionality may be affected.

Procedure

Step 1: Go to the OCP installation page

1. Log in to OAT.

2. In the left navigation bar, click Product Service > Product Management.

3. On the Product Management page, click Install Product in the upper-right corner and select Install OCP.

Step 2: Configure OCP basic information

The information required for deploying single-node OCP differs from that for deploying high-availability OCP. Fill in the fields according to your actual situation.

• Single-node OCP:

  Parameter	Description
  OCP Image	The Docker image for OCP.
  Product Name	The product name, which must be unique.
  Administrator Password	Reset the password for the OCP admin account. You can set a custom password or generate a random one. After OCP is deployed, you can use this password to log in to OCP directly, without performing the Set Password to Activate Account operation. Note Only OAT V4.1.1 supports configuring the administrator password during OCP installation.
  Multi-Zone Mode	Not required for single-node OCP mode.
  CPU	The number of CPU cores available for OCP on each server. Default is 8C.
  Memory	The memory available for OCP on each server. Default is 20GiB.
  HTTP Port	The HTTP port for OCP. Default value is 8080.
  Multi-Cluster Mode	Not required for single-node OCP mode.
  Log Directory	The log storage path for OCP.

• High-availability OCP:

  Parameter	Description
  OCP Image	The Docker image of OCP.
  Product Name	The product name, which must be unique.
  Administrator Password	Resets the password for the OCP admin account. You can set a custom password or generate a random one. After OCP is deployed, you can use this password to log in to OCP directly, without performing the Set Password to Activate Account operation. Note Only OAT V4.1.1 supports configuring an administrator password when installing OCP.
  Multi-zone Mode	Specifies whether to enable multi-zone installation. Notice When OCP is V4.3.0 or later, multi-zone mode is no longer supported. Do not enable this configuration.
  Server	Enter the IP address of the server for the specified OCP node.
  CPU	The number of CPU cores available to OCP on each server. Default is 8C.
  Memory	The memory available to OCP on each server. Default is 20GiB.
  HTTP Port	The HTTP port for OCP. Default value is 8080.
  Multi-Cluster Mode	Enables the multi-cluster installation mode.
  Cluster Type	Selects the cluster type for the OCP node. Options are Primary Cluster or Standby Cluster. Notice In OCP multi-cluster mode, ensure there is only one primary cluster and all others are standby clusters.
  OCP Cluster Name	Enter the cluster name for the OCP node.
  Log Directory	The log storage path for OCP.

  Note

  For CPU and memory size settings, refer to the CPU and Memory section in OCP Management Service and Configuration.

Step 3: Configure MetaDB information

OCP provides two methods to configure the tenant information for metaDB ocp_meta and ocp_monitor:

• If no tenants have been created, click the Created MetaDB tab to create new OCP meta and OCP monitor tenants for MetaDB. For CPU and memory size settings, refer to the CPU and Memory section in MetaDB Resources to plan your resources.

  Parameter	Description
  Select Created MetaDB	Select an existing MetaDB for OCP.
  Take Over MetaDB Cluster	Select whether to take over the MetaDB cluster. After taking it over, this MetaDB cluster will appear in OCP. Each OceanBase cluster can only be taken over by one OCP.
  OCP Meta Tenant	The dedicated tenant for OCP MetaDB.
  Tenant Name	The name of the Meta tenant.
  Tenant Password	The password for the Meta tenant.
  Tenant CPU	The CPU available to MetaDB on the server. Default is 2C.
  Tenant Memory	The memory available to MetaDB on the server. Default is 5GiB.
  OCP Monitor Tenant	The dedicated tenant for OCP MonitorDB.
  Tenant Name	The name of the Monitor tenant.
  Tenant Password	The password for the Monitor tenant.
  Tenant CPU	The CPU available to MonitorDB on the server. Default is 4C.
  Tenant Memory	The memory available to MonitorDB on the server. Default is 16GiB.

• If tenants already exist, click the Other OB_MySQL tab and enter the connection information for the OCP meta and OCP monitor tenants. If the username entered is not root, the corresponding user must have the permission to create database tables.

Step 4 (Optional): Configure load balancing information

For scenarios where load balancing is required for MetaDB and multiple OCP nodes, you can configure the corresponding proxy IP.

Step 5: Configure OpenSearch information

The configuration modes for OpenSearch are as follows:

Step 6: Submit the installation task

1. After completing the OCP configuration, click Submit. If your configuration is incorrect, you can click Reset to restore the default configuration with one click.

2. After successfully submitting the OCP installation, go to the Task Center page. Click the task name to view detailed task information.