Cluster management operations

OceanBase Cloud Platform (OCP) provides the cluster management feature, allowing you to create, scale out, scale in, upgrade, restart, and delete clusters.

Background

The operation interface of OCP may vary with the version. The following provides the operation guide for OCP V2.4.4. For operations on other OCP versions, see the User Guide of the corresponding version.

Create a cluster

You can create a cluster by using OCP or command lines. The following describes how to use OCP to add servers, upload the RPM package of OceanBase Database, and create a cluster:

1. Log on to the OCP console.

2. Add a host.

   1. In the left-side navigation pane, click Hosts . On the Host Management page, click Add Host .

   2. In the Add Host window that appears, specify relevant information about the host, including the IP address, SSH port number, host type, IDC, type, root user password, and admin user password, and click OK .

3. Create a cluster.

   1. In the navigation pane, click Cluster. On the Cluster Overview page, click Create Cluster.

   2. On the Create Cluster page, select the cluster type, enter the cluster name and user account password, and then select the OceanBase Database version.

      The following table describes the parameters for creating a cluster.

      Parameter	Description
      Cluster Type	Select Primary Cluster.
      Cluster Name	The name of the cluster to be managed. The cluster name consists of 2 to 48 characters, including uppercase and lowercase letters, digits, and underscores (_), and must start with a letter.
      root@sys Password	This parameter can be customized or randomly generated.The password must meet the following complexity conditions: Contain 8 to 32 characters consisting of at least 2 digits, 2 uppercase letters, 2 lowercase letters, and 2 special characters. The following special characters are supported: ._+@#$%)
      OceanBase Database Version	You can select an OceanBase Database version from the list or click Add Version to upload an OceanBase Database version.

   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 Add to add new zones.

      To deploy less than three zones for the cluster, click the delete icon next to the zones to be deleted.

      The following table describes the settings for each zone.

      Parameter	Description
      Zone Name	Generally, a default name is provided. You can customize the name as needed. A zone name must consist of 2 to 48 characters, including uppercase and lowercase letters, digits, and underscores (_), and start with a letter.
      IDC	The IDC of the zone. Each zone can be deployed in only one IDC.
      Host Type	Optional. If you select a host type, the host list is filtered based on the host type.
      Server Selection Method	Choose Automatic or Manual.
      IP	You can select multiple IP addresses. If Server Selection Method is set to Automatic, you only need to enter the number of hosts for OCP to select available hosts. If Server Selection Method is set to Manual, you need to manually select the IP addresses from the list.
      Root Server Location	You can select an IP address of the host for the root server.
      Priority Rankings	The priority rankings of the zone. This priority order affects the priority order of the primary zone of the sys tenant. The left-side list shows all zones in the cluster. You can select one or more zones from the list box on the left to add them to the list box on the right. By default, the priority of the zone selected first is higher than that of the zone selected later, and the zones selected at one time have the same priority. After you move the zones to the list box on the right, you can also drag them upward or downward to adjust their priority order. The upper zone takes priority over the lower zone.

   4. Click Submit.

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

Restart a cluster

You can restart one, several, or all zones in a cluster. Generally, you need to restart zones for parameter modification to take effect.

1. Log on to the OCP console.

   The Cluster Overview page automatically appears.

2. In the Clusters area on the Cluster Overview page, select the target cluster and click its name.

3. Click the icon in the upper-right corner on the Overview page and select Restart Cluster .

4. Set Restart Scope to All , a zone, or several zones, and click Restart .

   If you select All , OBServer processes of all zones in the cluster are restarted. If you select some zones, OBServer processes of the selected zones are restarted.

Delete a cluster

You can delete a cluster when the cluster is replaced or needs to be redeployed.

Important

Cluster deletion is irreversible. After a cluster is deleted, all data of the cluster is deleted. Take caution when deleting a cluster.

1. Log on to the OCP console.

   The Cluster Overview page automatically appears.

2. In the Clusters area on the Cluster Overview page, select the target cluster and click its name.

3. In the upper-right corner on the Overview page, click ... and select Delete Cluster .

4. In the Delete Cluster dialog box, enter delete, and click Delete .

Scale out a cluster

You can add OBServers to scale out a cluster. After a cluster is scaled out, available resources of the cluster increase and more resources can be allocated to the tenants. Generally, when tenants occupy all resources of a cluster, you need to scale out the cluster to allow new tenants to join in or allow existing tenants to scale out.

Before you scale out a cluster, add the servers on OCP.

1. Log on to the OCP console.

   The Cluster Overview page automatically appears.

2. In the Clusters area on the Cluster Overview page, select the target cluster and click its name.

3. In the upper-right corner on the Overview page, click Add OBServer .

4. In the OBServer Information area, specify the host type, server selection method, and host IP address of the OBServer for each zone.

5. Click OK .

   Note

   We recommend that you do not use servers of different types in one cluster in OceanBase Database. We recommend that you use servers with the same configuration in one cluster. For example, we recommend that you do not use servers with hard disk drives (HDDs) and servers with solid state drives (SSDs) together in one cluster.