Get started with OAT

OceanBase Admin Toolkit (OAT) allows you to install and uninstall products and components in the OceanBase ecosystem. This topic describes how to install OceanBase Cloud Platform (OCP) on a single node in the OAT console.

Prerequisites

Before you install OCP, make sure that the following conditions are met:

• You have installed OAT. For more information, see Install OAT.
• You have obtained an O&M user account. For more information, see Add a user.

Procedure

To install OCP, perform the following steps:

1. Log on to the OAT console.

   Log on to the OAT console as an O&M engineer. OAT access address: http://<<oat_server_ip>:7000

2. Add a server.

   1. In the left-side navigation pane, choose Server > Server Management.

   2. In the upper-right corner of the page, click Add Server.

   3. On the Add Server page that appears, enter the server information. The following table describes the fields related to the server.

      Field	Description
      Server IP	The public IP address of the server to be added.
      SSH Port	The SSHD port of the server to be added.
      Credentials	The access credentials of the server to be added. At present, two types of credentials are supported: username + password and key.
      Server Usage	Select OB Product Service.
      The docker root directory.	The data directory of Docker.
      Admin UID:GID	The UID and GID of the admin user of the operating system.

   4. Click OK.

      After the server is added, you can view it in the server list.

3. Create a MetaDB.

   To install OCP, you must create a MetaDB. To create a MetaDB, perform the following steps:

   1. In the left-side navigation pane, choose Product Service > Component Management.
   2. On the Component Management page, click Create Component in the upper-right corner, and choose Create MetaDB.
   3. On the Create MetaDB page, specify the related parameters.

   The following table describes the basic parameters of MetaDB.

   Parameter	Description
   MetaDB Image	The Docker image of MetaDB.
   Component Name	The name of the component, which must be unique. Default value: metadb.
   Server	The IP address of the server where the MetaDB is to be installed.
   CPU	The number of CPU cores allocated to the MetaDB. Default value: 32C.
   Memory	The memory allocated to the MetaDB. Default value: 90G.
   MetaDB Cluster Name	The name of the MetaDB cluster.
   root@sys Password	The password of the root user of the sys tenant.
   Log Directory	The log storage path of the MetaDB.

   The following table describes the installation path parameters of the MetaDB.

   Parameter	Description
   Installation Directory	The installation path of the MetaDB. Default value: /home/admin/oceanbase.
   Data Directory	The data storage path of the MetaDB. Default value:/data/1.
   Log Directory	The log storage path of the MetaDB. Default value: /log/1.
   Backup Directory (Optional)	The backup path of the MetaDB. By default, this parameter is left empty. This parameter is optional.

   The following table describes the startup parameters of the MetaDB.

   Parameter	Description
   MySQL Port	The MySQL port of the MetaDB. Default value: 2881.
   RPC Port	The RPC port of the MetaDB. Default value: 2882.
   OB Proxy Service Port	The service port of the OceanBase Database Proxy (ODP). Default value: 2883.
   SSHD Port	The SSHD port in the MetaDB container. Default value: 2022. OCP deploys the OCP Agent by connecting to the SSHD port.
   root Password	The password of the root user in the MetaDB container.

4. Install OCP.

   1. In the left-side navigation pane, choose Product Service > Product Management.
   2. On the Product Management page, click Install Product in the upper-right corner, and choose Install OCP.
   3. On the Install OCP page, specify the related parameters.

   The following table describes the basic parameters that you must set when you deploy OCP.

   Parameter	Description
   OCP Image	The Docker image of OCP.
   Product Name	The name of the product, 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 this zone.
   OCP Proxy Port	The port number for accessing OCP in this zone. Default value: 80.
   CPU	The number of CPU cores allocated to OCP. Default value: 8C.
   Memory	The memory allocated to OCP. Default value: 20G.
   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	Select the type of MetaDB.
   Select Created MetaDB	Select an existing MetaDB for OCP.
   OCP Meta Tenant	The dedicated tenant for OCP MetaDB.
   OCP Monitor Tenant	The dedicated tenant for OCP MonitorDB.
   Tenant Name	The name of the tenant.
   Tenant Password	The password of the tenant.
   CPU	The number of CPU cores allocated to the MetaDB. Default value: 2C.
   Memory	The memory allocated to the MetaDB. Default value: 5G.
   CPU	The number of CPU cores allocated to the MonitorDB. Default value: 4C.
   Memory	The memory allocated to MonitorDB. Default value: 16G.
   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.

What to do next

After OCP is installed, you can monitor and maintain OceanBase Database in OCP. For more information, see the OCP documentation.