Get started with OAT

OceanBase Admin Toolkit (OAT) allows you to install and uninstall services 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 engineer account. For more information, see Manage users.

Procedure

To install OCP, perform the following steps:

1. Log in to the OAT console.

   Log in to the OAT console as an O&M engineer. The OAT access address is in the format of 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 that appears, click Add Server. (3) In the Add Server dialog box, specify the server information. The following table describes the related parameters.

    |   Parameter    |          Description          |
    |---------|----------------------|
    | Server IP  | The public IP address of the server.    |
    | SSH Port      | The SSHD port number of the server.        |
    | Credentials  | The access credentials of the server. The following two types of credentials are supported: the combination of username and password, and key.   |
    | Server Usage | The purpose of the server. In this example, select **OB Product Service**. |
    | Docker Root Directory | The data directory of Docker. |
    | UID:GID | The user identifier (UID) and group identifier (GID) of the operating system user `admin`. |
   

   (4) Click OK.

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

3. Create the MetaDB component.

   You must create the MetaDB component before you can install OCP. To create the MetaDB component, perform the following steps:

   (1) In the left-side navigation pane, choose Product Service > Components. (2) On the Components page, click Create Component in the upper-right corner and choose Create MetaDB. (3) On the Create MetaDB page, configure the 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 on which you want to install MetaDB.
   CPU	The number of CPU cores available to MetaDB. Default value: 32.
   Memory	The size of memory available to MetaDB, in GB. Default value: 90.
   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 MetaDB.

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

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

   The following table describes the startup parameters of MetaDB.

   Parameter	Description
   MySQL Port	The MySQL port of MetaDB. Default value: 2881.
   RPC Port	The RPC port of 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 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 > Products. (2) On the Products page, click Install Product in the upper-right corner and choose Install OCP. (3) On the Install OCP page, configure the parameters.

   The following table describes the basic parameters of OCP.

   Parameter	Description
   OCP Image	The Docker image of OCP.
   Product Name	The name of the service, which must be unique.
   Multi-zone Mode	Specifies whether to enable multi-zone installation.
   Server	The IP address of the server on which you want to install OCP.
   OCP Proxy IP	The IP address for accessing OCP in the zone.
   OCP Proxy Port	The port number for accessing OCP in the zone. Default value: 80.
   CPU	The number of CPU cores available to OCP. Default value: 8.
   Memory	The size of memory available to OCP, in GB. 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.
   Log Directory	The log storage path of OCP.

   The following table describes the MetaDB parameters of OCP.

   Parameter	Description
   MetaDB Type	The type of MetaDB.
   Select Created MetaDB	The existing MetaDB component to be used 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 available to MetaDB. Default value: 2.
   Memory	The size of memory available to MetaDB, in GB. Default value: 5.
   CPU	The number of CPU cores available to MonitorDB. Default value: 4.
   Memory	The size of memory available to MonitorDB, in GB. Default value: 16.
   Take over the MetaDB Cluster	Specifies whether to 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 instance.

What to do next

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

Demo video