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.

Procedure

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

2. On the Product Management page, click Install Products in the upper-right corner and choose Install OCP.

3. On the Install OCP page, specify the parameters in the Basic Configurations section.

   Parameter	Description
   OCP Image	The Docker image of OCP.
   Product Name	The name of the product, which cannot be the same as that of another product.
   Multi-zone Mode	When you enable the multi-zone deployment, you must specify the following parameters: Zone Name: the name of the zone. Server: the IP address of the server on which OCP is to be installed. OCP Proxy IP: the IP address of the OCP access portal in the zone. OCP Proxy Port: the port number of the OCP access portal in the zone. Default value: 80. MetaDB Proxy IP: the IP address of the MetaDB proxy. MetaDB Proxy Port: the port number of the MetaDB proxy. Default value: 2883.
   Server	The IP address of the server on which OCP is to be installed.
   CPU	The number of CPU cores allocated to OCP. Default value: 8C. Notice If the OCP server has 16 CPU cores and 32 GB of memory and you have configured 8 CPU cores and 16 GB of memory for MetaDB, set CPU to 8C for OCP.
   Memory	The memory allocated to OCP. Default value: 20GB. Notice If the OCP server has 16 CPU cores and 32 GB of memory and you have configured 8 CPU cores and 16 GB of memory for MetaDB, set Memory to 16G for OCP.
   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. Default value: /home/admin/logs/ocp.

4. On the Install OCP page, specify the parameters in the MetaDB configuration section.

   OCP allows you to specify the parameters of the OCP meta tenant and OCP monitor tenant in two ways on the MetaDB created or Other OB_MySQL tab.

   • If no tenant has been created for a newly created MetaDB, click the MetaDB created tab. The following table describes the parameters on this tab.

     Parameter	Description
     Select Created MetaDB	Select a created MetaDB for OCP.
     Whether to take over the MetaDB cluster and manage it in OCP	Specifies whether to take over the MetaDB cluster and manage it in OCP. If you select Yes, you can manage the MetaDB cluster in OCP. However, one OCP can take over only one MetaDB cluster.
     OCP Meta Tenant	The dedicated tenant for OCP MetaDB.
     Tenant Name	The name of the MetaDB tenant.
     Tenant Password	The password of the MetaDB tenant.
     CPU	The number of CPU cores allocated to the OCP meta tenant. Default value: 2C. Notice If you set the CPU to 8C and memory to 16G for MetaDB, you need to set Tenant CPU to 2C for the OCP meta tenant.
     Memory	The memory allocated to the OCP meta tenant. Default value: 5GB. Notice If you set the CPU to 8C and memory to 16G for MetaDB, you need to set Tenant Memory to 3G for the OCP meta tenant.
     OCP Monitor Tenant	The dedicated tenant for OCP MonitorDB.
     Tenant Name	The name of the MonitorDB tenant.
     Tenant Password	The password of the MonitorDB tenant.
     CPU	The number of CPU cores allocated to the OCP monitor tenant. Default value: 4C. Notice If you set the CPU to 8C and memory to 16G for MetaDB, you need to set Tenant CPU to 2C for the OCP monitor tenant.
     Memory	The memory allocated to the OCP monitor tenant. Default value: 16GB. Notice If you set the CPU to 8C and memory to 16G for MetaDB, you need to set Tenant Memory to 3G for the OCP monitor tenant.
     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.

   • If you a tenant already exists, click the Other OBs_MySQL tab and enter the connection information of the OCP meta tenant and monitor tenant. If the entered username is not root, the entered user must have the privilege to create database tables.

5. On the Install OCP page, specify the parameters of the Load Balancing Configuration section.

   The following four load balancing options are available:

   • Created NLB

   • Created OBDNS

   • Other Load Balancing

   • Do Not Use. If you choose not to use load balancing, you will not be able to obtain high availability. By default, the first ip address is used as the connection information.

6. On the Install OCP page, specify the parameters in the OpenSearch Configurations.

   Three configuration modes are supported for OpenSearch:

   • Select an OpenSearch 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. Specifically, you must enter the URL, username, and password of the external OpenSearch.
   • Choose not to use OpenSearch.

7. After you set the parameters, click Submit.

   You can also click Reset to restore the default configurations.

What to do next

After you deploy OCP, you can log on to the OCP console to check if everything is ok.

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

   The access address is in the format of http://<OCP server IP address>:8080.

2. On the logon page, enter the default account admin.

References

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