Install OCP

This topic describes how to install OceanBase Cloud Platform (OCP) in high-availability mode in OceanBase Admin Toolkit (OAT).

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.
• Your server meets the requirements of OCP installation. For more information, see OCP-Server specifications.
• You have created the MetaDB component for OCP. For more information, see Create MetaDB.

Procedure

1. Log in to the OAT console.

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

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

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

   1. Specify the basic information of OCP.

      Parameter	Description
      OCP Image	The Docker image of OCP.
      Product Name	The name of the service, which must be unique.
      Administrator Password	The password for the admin account of OCP. You can use a custom or randomly generated password. After OCP is deployed, you can use the password to log in to the OCP console without setting a password to activate the account. Note Only OAT V4.1.1 and later support the configuration of the administrator password during OCP installation.
      Multi-zone Mode	Specifies whether to enable multi-zone installation. Note Do not enable this option if you are about to install OCP V4.3.0 or later, which does not support the multi-zone mode.
      Zone Name	The zone name, such as az1, of the specified OCP node. This parameter is displayed when Multi-zone Mode is enabled. The zone name of an OCP node must be unique.
      Server	The IP address of the server on which the specified OCP node is to be installed.
      OCP Proxy IP	The IP address for accessing OCP in the specified zone. This parameter is displayed only when Multi-zone Mode is enabled.
      OCP Proxy Port	The port number for accessing OCP in the specified zone. Default value: 80. This parameter is displayed only when Multi-zone Mode is enabled.
      MetaDB Proxy IP	The IP address for accessing MetaDB in the specified zone. This parameter is displayed only when Multi-zone Mode is enabled.
      MetaDB Proxy Port	The port number for accessing MetaDB in the specified zone. Default value: 2883. This parameter is displayed only when Multi-zone Mode is enabled.
      CPU	The number of CPU cores on each server for OCP. Default value: 8.
      Memory	The size of memory available to OCP, in GiB. 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. Note To deploy OCP in multi-cluster mode, you must enable this option.
      Log Directory	The log storage path of OCP.

      Note

      • For more information about how to set the CPU and memory resources, see the CPU and memory section in OCP-Server specifications.
      • When you enable Multi-Cluster Mode and set the cluster type to a primary or standby cluster, make sure that only one primary cluster exists and others are standby clusters.

   2. Specify the OCP MetaDB information.

      OCP allows you to specify information about the meta and monitor tenants for OCP MetaDB in two ways.

      • If no tenant is created, click the MetaDB Created tab and create the meta and monitor tenants for OCP MetaDB. For more information about how to plan CPU and memory resources for the tenants, see the CPU and memory section in MetaDB resources.

        Parameter	Description
        Select Created MetaDB	The existing MetaDB component to be used for OCP.
        Take Over MetaDB Cluster to OCP	Specifies whether to take over the MetaDB cluster. After takeover, you can view this MetaDB cluster in OCP. Each MetaDB cluster can be taken over by only one OCP instance.
        OCP Meta Tenant	The dedicated tenant for MetaDB.
        Tenant Name	The name of the meta tenant.
        Tenant Password	The password of the meta tenant.
        Tenant CPU	The number of CPU cores available to the meta tenant. Default value: 2.
        Tenant Memory	The size of memory available to the meta tenant, in GiB. Default value: 5.
        OCP Monitor Tenant	The dedicated tenant for MonitorDB.
        Tenant Name	The name of the monitor tenant.
        Tenant Password	The password of the monitor tenant.
        Tenant CPU	The number of CPU cores available to the monitor tenant. Default value: 4.
        Tenant Memory	The size of memory available to the monitor tenant, in GiB. Default value: 16.

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

   3. (Optional) Specify the load balancing information.

      If load balancing is required for the MetaDB and OCP nodes, you can configure the proxy IP address.

      Parameter	Description
      Load Balancing Mode	The load balancing mode. Valid values: OBDNS created, Other load balancing, Created NLB, and Not used.
      MetaDB TCP Proxy IP	The TCP address for connecting to the MetaDB. This parameter is displayed when the load balancing mode is set to Other load balancing.
      MetaDB TCP Proxy Port	The TCP port number for connecting to the MetaDB. This parameter is displayed when the load balancing mode is set to Other load balancing.
      HTTP Proxy Domain Name	The HTTP address for accessing the OCP console. This parameter is displayed when the load balancing mode is set to OBDNS created.
      HTTP Proxy Port	The HTTP port number for accessing the OCP console. This parameter is displayed when the load balancing mode is set to OBDNS created.

5. Click Submit. You can also click Reset to restore to the default configurations.

   Parameter	Description
   Load balancing configuration	Select a load balancing mode. Valid values: OBDNS created, Other load balancing, Created NLB, and Not used.
   MetaDB TCP proxy IP	The TCP address for connecting to MetaDB. This parameter is displayed when the load balancing mode is set to Other load balancing.
   MetaDB TCP proxy port	The TCP port number for connecting to MetaDB. This parameter is displayed when the load balancing mode is set to Other load balancing.
   HTTP proxy domain name	The HTTP address for accessing the OCP console. This parameter is displayed when the load balancing mode is set to OBDNS created.
   HTTP proxy port	The HTTP port number for accessing the OCP console. This parameter is displayed when the load balancing mode is set to OBDNS created.

   

6. After the configuration is completed, click Submit . For any errors in configurations, click Reset to restore the default configurations.

7. Choose System and Security > Task list. On the task list page that appears, click the task name to view the task details.