Deploy a three-replica OceanBase cluster using the CLI

This topic describes how to deploy a three-replica OceanBase cluster using the CLI.

Prerequisites

Before installing OceanBase Database, make sure that the following conditions are met:

• The OBServer node has been configured. For more information, see Server configuration, (Optional) Configure a clock source, and Initialize the OBServer node using oat-cli.

• You have obtained the RPM package of OceanBase Database. For more information, see Prepare installation packages.

Procedure

Step 1: Install the RPM package

1. Install the OceanBase Database RPM package.

   Here, $rpm_dir indicates the directory where the RPM package is stored, and $rpm_name indicates the name of the RPM package.

   [root@xxx /]# cd $rpm_dir
   [root@xxx $rpm_dir]# rpm -ivh $rpm_name
   

   Note

   By default, OceanBase Database will be installed in the /home/admin/oceanbase directory.

   Here is an example:

   [root@xxx /home/admin/rpm]# rpm -ivh oceanbase-4.2.0.0-100000052023073123.el7.x86_64.rpm
   Preparing...                          ################################# [100%]
   Updating / installing...
      1:oceanbase-4.2.0.0-100000052023073################################# [100%]
   

2. (Optional) Install OceanBase Client.

   OceanBase Client OBClient is a dedicated command-line client tool for OceanBase Database. With OBClient, you can connect to MySQL and Oracle tenants in OceanBase Database. If you only want to connect to a MySQL tenant, you can also use the MySQL client (mysql) to connect to OceanBase Database.

   Notice

   Due to the dependency of obclient V2.2.1 and earlier on libobclient, you need to install libobclient first. Contact technical support to obtain the RPM packages of OBClient and libobclient.

   Here is an example:

   [root@xxx /home/admin/rpm]# rpm -ivh obclient-2.2.1-20221122151945.el7.alios7.x86_64.rpm
   Preparing...                          ################################# [100%]
   Updating / installing...
      1:obclient-2.2.1-20221122151945.el7################################# [100%]
   
   ##Check whether OceanBase Client is installed##
   [root@xxx /home/admin/rpm]# which obclient
   /usr/bin/obclient
   

Step 2: Configure directories

1. Clear the OceanBase directory (not required on the first deployment).

   If you want to clear the OceanBase environment before the deployment or the OceanBase installation is interrupted or the environment is messy and files that will affect the next installation are generated, choose to clear the old OceanBase directory. In this case, $cluster_name is the name of the cluster.

   [root@xxx admin]# su - admin
   -bash-4.2$ kill -9 `pidof observer` 
   -bash-4.2$ rm -rf /data/1/$cluster_name 
   -bash-4.2$ rm -rf /data/log1/$cluster_name 
   -bash-4.2$ rm -rf /home/admin/oceanbase/store/$cluster_name /home/admin/oceanbase/log/* /home/admin/oceanbase/etc/*config*
   -bash-4.2$ ps -ef|grep observer
   

   Here is an example:

   [root@xxx admin]# su - admin
   -bash-4.2$ kill -9 `pidof observer` 
   -bash-4.2$ rm -rf /data/1/obdemo 
   -bash-4.2$ rm -rf /data/log1/obdemo 
   -bash-4.2$ rm -rf /home/admin/oceanbase/store/obdemo /home/admin/oceanbase/log/* /home/admin/oceanbase/etc/*config*
   -bash-4.2$ ps -ef|grep observer
   

2. Initialize the OceanBase directory.

   We recommend that you use an independent disk for the data directory of OceanBase Database so that it can be soft-linked to the home directory of the software. In this way, you can free up the system disk space. In this case, $cluster_name is the name of the cluster.

   Note

   Starting from OceanBase Database V4.3.0, you can independently configure the slog disk from the data (data) disk. In other words, slog and data files do not need to be on the same disk. You can configure the same SSD to share for slog and clog. For more information about the installation directories of OceanBase Database, see OBServer node installation directory structure.

   [root@xxx admin]# su - admin
   -bash-4.2$ mkdir -p /data/1/$cluster_name/{etc3,sstable,slog} 
   -bash-4.2$ mkdir -p /data/log1/$cluster_name/{clog,etc2} 
   -bash-4.2$ mkdir -p /home/admin/oceanbase/store/$cluster_name
   -bash-4.2$ for t in {etc3,sstable,slog};do ln -s /data/1/$cluster_name/$t /home/admin/oceanbase/store/$cluster_name/$t; done
   -bash-4.2$ for t in {clog,etc2};do ln -s /data/log1/$cluster_name/$t /home/admin/oceanbase/store/$cluster_name/$t; done
   

   Here is an example:

   [root@xxx admin]# su - admin
   -bash-4.2$ mkdir -p /data/1/obdemo/{etc3,sstable,slog} 
   -bash-4.2$ mkdir -p /data/log1/obdemo/{clog,etc2} 
   -bash-4.2$ mkdir -p /home/admin/oceanbase/store/obdemo
   -bash-4.2$ for t in {etc3,sstable,slog};do ln -s /data/1/obdemo/$t /home/admin/oceanbase/store/obdemo/$t; done
   -bash-4.2$ for t in {clog,etc2};do ln -s /data/log1/obdemo/$t /home/admin/oceanbase/store/obdemo/$t; done
   

   Note

   The obdemo directory is created based on the cluster name and can be customized. It is used by the startup process.

   The check result is as follows:

   -bash-4.2$ cd /home/admin/oceanbase
   -bash-4.2$ tree store/
   store/
   `-- obdemo
    |-- clog -> /data/log1/obdemo/clog
    |-- etc2 -> /data/log1/obdemo/etc2
    |-- etc3 -> /data/1/obdemo/etc3
    |-- slog -> /data/1/obdemo/slog
    `-- sstable -> /data/1/obdemo/sstable
   
   6 directories, 0 files
   

Step 3: Initialize the OceanBase cluster

1. Start the observer process on each node.

   Start the observer process on the admin user account of each node.

   Note

   In a three-replica deployment, the startup parameters of each node are different. When you start the observer process, you only need to specify the three (or more) servers where RootService is located, without specifying all servers when you create the cluster. After the cluster is created, you can add more servers.

   cd /home/admin/oceanbase && /home/admin/oceanbase/bin/observer {-I $ip | -i $devname} -P $rpc_port -p $sql_port -z $zone_name -d /home/admin/oceanbase/store/$cluster_name -r '$ip:2882:2881' -c $cluster_id -n $cluster_name -o "system_memory=30G,datafile_size=500G,config_additional_dir=/data/1/$cluster_name/etc3;/data/log1/$cluster_name/etc2"
   

   The parameters are described as follows:

   Parameter	Description
   -I | -i	-I: the IP address of the server where you want to start the observer process. In a multi-server deployment, you cannot specify 127.0.0.1 as the target IP address. We recommend that you use the specified IP address (-I 10.10.10.1) to start the observer process. -i: the name of the network interface card. You can view the available network interface card names by using the ifconfig command. Note You can specify both the IP address and the network interface card name (-I 10.10.10.1 -i eth0) to start the observer process, but we recommend that you do not specify both parameters.
   -p	the service port number, which is generally set to 2881.
   -P	the RPC port number, which is generally set to 2882.
   -n	the cluster name. Custom cluster names must be unique.
   -z	the zone to which the observer process belongs.
   -d	the primary directory of the cluster. The directory is created when the cluster is initialized. Except for the cluster name $cluster_name, other parameters must not be modified.
   -c	the cluster ID. It is a group of digits, which can be customized but must be unique among clusters.
   -l	the log level.
   -r	the RootService information. The format is $ip:2882:2881, semicolon-separated. For example, if the RootServices are deployed on the servers with IP addresses 192.168.0.1, 192.168.0.2, and 192.168.0.3, you can specify -r 192.168.0.1:2882:2881;192.168.0.2:2882:2881;192.168.0.3:2882:2881.
   -o	the list of startup parameters (configurations). This parameter is optional. You can specify values for multiple configurations, separated by commas. Select the appropriate configurations to optimize the cluster performance and resource efficiency based on your business needs. Some commonly used startup configurations are described as follows: cpu_count: the total number of CPU cores. system_memory: the memory size reserved for Tenant ID 500, namely, OceanBase Database internal memory. If the server has limited memory, you can set this parameter to a smaller value. However, make sure that the server has enough memory for performance tests. memory_limit: the total size of available memory. datafile_size: the size of disk space occupied by data files. In other words, it is the size of the sstable file in OceanBase Database. Based on the available space in /data/1/, we recommend that you set the value to at least 100G. datafile_disk_percentage: the percentage of total disk space occupied by data files. datafile_next: the automatic expansion step length of data files. datafile_maxsize: the maximum automatic expansion size of data files. config_additional_dir: multiple directories for storing local configuration files to achieve redundant storage of the configuration files. log_disk_size: the size of the redo log disk. log_disk_percentage: the percentage of total disk space occupied by the redo log. syslog_level: the system log level. syslog_io_bandwidth_limit: the upper limit on the disk I/O bandwidth available to system logs. System logs exceeding the bandwidth upper limit will be discarded. max_syslog_file_count: the maximum number of log files that can be stored before the system starts to recycle logs. enable_syslog_recycle: the switch to enable log file recycling before the system starts. It is used in conjunction with the max_syslog_file_count parameter to determine whether to recycle old log files. The datafile_size, datafile_disk_percentage, datafile_next, and datafile_maxsize parameters are used to enable automatic expansion of disk data files. For more information, see Enable dynamic expansion for disk data files. For more information about cluster configurations, see Overview of system configurations.

   Here is an example:

   zone1:

   [root@xxx admin]# su - admin
   -bash-4.2$ cd /home/admin/oceanbase && /home/admin/oceanbase/bin/observer -I 10.10.10.1 -P 2882 -p 2881 -z zone1 -d /home/admin/oceanbase/store/obdemo -r '10.10.10.1:2882:2881;10.10.10.2:2882:2881;10.10.10.3:2882:2881' -c 10001 -n obdemo -o "system_memory=30G,datafile_size=500G,config_additional_dir=/data/1/obdemo/etc3;/data/log1/obdemo/etc2"
   

   zone2:

   [root@xxx admin]# su - admin
   -bash-4.2$ cd /home/admin/oceanbase && /home/admin/oceanbase/bin/observer -I 10.10.10.2 -P 2882 -p 2881 -z zone2 -d /home/admin/oceanbase/store/obdemo -r '10.10.10.1:2882:2881;10.10.10.2:2882:2881;10.10.10.3:2882:2881' -c 10001 -n obdemo -o "system_memory=30G,datafile_size=500G,config_additional_dir=/data/1/obdemo/etc3;/data/log1/obdemo/etc2"
   

   zone3:

   [root@xxx admin]# su - admin
   -bash-4.2$ cd /home/admin/oceanbase && /home/admin/oceanbase/bin/observer -I 10.10.10.3 -P 2882 -p 2881 -z zone3 -d /home/admin/oceanbase/store/obdemo -r '10.10.10.1:2882:2881;10.10.10.2:2882:2881;10.10.10.3:2882:2881' -c 10001 -n obdemo -o "system_memory=30G,datafile_size=500G,config_additional_dir=/data/1/obdemo/etc3;/data/log1/obdemo/etc2"
   

   Run the following command to check whether the observer process has started successfully:

   • Use the netstat -ntlp command. If the observer process is listening on ports 2881 and 2882, the process has started successfully.
   • Use the ps -ef|grep observer command to view the observer process information.

   Here is an example:

   -bash-4.2$ netstat -ntlp
   (Not all processes could be identified, non-owned process info
   will not be shown, you would have to be root to see it all.)
   Active Internet connections (only servers)
   Proto Recv-Q Send-Q Local Address           Foreign Address         State       PID/Program name
   tcp        0      0 0.0.0.0:2881            0.0.0.0:*               LISTEN      11114/observer
   tcp        0      0 0.0.0.0:2882            0.0.0.0:*               LISTEN      11114/observer
   ...        ...    ...                       ...                     ...         ...
   
   -bash-4.2$ ps -ef|grep observer
   admin     11114      0 40 16:18 ?        00:00:17 /home/admin/oceanbase/bin/observer -I 10.10.10.1 -P 2882 -p 2881 -z zone1 -d /home/admin/oceanbase/store/obdemo -r 10.10.10.1:2882:2881;10.10.10.2:2882:2881;10.10.10.3:2882:2881 -c 10001 -n obdemo -o system_memory=30G,datafile_size=500G,config_additional_dir=/data/1/obdemo/etc3;/data/log1/obdemo/etc2
   

2. Perform the bootstrap operation for the cluster.

   Use OBClient to connect to any server in the cluster. The password is empty.

   [root@xxx admin]# obclient -h127.0.0.1 -uroot -P2881 -p******
   
   obclient> SET SESSION ob_query_timeout=1000000000;
   Query OK, 0 rows affected
   
   obclient> ALTER SYSTEM BOOTSTRAP ZONE 'zone1' SERVER '10.10.10.1:2882',ZONE 'zone2' SERVER '10.10.10.2:2882',ZONE 'zone3' SERVER '10.10.10.3:2882';
   Query OK, 0 rows affected
   

   Note

   If this step fails, check whether the observer process startup parameters are correct, whether the directories of the observer process have the correct permissions, whether the log directory has sufficient space (it is the same directory that stores data, and its space is occupied by data), whether the node time is synchronized, and whether the node has sufficient memory resources. If the problem persists, clear the OceanBase directory and deploy OceanBase Database from the beginning.

3. Verify that the cluster has been initialized.

   After the bootstrap initialization is completed, run the SHOW DATABASES; command to verify that the initialization is successful. If the query result shows the oceanbase database in the database list, the cluster initialization is successful.

4. Change the password.

   By default, the root user of the sys tenant has an empty password. We recommend that you change the password after the initialization is successful.

   ALTER USER root IDENTIFIED BY '******';
   

Next steps

After the cluster is created, you can create user tenants as needed.

For more information about how to create a user tenant, see Create a tenant.

References

• Connect to an OceanBase tenant by using OBClient
• Overview of system configuration items
• ALTER USER
• Introduction to user tenants
• CREATE TENANT