Create a cluster

After OceanBase Database is deployed, a cluster is created by default. You can use OceanBase Cloud Platform (OCP) to create clusters as needed.

Prerequisites

You have permissions of the CLUSTER_MANAGER role. If you do not have the permissions of the role, contact the administrator to obtain the permissions. For more information, see the Edit a user topic in OCP User Guide of the corresponding version.

Procedure

You can use OCP to add servers, upload the RPM package of OceanBase Database, and create a cluster.

1. Log on to the OCP console, and find the entry to cluster creation based on the actual business scenario.

   • If you do not have a manageable cluster, the system displays a message on the Clusters page, prompting you to create one. Click Create Cluster in the prompt.

   • If you already have a manageable cluster, go to the Clusters page, and then click Create Cluster in the upper-right corner.

2. On the Create Cluster page, configure the basic information of the cluster.

   The following table describes the fields on the Basic Settings page.

   Field	Description
   Cluster Type	Select Primary Cluster.
   Cluster Name	The name of the cluster to be created. The cluster name must be globally unique. It must start with a letter and consist of 2 to 48 characters, including uppercase and lowercase letters, digits, and underscores (_).
   Root@sys Password	This password can be customized or randomly generated. The password must meet the following complexity conditions: Contains 8 to 32 characters, including at least two digits, two uppercase letters, two lowercase letters, and two special characters. Supported special characters are . _ + @ # $ % )
   OceanBase Version	You can select an OceanBase Database version from the list or click Add Version to upload the RPM package of an OceanBase Database version.
   Associate OBProxy Cluster	This option associates the cluster with an OceanBase Database Proxy (ODP, also known as OBProxy) cluster. You can enable this option and select an existing ODP cluster to associate it with the cluster. By default, the proxyro user is used for association. You do not need to enter a username or password. Select the ODP cluster to be associated with from the drop-down list. If no ODP cluster is available in the drop-down list, create an ODP cluster. For more information, see Create a cluster. After the association, the business SQL requests will be forwarded to the corresponding replica. This ensures a good experience that can rival access to a standalone database when you access OceanBase Database.

3. Set the deployment mode of the cluster.

   By default, three zones are added for a cluster. To deploy more than three zones for the cluster, click New Zone. To deploy less than three zones for the cluster, click the Delete icon after the zone to be deleted.

   The following table describes the settings for each zone.

   Field	Description
   Zone Name	You can retain the default name or define a custom name. The zone name must be unique in the tenant. It must start with a letter and consist of 2 to 48 characters, including uppercase and lowercase letters, digits, and underscores (_).
   IDC	The IDC of the zone. Each zone can be deployed in only one IDC.
   Model	Optional. If you select a host model, the host list is filtered based on the host model.
   CPU Architecture	If multiple installation packages for different architectures are available for the selected OceanBase Database version, the selected hardware architecture of the host must match the software package. Note By default, the architecture of the first installation package is used. You can change the architecture. After you change the architecture, you can select a host of the selected architecture from the drop-down list of the Host field. You can set different architectures for the zones. However, the deployment mode with a hybrid architecture may have stability and performance issues. Proceed with caution.
   Host	You can select or add hosts.
   Root Server	You must select an IP address as the host for the Root Service. If you want to create a multi-replica OceanBase cluster, you must specify this parameter for each zone.
   Zone Priority Rankings	The priorities of the zones. The priority order affects the priority order of the primary zone of the sys tenant. Ranking method: Select one or more zones from the left-side list. The left-side list shows all zones available in the cluster. Click the closing angle bracket (>) in the middle. The selected zones are moved to the Priority Rankings list. The zones that are selected at the same time have the same priority. Repeat the preceding steps to add zones of a lower priority. You can drag a zone in the Priority Rankings list to adjust its priority. The priority in the list decreases from top to bottom.

4. Click Parameter Settings to modify startup parameters.

   For more information about the cluster-level parameters, see System parameters.

5. Turn on Custom Settings to configure paths and ports.

   • Configure the paths:

     1. In the Path Settings section, specify the Software Installation Path, Data Disk Path, and Log Disk Path as needed.

     2. Click Test to check whether the paths can be used.

        If a path cannot be used, you can perform troubleshooting based on the test results, or use another path.

   • Configure the ports:

     1. In the Port Settings section, specify SQL Port and RPC Port as needed.

     2. Click Test to check whether the ports are occupied.

        If a port is occupied, you must use another port.

6. After the test succeeds, click Submit.

7. In the Confirm Information dialog box, confirm the information and then click OK.

   The system starts to create the cluster. You can choose System Management > Tasks in the OCP console to view the task progress.