Quickly deploy OCP

Prerequisites

Before you start, make sure that you meet the following conditions:

• You have installed obd V2.4.0 or a later version. We recommend that you install the latest version. For more information, see Install obd.

  Note

  We recommend that you install OceanBase All in One, which contains all the components required for deployment (except the obbinlog component). The components have been tested for compatibility and are recommended by OceanBase.

• If you deploy an OceanBase cluster as MetaDB, make sure that the OBServer node supports the AVX instruction set (this applies only to servers with the x86 architecture). You can run the lscpu | grep Flags | grep avx command to check whether the AVX instruction set is supported.

  Note

  If you use a server with the x86 architecture, the AVX instruction set is not required for the following OceanBase Database versions:

  • V4.2.5.6 and later for V4.2.x.
  • V4.3.5.4 and later for V4.3.x.
  • V4.4.1.0 and later for V4.4.x.

• If you deploy an OceanBase cluster as MetaDB in an offline scenario and use a server with the ARM architecture, make sure that the OBServer node supports the LSE instruction set. You can run the lscpu | grep Flags | grep atomics command to check whether the LSE instruction set is supported. If the server does not support the LSE instruction set, download the OceanBase Database installation package with the nonlse option and use the obd mirror clone command to upload the package to the local image library of obd.

  Note

  The OceanBase Database installation package with the nonlse option is not included in OceanBase All in One.

• The server has at least 8 vCPUs, 26 GB of memory, and 150 GB of disk space. Note that the memory requirement refers to the value in the available column of the output obtained by running the free -g command.

• The deployment process will use the 2881, 2882, 2883, 2884, 2886, 8080, and 8680 ports. Make sure that these ports are not occupied.

• The server where you deploy OCP has the clockdiff command installed.

• The server can connect to the Internet, or the local image library of obd contains the required installation packages.

  You can run the obd mirror list local command to view the installation packages in the local image library. If you installed obd by using OceanBase All in One, all the required installation packages are included in the local image library by default.

Step 1: Start the GUI

1. Run the obd web command to start the GUI. Click the displayed address to access the GUI of obd.

   [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 use the obd web -p <PORT> command to specify a port. The port must be in the range [1025, 65535].

   • If you deploy OCP in Alibaba Cloud or another cloud environment, the public IP address may not be obtained, and the private IP address may be displayed. In this case, you need to use the correct address to access the GUI.

   • The obd web command binds to 0.0.0.0. In a multi-NIC deployment, you can access the GUI through any accessible IP address.

2. In the GUI, click Start Your Trial. In the Welcome to OceanBase Deployment Wizard window, select the OceanBase Cloud Platform module. Move the cursor over the Install button and select Install a New OceanBase Database. Then, the Welcome to OCP Deployment Wizard window appears.

Step 2: Configure deployment

The Configure Deployment window displays the following information. You can specify the cluster name for OCP. The cluster name must be unique. You can run the obd cluster list command to view the clusters managed by obd.

Step 3: Configure MetaDB

You can configure the information of the MetaDB cluster on the MetaDB Configuration page, such as the IP address, port, directory, and password of the OBServer node. This section will introduce each configuration in detail.

1. Deployment user configuration

   The Deployment User Configuration module is used to configure the information of the user for deploying OCP. The interface is shown in the following figure. You only need to configure Username and Password. The configured username must have the permission to execute sudo commands without a password. If you have configured password-free login, you can skip entering the password.

2. Node configuration

   You can configure the IP address of the host where OCP is located on the OCP Node Configuration tab, and configure the IP address of the OBServer node where MetaDB is located on the Database Node Configuration tab. The interface is shown in the following figure.

   You need to configure the IP addresses of OCP and MetaDB on the page. We recommend that you use an IP address other than 127.0.0.1. After you enter an IP address, you can press the Enter key to configure multiple IP addresses. By default, the page displays three zones. You can click + Add Zone or the delete icon next to a zone to add or delete a zone.

3. Cluster configuration

   You can configure the root@sys password, directory, and port of the MetaDB database on the Cluster Configuration tab. The interface is shown in the following figure.

   You can click Randomly Generate to set the root@sys password to a random string generated by obd. The page provides default paths, and you can customize the paths. The paths must be absolute paths starting with /, and the directories must be empty and have read and write permissions.

4. OBProxy configuration

   The OBProxy Configuration module is used to configure the node, port, and path of OBProxy. The interface is shown in the following figure. You can configure only one IP address for the OBProxy Node. By default, the obproxy directory is created in the home directory of the deployment user to serve as the software path of OBProxy. You can customize the path, which must be an absolute path starting with /, and you must have read and write permissions for the directory.

After you complete all the configurations, click Next to go to the OCP Configuration page.

Step 4: Configure OCP

You can configure the information of the OCP service and tenants on the OCP Configuration page. This section will introduce each configuration in detail.

1. Service configuration

   You can configure the login password, path, URL, and port of OCP on the Service Configuration tab. The interface is shown in the following figure. You can click Randomly Generate to set the Admin password to a random string generated by obd. The page provides default paths, and you can customize the paths. The paths must be absolute paths starting with /, and the directories must be empty and have read and write permissions.

2. Resource planning

   OCP consumes computing and storage resources during operation. You can plan resources based on the scale of the objects to be managed on the Resource Planning tab. The interface is shown in the following figure.

   You can click Randomly Generate to set the root passwords of all tenants to random strings generated by obd.

After you complete all the configurations, click Next to go to the Precheck page.

Step 5: Precheck

You can view all the configuration information on the Precheck page. If you find any issues, you can click Previous to modify them. After you confirm that no issues are found, you can click Precheck to start the precheck. The system will verify whether your environment meets all the requirements for installing and configuring MetaDB and OCP.

If the precheck fails, you can choose Auto Repair (for check items that can be automatically repaired) or click View More Solutions to jump to the error code documentation and modify the issues based on the documentation. After you modify all the errors, you can click Recheck to perform the precheck again.

After the precheck passes, you can click Next to go to the Deployment page and start deploying OCP.

Step 6: Deployment

During the deployment, the Deployment page will output the deployment logs. You can view the detailed installation logs in the Deployment Logs section.

• If the deployment fails, please check the log information to find the cause of the failure, or contact technical support. A professional will help you solve the issue. After you locate the cause of the installation failure and fix the issue, click Redeploy. In the confirmation window that appears, click OK. The system will clean up the failed OCP installation environment and re-execute the installation program.

• If the deployment succeeds, you can click Copy Information. After you copy and save the access address and account information of OCP, click Complete to exit the deployment program.

References

• Cluster command groups