Deploy an OceanBase cluster by using the obd GUI

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).

Terms

• OceanBase Database

  OceanBase Database is a fully self-developed, enterprise-level, native distributed database. For more information, see OceanBase Database documentation.

• obd

  OceanBase Deployer (obd) is a tool for installing and deploying open source OceanBase software. For more information, see obd documentation.

• ODP

  OceanBase Database Proxy (ODP), also known as OBProxy, is a dedicated proxy server for OceanBase Database. For more information, see ODP documentation.

• OBAgent

  OceanBase Agent (OBAgent) is a framework for data monitoring and collection in OceanBase Database. It supports both pushing and pulling modes for data collection in different scenarios.

• obconfigserver

  OceanBase Configserver (obconfigserver) provides metadata registration, storage, and query services for OceanBase Database. For more information, see ob-configserver.

• Grafana

  Grafana is an open-source data visualization tool that enables you to visualize various metrics from data sources, helping you better understand system status and performance. For more information, see Grafana official website.

• Prometheus

  Prometheus is an open-source service monitoring system and time-series database. It provides a general data model as well as efficient interfaces for data collection, storage, and querying. For more information, see Prometheus official website.

• Alertmanager

  Alertmanager is an open-source alert management tool that processes alerts from monitoring systems such as Prometheus, offering features like deduplication, grouping, routing, and silencing. For more information, see Prometheus official website.

Prerequisites

Before you begin, make sure that the following conditions are met:

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

• In a production environment, you need to check the environment and configurations.

• To deploy only OceanBase Database, you need at least 2 vCPUs, 6 GB of memory, and 20 GB of disk space. Note that the memory limit refers to the value in the available column of the output obtained by running the free -g command.

• To deploy OceanBase Database and all components, you need at least 4 vCPUs, 10 GB of memory, and 25 GB of available disk space. It is recommended to have more than 16 GB of memory. Note that the memory requirement refers to the value in the available column shown when you run the free -g command.

Prepare 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.

You can select the appropriate method to prepare the software based on your specific circumstances.

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.

[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

Step 1: Start the GUI

1. Start the GUI

   Run the obd web command in the CLI to start the GUI, and click the displayed address to access 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 GUI uses port 8680 by default. You can specify a port using the obd web -p <PORT> command.

   • In Alibaba Cloud or other cloud environments, the program may fail to obtain the public IP address and instead output an internal IP address. This IP is not a public address, so you need to use the correct address to access the GUI.

   • The obd web command is bound to 0.0.0.0. In a multi-network interface deployment, you can access the GUI using any accessible IP address.

   • You can use the nohup or screen command to run the obd web command in the background.

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

   

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

Step 2: Configure the deployment

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

1. Cluster configuration

   Section	Description
   Deployment Configuration	The cluster name is the unique identifier for products deployed with obd. By default, it is myoceanbase, but you can customize it as long as it does not duplicate an existing deployment name. The cluster name must start with a letter, end with a letter or number, and can include letters, numbers, and underscores. Its length must be between 2 and 32 characters. You can use the obd cluster list command to view the clusters managed by obd.
   Deploy a database	Click the drop-down list of Version to select the desired OceanBase Database version. Click Learn more next to the corresponding component to view its documentation.
   Load Type	Click the drop-down list of Type to select the load type of the OceanBase cluster. Each load balancing type includes a description to help you understand its applicable scenarios. Note This section is only displayed when the OceanBase Database version to be deployed is V4.2.5 or above.

2. Component selection

   By default, only the ODP component is selected. You can choose whether to deploy other components by clicking the checkbox next to each component under Optional components. Component versions are fixed to the latest version. Click Learn More next to a component to view its documentation.

   Note

   The deployment of the Grafana and AlertManager components depends on the OBAgent and Prometheus components, while the deployment of the Prometheus component depends on the OBAgent component. Specifically, when you select the Grafana or AlertManager component, the OBAgent and Prometheus components will be automatically selected. If you deselect the OBAgent component, Grafana, AlertManager, and Prometheus will also be automatically deselected.

Click Next Step to go to the Node Configuration page.

Step 3: Configure the nodes

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

After you configure the nodes, click Next Step to go to the Cluster Configuration page.

Step 4: Configure the cluster

The Cluster Configuration page allows you to configure the cluster, including the password of the system tenant administrator (root@sys), data and log directories, and the ports and parameters of the database and components. This section will explain these configurations in detail.

1. Cluster configuration

   

   Parameter	Description
   Mode Configuration	Valid values include Maximum Utilization (recommended) and Minimum Availability. The Maximum Utilization mode maximizes resource utilization to ensure cluster performance and stability. 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.
   root@sys Password	You can click Randomly generated to generate a random password or enter a custom password. 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. Supported special characters are ~!@#%^&*_-+=|(){}[]:;,.?/. You can click copy password to copy the password and save it.
   Data Directory	By default, the data directory is in the software path configured on the Node Configuration page. The data directory must be an absolute path beginning with a forward slash (/). You can change the data directory. Make sure that the specified directory is empty.
   Log Directory	By default, the log directory is in the software path configured on the Node Configuration page. The log directory must be an absolute path beginning with a forward slash (/). You can change the log directory. Make sure that the specified directory is empty.
   SQL Port	The SQL port number. The default value is 2881. You can specify a custom port number ranging from 1025 to 65535. Make sure that the specified port is not occupied.
   RPC Port	The port number used for the remote access protocol. The default value is 2882. You can specify a custom port number ranging from 1025 to 65535. Make sure that the specified port is not occupied.
   OBShell Port	OceanBase Database maintenance port. The default is 2886, but you can customize it (only supports the range 1025~65535). Ensure that the specified port is not in use.
   More Configurations	You can enable More Configurations to view more cluster parameters. You can retain the default settings or modify the settings. Note After you enable More Configurations, you can configure the scenario parameter to specify a load type for the cluster. The default value of this parameter is htap.

2. Component configuration

   Parameter	Description
   Grafana Password	The login password of the Grafana administrator account. You can click Randomly generated to let obd generate a random string, or you can set a custom password. When you set a custom password, it must meet the following requirements: It must be 8 to 32 characters long. It must contain at least two of the following four types of characters: digits (0~9), uppercase letters (A~Z), lowercase letters (a~z), and special characters (~!@#%^&*_-+=|(){}[]:;,.?/`$"<>\). After you configure the password, you can click Copy Password to copy it and save the configured password.
   Prometheus Password	The login password of the Prometheus service. You can click Randomly generated to let obd generate a random string, or you can set a custom password. When you set a custom password, it must meet the following requirements: It must be 8 to 32 characters long. It must contain at least two of the following four types of characters: digits (0~9), uppercase letters (A~Z), lowercase letters (a~z), and special characters (~!@#%^&*_-+=|(){}[]:;,.?/`$"<>\). After you configure the password, you can click Copy Password to copy it and save the configured password.
   AlertManager Password	The login password of the Alertmanager service. You can click Randomly generated to let obd generate a random string, or you can set a custom password. When you set a custom password, it must meet the following requirements: It must be 8 to 32 characters long. It must contain at least two of the following four types of characters: digits (0~9), uppercase letters (A~Z), lowercase letters (a~z), and special characters (~!@#%^&*_-+=|(){}[]:;,.?/`$"<>\). After you configure the password, you can click Copy Password to copy it and save the configured password.
   OBProxy SQL Port	The ODP listening port. By default, it is set to 2883. You can specify a custom port number (1025 to 65535). The specified port must be available.
   OBProxy Exporter Port	The Exporter port of OBProxy, which is used for Prometheus to pull OBProxy monitoring data. By default, it is set to 2884. You can specify a custom port number (1025 to 65535). The specified port must be available.
   OBProxy RPC Port	By default, it is set to 2885. You can specify a custom port number (1025 to 65535). The specified port must be available.
   OBAgent Monitoring Service Port	By default, it is set to 8088. You can specify a custom port number (1025 to 65535). The specified port must be available.
   OBAgent Management Service Port	By default, it is set to 8089. You can specify a custom port number (1025 to 65535). The specified port must be available.
   obconfigserver Service Port	The port number of the obconfigserver service. By default, it is set to 8080. You can specify a custom port number (1025 to 65535). The specified port must be available.
   Prometheus Service Port	The port on which the Prometheus service listens. The default value is 9090. You can set a value in the range of 1025 to 65535. Make sure that the port is not occupied.
   Grafana Service Port	The HTTP port used to access the Grafana page. The default value is 3000. You can set a value in the range of 1025 to 65535. Make sure that the port is not occupied.
   AlertManager Service Port	The HTTP port used to access the Alertmanager page. The default value is 9093. You can set a value in the range of 1025 to 65535. Make sure that the port is not occupied.
   More Configurations	You can click the expand icon before More Settings to view and configure the parameters of the component. You can use the automatically allocated values or customize the parameters. Note If multiple nodes are configured in obconfigserver node of Node configuration, you must configure vip_address and vip_port in More configurations. Otherwise, an error will be reported during precheck.

After all parameters are configured, click Next Step to go to the Pre-check page.

Step 5: Precheck

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 the pre-check reports an error, and the error can be automatically fixed, you can click Automatic Repair to fix the error. You can also click Learn More to fix the reported error by referring to the error code document. After all the errors are fixed, click Re-check to perform a pre-check again.

After the precheck passes, click Deploy to deploy OceanBase Database.

Step 6: Deploy

Here:

• After deployment, copy the displayed connection string and connect to the corresponding component. In the terminal, the connection string executed after OceanBase Database is connected to the OceanBase cluster as the root@sys user. The connection string executed after OBProxy is connected to ODP as the root@proxysys user.

• You can click the connection strings of the output Prometheus, Grafana, AlertManager, and OB-Dashboard components to jump to the login interfaces of these components. You can log in by using the account and password displayed on the deployment page.

  Note

  In Alibaba Cloud or other cloud environments, if the public IP cannot be retrieved, the private IP is returned, which is not the public IP. You must access the GUI by using the correct IP address.

• In the Deployment Report tab, click the icon next to a component to view the deployment logs. In the list of a component, click View Details. Then, click the icon to copy the command. In the central control node, you can run the command to view the log location of the component.

• Click Copy Information to copy the account and password of the OceanBase cluster. You can click Leave to exit the deployment program or click Create Business Tenant to create a business tenant in graphical mode.

(Optional) Step 7: Create a business tenant

After the OceanBase cluster is deployed, click Create Business Tenant in the lower-right corner of the deployment success page to enter the business tenant creation process. You can configure the tenant information based on the following table.

After you configure the parameters, click Next: Create Business Tenant. The system creates the corresponding tenant. After the tenant is created, the business tenant information, including the tenant name, root user password, and connection string, is displayed on the page. Click Leave in the lower-left corner to exit the tenant creation process. After you exit the tenant creation process, you can click Leave on the deployment result page to exit the deployment process, or you can click Create Business Tenant to create another business tenant.

Related operations

Manage a cluster after deployment

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 a cluster. In this example, the cluster name is myoceanbase.
[admin@test001 ~]$ obd cluster display myoceanbase

# Stop a running cluster. In this example, the cluster name is myoceanbase.
[admin@test001 ~]$ obd cluster stop myoceanbase

# Destroy a deployed cluster. In this example, the cluster name is myoceanbase.
[admin@test001 ~]$ obd cluster destroy myoceanbase

Deploy a specific component

When you deploy OceanBase All in One, the package is based on the OceanBase Database version. If other components in the package have newer versions, you can download the latest versions of these components from OceanBase Download Center, upload them to the local image repository, and obd automatically retrieves the latest versions from the local image repository during deployment. Follow these steps:

1. Go to the directory where the component installation package is stored and add the installation package 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