Deploy OCP

This topic describes how to deploy OceanBase Cloud Platform (OCP) by using OceanBase Admin Toolkit (OAT).

Prerequisites

Before you install OCP, ensure that:

• You have installed OAT. For more information, see Deploy OAT.
• You have logged on to OAT by using a super administrator account or an account with O&M permissions. For more information, see Manage users.
• You have prepared the OCP server and added it to OAT. For more information, see Prepare servers and Add a server.
• You have created the MetaDB component for OCP. For more information, see Create MetaDB.
• You have uploaded the OCP installation package to the OAT server. For more information, see Upload installation packages.
• The network environment meets the network port configuration requirements for normal OCP operation (network access permissions). Administrators can open the relevant ports on the network and host sides according to the OCP component deployment plan in the actual environment. For more information, see Component listening port list.

Procedure

1. In the left-side navigation pane, click Product Service > Products to open the Product Management page. Click Install Products in the upper-right corner and select Install OCP.

2. On the Install OCP page, complete Basic Configuration.

   Parameter	Description
   OCP Image	The Docker image of OCP.
   Product Name	The product name. It cannot be the same as that of another product.
   Administrator Password	The OCP administrator password. The password must meet the following requirements: Be 8 to 32 characters in length. Contain at least three types of the following characters: digits (0-9), uppercase letters (A-Z), lowercase letters (a-z), and special characters ~!@#%^&*_-+=`|(){}[]:;',.?/.
   Multi-AZ mode	When multi-AZ installation is enabled, the following parameters are available: Zone name: the zone name. Server: the IP address of the server where OCP is to be installed. OCP proxy IP: the OCP access portal IP for the zone. OCP proxy port: the OCP access portal port for the zone. Default: 80. MetaDB proxy IP: the MetaDB proxy IP address. MetaDB proxy port: the MetaDB proxy port. Default: 2883.
   Server	The IP address of the server where OCP is to be installed.
   CPU	The CPU cores available to OCP on the server. Default: 8C. Notice If the OCP server has 16 CPU cores and 32 GB of memory, and you have set MetaDB to use 8 CPU cores and 16 GB of memory, set the CPU available to OCP to 8C.
   Memory	The memory available to OCP on the server. Default: 20GB. Notice If the OCP server has 16 CPU cores and 32 GB of memory, and you have set MetaDB to use 8 CPU cores and 16 GB of memory, set the memory available to OCP to 16 GB.
   HTTP Port	The HTTP port of OCP. Default: 8080.
   Multi-Cluster Mode	Enable the multi-cluster installation mode.
   Log Directory	The log storage path of OCP. Default: /home/admin/logs/ocp.

3. On the Install OCP page, complete MetaDB Configuration.

   You can configure OCP Meta tenant and OCP Monitor tenant in two ways: MetaDB created or Other OB_MySQL:

   • For a newly created MetaDB with no tenant created yet, click the MetaDB created tab. The parameters are as follows:

     Parameter	Description
     Select Created MetaDB	Select a created MetaDB for OCP.
     Whether to take over MetaDB cluster to OCP	Use the OCP take-over-cluster feature to add the selected MetaDB. After completion, you can manage it in OCP. However, one MetaDB can only be taken over by one OCP.
     OCP Meta Tenant	The dedicated tenant for OCP MetaDB.
     Tenant name	The MetaDB tenant name.
     Tenant Password	The MetaDB tenant password.
     CPU	The CPU cores available to the OCP Meta tenant. Default: 2C. Notice If you have set MetaDB to use 8 CPU cores and 16 GB of memory, set the CPU available to the OCP Meta tenant to 2C.
     Memory	The memory available to the OCP Meta tenant. Default: 5GB. Notice If you have set MetaDB to use 8 CPU cores and 16 GB of memory, set the memory available to the OCP Meta tenant to 3 GB.
     OCP Monitor Tenant	The dedicated tenant for OCP MonitorDB.
     Tenant name	The MonitorDB tenant name.
     Tenant Password	The MonitorDB tenant password.
     CPU	The CPU cores available to the OCP Monitor tenant. Default: 4C. Notice If you have set MetaDB to use 8 CPU cores and 16 GB of memory, set the CPU available to the OCP Monitor tenant to 2C.
     Memory	The memory available to the OCP Monitor tenant. Default: 16GB. Notice If you have set MetaDB to use 8 CPU cores and 16 GB of memory, set the memory available to the OCP Monitor tenant to 3 GB.
     Take over MetaDB cluster	Select to take over the MetaDB cluster. After takeover, you can view this MetaDB cluster in OCP. Each MetaDB cluster can only be taken over by one OCP.

   • When a tenant already exists, click the Other OB_MySQL tab and enter the connection information for the OCP Meta tenant and OCP Monitor tenant. If the username entered is not root, the corresponding user must have the privilege to create database tables.

4. On the Install OCP page, complete Load Balancing Configuration.

   The load balancing mode has the following four options:

   • Created NLB.

   • Created OBDNS.

   • Other load balancing.

   • Do not use: If you choose not to use load balancing, you will not have high availability. By default, the first IP is used as the connection information.

5. On the Install OCP page, complete OpenSearch Configuration.

   OpenSearch configuration has the following three modes:

   • Created OpenSearch: You can select an OpenSearch created by OAT from the drop-down list. For more information about creating OpenSearch, see Create and uninstall OpenSearch.
   • External OpenSearch: Enter the URL, username, and password of the externally deployed OpenSearch.
   • Choose not to use OpenSearch.

6. After configuring OCP, click Submit.

   If your configuration is incorrect, click Reset to restore the default configuration.

What to do next

After OCP is deployed, you can log in to OCP to perform post-deployment checks.

1. Enter the OCP access address in the address bar of your browser and press Enter.

   The access address is: http://<OCP server IP address>:8080

2. On the login page that appears, log in with the default account admin.

References

• Prepare servers
• Deploy OAT
• Add a server
• Create MetaDB
• Install, upgrade, and uninstall OCP