Deploy an OceanBase cluster through the GUI of obd

This topic describes how to deploy an OceanBase cluster in an x86-based CentOS Linux 7.9 system through the GUI of OceanBase Deployer (obd).

Prerequisites

• Your server meets the software and hardware requirements. For more information, see Software and hardware requirements.

• In a production environment, you have checked the environment and configurations. For more information, see Before deployment.

• At least 2 vCPUs, 8 GB of memory, and 19 GB of disk space are available for deploying OceanBase Database only.

• At least 4 vCPUs, 10 GB of memory, and 25 GB of disk space are available for deploying OceanBase Database and all its components. We recommend that more than 16 GB of memory be available.

• The Java environment has been installed and configured if OceanBase Cloud Platform (OCP) Express is to be deployed. At present, only Java Development Kit (JDK) 1.8 is supported. For more information, see the How do I configure the Java environment before I deploy OCP Express? section in FAQ.

  Notice

  obd remotely performs installation and deployment by using the Secure Shell (SSH) protocol. Therefore, you must use SSH to verify whether the Java environment is available. For more information, see Verify the Java environment.

Prepare the software

You can deploy OceanBase Database through the GUI of obd either online or offline.

• Online deployment: Make sure that the server where obd resides can connect to the Internet. In this deployment mode, obd obtains the installation package from a remote image repository during deployment. Therefore, you do not need to deploy and configure the installation package in advance.

• Offline deployment: The server where obd resides does not need to connect to the Internet during deployment. In this deployment mode, you must upload the installation package to the local image repository of obd in advance. If you choose offline deployment, we recommend that you download the all-in-one package of the desired version.

Prepare the software based on the deployment mode.

Online deployment

If you choose online deployment, run the following commands to install obd on the central control server:

[admin@test001 ~]$ sudo yum install -y yum-utils
[admin@test001 ~]$ sudo yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
[admin@test001 ~]$ sudo yum install -y ob-deploy
[admin@test001 ~]$ source /etc/profile.d/obd.sh

Offline deployment

If you choose offline deployment, run the following commands to download and install the all-in-one package.

You can download the latest all-in-one package from OceanBase Download Center and copy it to the central control server. Run the following commands to decompress and install the package:

[admin@test001 ~]$ tar -xzf oceanbase-all-in-one-*.tar.gz
[admin@test001 ~]$ cd oceanbase-all-in-one/bin/
[admin@test001 bin]$ ./install.sh
[admin@test001 bin]$ source ~/.oceanbase-all-in-one/bin/env.sh

Procedure

1. Go to the GUI of obd.

   Run the obd web command on the CLI, and click the generated URL to go to the GUI.

   [admin@test001 ~]$ obd web
   start OBD WEB in 0.0.0.0:8680
   please open http://10.10.10.1:8680
   

   Note

   • The default port in the URL is 8680. You can use the obd web -p <PORT> command to specify a port.

   • In Alibaba Cloud or other cloud environments, the program may fail to obtain a public IP address but return an intranet IP address. You must use a correct public IP address to access the GUI.

   • The obd web command is bound to `0.0.0.0`. In a deployment where multiple network interface cards (NICs) are used, you can access the GUI through any accessible IP address.

   To change the display language, click the English icon in the upper-right corner of the page and select a language as needed.

   

   On the GUI, click Try Now to go to the Welcome to the OceanBase Deployment Wizard page. On the page, select OceanBase and supporting tools and click OK to go to the OceanBase Database deployment page.

2. Configure the deployment information.

   On the Deployment Configuration page, you can configure the cluster name, deployment type, and components to deploy.

   

   The parameters are described as follows:

   • The default value of Cluster Name is myoceanbase, which can be modified and must not be the same as the name of an existing cluster.

   • By default, all components are deployed. You can deselect the components that you do not want to deploy under Optional Components. Note that OceanBase Cloud Platform (OCP) Express is automatically selected along with OceanBase Agent (OBAgent). When you deselect OBAgent, OCP Express is also automatically deselected.

   • You can click Learn More in the row of a component to view its documentation.

   • You can click the drop-down list in the Version column of OceanBase Database and select a version. For other components, the latest versions are installed by default.

   Click Next Step to go to the Node Configuration page.

3. Configure the node information.

   On the Node Configuration page, configure the database and component nodes, and specify the user information and software installation path.

   

   The parameters are described as follows:

   • By default, three zones are available for the database nodes. You can click + Add Zone to add a zone or click the Delete icon to delete a zone.

   • For OCP Express Node, you can select the IP address of an OBServer node from the drop-down list or enter the IP address of a new node. You can select or enter only one IP address.

   • For OBProxy Node, you can select the IP address of an OBServer node or enter the IP address of a new node. You can configure multiple OceanBase Database Proxy (ODP) nodes.

   • By default, the value of User Name is the user who started the current process and the SSH port is Port 22. You can change the user and SSH port as needed. If password-free access is not configured for the nodes, you must enter the password of the specified user.

   • By default, the value of Software Path is the home directory of the user who performed the deployment. You can change the path as needed.

   Click Next Step to go to the Cluster Configuration page.

4. Configure the cluster information.

   On the Cluster Configuration page, configure related cluster information, including the password of the administrator user in the sys tenant (root@sys), data directory, log directory, and ports and parameters of OceanBase Database and its components.

   

   The parameters are described as follows:

   • Valid values of Mode Configuration are Maximum Utilization and Minimum Availability. The Maximum Utilization mode maximizes resource utilization to ensure cluster performance and stability, and is recommended. In Minimum Availability mode, minimum resources required for the normal running of the cluster are configured. For more information about the two modes, see Mode configuration rules.

   • The default value of root@sys Password is a random string automatically generated by obd, and can be modified. The password must meet the following complexity requirements:

     • It must be 8 to 32 characters in length.

     • It must contain characters of at least three of the following types: digits (0 to 9), uppercase letters (A to Z), lowercase letters (a to z), and special characters. Special characters are ~ ! @ # % ^ & * _ - + = | ( ) { } [ ] : ; , . ? /.

   • By default, the data directory and log directory of the cluster are in the software path configured on the Node Configuration page. The data and log directories must be absolute paths beginning with /. You can change the data and log directories. Make sure that the specified directories are empty.

   • The default ports are retained for the database and its components. You can change the ports. Make sure that the specified ports range from 1024 to 65535 and are not occupied.

   • Enable More Configurations to view more cluster or component parameters. You can retain the default settings or modify the settings.

   Click Next Step to go to the Pre-check page.

5. Perform a pre-check.

   On the Pre-check page, confirm all the configuration information. If any information is incorrect, you can click Previous Step to modify the information. After you confirm that all the information is correct, click Pre-check.

   If an error code is returned, you can click Auto repair to automatically repair the error, or click Learn more to go to the error code document and correct the error based on the reference document. After all the errors are fixed, click Re-check to perform a pre-check again.

   

6. Deploy OceanBase Database.

   After the pre-check is passed, click Deploy to start the deployment.

   

   On the Deployment Wizard page:

   • After the deployment succeeds, you can copy the displayed connection string of OceanBase Database and use it to connect to the database from the CLI.

   • Click the connection string of OCP Express to go to the login page of OCP Express. Log in with the account and password provided on the page, and then change the password. Then, you can manage the cluster on the GUI of OCP Express.

     Note

     In Alibaba Cloud or other cloud environments, the program may fail to obtain a public IP address but return an intranet IP address. You must use a correct public IP address to access the GUI.

   • In the Deployment Report section, click the Expand icon before a component to view its deployment logs on the GUI.

   • In the Deployment Report section, find the target component and click View Details. Then, you can click the Copy icon next to a command to copy the command and run the command on the central control server to view the log location of the component.

7. Click Finish.

Related operations

Verify the Java environment

obd remotely executes a script to deploy OCP Express. Therefore, you must use SSH to verify the Java environment. You cannot directly run the java -version command on the server where OCP Express is deployed to verify the Java environment.

You can run the following command on any server that has established a network connection with the node where OCP Express resides.

# ocp_express_node_username: the username of the node where OCP Express resides
# ocp_express_node_ip: the IP address of the node where OCP Express resides
[admin@test001 ~]$ ssh <ocp_express_node_username>@<ocp_express_node_ip> 'java -version'

# Command output
openjdk version "1.8.0_xxx" 
OpenJDK Runtime Environment (build 1.8.0_362-b08)
OpenJDK 64-Bit Server VM (build 25.362-b08, mixed mode)

If the required Java environment has been installed but failed the verification, you can resolve the issue in the following ways:

• Method 1: Specify the java_bin parameter in the More Configurations section.

  As shown in the following figure, set java_bin to the real path of Java, such as /jdk8/bin/java.

  

• Method 2: Create a soft link from the executable file of Java to /usr/bin/java.

  [admin@test001 bin]$ pwd
  /jdk8/bin
  [admin@test001 bin]$ ln -s /jdk8/bin/java  /usr/bin/java
  

Manage the cluster

You can run the following commands to manage a cluster deployed by using obd. For more information, see Cluster commands.

# View the cluster list.
[admin@test001 ~]$ obd cluster list

# View the status of the myoceanbase cluster.
[admin@test001 ~]$ obd cluster display myoceanbase

# Stop the myoceanbase cluster in the running state.
[admin@test001 ~]$ obd cluster stop myoceanbase

# Destroy the myoceanbase cluster.
[admin@test001 ~]$ obd cluster destroy myoceanbase

Deploy a component of the desired version

The all-in-one package is iterated based on OceanBase Database versions. If any component in the package has a later version, you can download the component of the latest version from OceanBase Download Center and then upload it to the local image repository of obd. obd automatically obtains the latest version from the local image repository during deployment.

1. Go to the directory where the component installation package is located, run the following command to add it to the local image repository:

   [admin@test001 rpm]$ obd mirror clone *.rpm
   

2. View the list of installation packages in the local image repository.

   [admin@test001 rpm]$ obd mirror list local