Deploy OCP through the GUI

This topic uses the creation of a new OceanBase cluster as an example to demonstrate how to deploy OceanBase Cloud Platform (OCP) using the obd graphic user interface (GUI).

Terms

• OceanBase Database

  A fully self-developed enterprise-grade native distributed database. For more information, see OceanBase Database Documentation.

• obd

  OceanBase Deployer, an installation and deployment tool for OceanBase Database. For more information, see obd Documentation.

• ODP

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

• OCP

  OceanBase Cloud Platform. For more information, see OCP Documentation.

• MetaDB

  An important component of OCP. MetaDB provides underlying storage capabilities for managing metadata and monitoring data in OCP. OCP-Server provides full lifecycle management services for OceanBase Database by calling the data stored in MetaDB.

Prerequisites

• The user used for deployment must have the permission to execute sudo commands without using the password.

• You have installed OceanBase Deployer (obd) V2.4.0 or later (latest version recommended). For more information, see Install obd.

• The user and server resources for OCP deployment meet the requirements. For more information, see Installation planning.

• You have installed the clockdiff command.

• Your server can connect to the Internet, or the local image repository of obd contains the installation packages required for deployment.

  You can run the obd mirror list local command to query the installation packages in the local image repository. If obd is installed by using the OceanBase All in One package, the local image repository contains all installation packages required for deployment by default.

• The OCP MetaDB version must be V4.2.1.8. If you use a new OceanBase database as OCP MetaDB, make sure that the image repository of obd contains the software package of OceanBase Database V4.2.1.8. If you use an existing OceanBase database as OCP MetaDB, no special requirements are raised for the OceanBase database version. We recommend that you use OceanBase Database V4.2.1.8.

Procedure

Step 1: Start the GUI

1. Run the obd web command to start the obd GUI, and click the returned IP 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 default port in the IP address 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 the IP address 0.0.0.0. In a multi-network card deployment, you can access the GUI using any accessible IP address.

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. click Try Now, On the displayed Welcome to the OceanBase Deployment Wizard page, click OCP, and then click OK in the lower right part of the page.

4. On the displayed Welcome to the OCP Deployment Wizard page, select a MetaDB configuration method (Create a new OceanBase database (MetaDB as OCP) is used as an example here), and then click OK in the lower right part of the page to start the deployment. For more information, see the Deploy OCP on the GUI in the OCP documentation.

   The Deployment Wizard page is displayed, with the deployment progress tracker dashboard appearing in the upper part of the page.

Step 2: Set deployment parameters

This step corresponds to the Deployment configuration phase in the deployment progress tracker dashboard.

1. In the Basic configuration section, specify the Cluster name.

2. In the Version selection section, select the OCP version and OceanBase version, as shown in the following figure.

   

   Parameter	Description
   Cluster name	The unique name of cluster to deploy, which can be customized. The cluster name must start with a letter and end with a letter or a digit. It can contain letters, digits, and underscores (_), and is between 2 and 32 characters in length. You can run the obd cluster list command to view the clusters managed in obd.
   Version selection	Click the Version drop-down list to select the version of OCP. By default, the OceanBase Database version is V4.2.1.8 and cannot be modified, and the ODP version is the latest version in the image repository and cannot be modified. You can click Learn More in the row of a component to view its documentation.

3. Click Next Step in the lower right part of the page.

Step 3: Set MetaDB parameters

This step corresponds to the MetaDB configuration phase in the deployment progress tracker dashboard.

1. Deploy user configuration.

   In the Deploy user configuration section, specify the user information required for OCP deployment, as shown in the following figure.

   

   Note

   To avoid conflicts between operating system (OS) users, it is recommended to use separate OS users for MetaDB and OCP.

   Parameter	Description
   Username	The username of the OS user required for automatic configuration by the installation program. The configured user must have the permission to execute sudo commands without a password.
   Password (optional)	The password corresponding to the username. If passwordless login has been configured for the user, you can skip this parameter.
   SSH Port	By default, it is set to port 22, and it supports custom ports.
   Use the running user	If you select this option, an input box for Running username will appear, allowing you to configure a separate OS user for OCP.

2. Set node parameters.

   Specify the IP address of the OCP host in the OCP node configuration section and specify the IP addresses of the OBServer nodes where MetaDB is located in the Database node configuration section, as shown in the following figure.

   

   Parameter	Description
   Select host	The IP address of the host where OCP is deployed. OCP can be deployed on multiple hosts. Warning The IP address of the host cannot be set to 127.0.0.1.
   Zone name	The name of a zone in MetaDB, which can be customized. The zone name must start with a letter and end with a letter or a digit. It can contain letters, digits, and underscores (_), and is between 2 and 32 characters in length. Note For an OceanBase cluster with multiple zones, there must be one zone that shares the same region as the primary zone. You can click + Add Zone to add a new zone or click the delete icon next to the corresponding zone to remove the zone.
   OBServer nodes	The IP address of an OBServer node in MetaDB. After specifying the IP address of an OBServer node, you can press Enter on the keyboard to configure multiple OBServer node IP addresses.
   RootServer nodes	The IP address of the RootServer node in MetaDB. You can select one IP address from the configured OBServer node IP addresses using the RootServer nodes drop-down list as the IP address of the RootServer node in MetaDB. Note For an OceanBase cluster with multiple replicas, a RootServer node must be specified for each zone.

3. Set cluster parameters.

   In the Cluster configuration section, set cluster parameters, as shown in the following figure.

   

   Parameter	Description
   root@sys password	Enter a custom password or click Randomly generated to generate a random 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. Special characters are ~!@#%^&*_-+=|(){}[]:;,.?/
   Software Installation Path	The installation path for MetaDB, which is by default the oceanbase directory in the home directory of the user who performs the deployment. You can specify a custom path, but you must have the read and write permissions for the corresponding directory.
   Data path	The data storage path for MetaDB, which must be an absolute path starting with a forward slash (/). You can specify a custom path, but you must have the read and write permissions for the corresponding directory and ensure that the directory is empty.
   Log path	The log storage path for MetaDB, which must be an absolute path starting with a forward slash (/). You can specify a custom path, but you must have the read and write permissions for the corresponding directory and ensure that the directory is empty.
   SQL Port	The SQL port number, which is port 2881 by default. You can specify a custom port number ranging from 1024 to 65535. Make sure that the specified port is not already in use.
   RPC Port	The RPC port number, which is port 2882 by default. You can specify a custom port number ranging from 1024 to 65535. Make sure that the specified port is not already in use.
   More configurations	Optional. You can click this arrow to view and configure the OceanBase cluster settings. You can use the automatically assigned values or customize each parameter. For more information about OceanBase cluster settings, see Parameters in the OceanBase Database documentation. 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.

   Warning

   Make sure that there is sufficient disk space in the directories where the Software Installation Path, Data path, and Log path are located. Otherwise, the deployment will fail.

4. Set OBProxy parameters.

   In the OBProxy configuration section, set OBProxy parameters, as shown in the following figure.

   

   Parameter	Description
   OBProxy nodes	The IP address of the server where OBProxy is deployed. Only one IP address can be configured, which means only single-node OBProxy installation is supported.
   SQL Port	The OBProxy listening port number, which is port 2883 by default. You can specify a custom port number ranging from 1024 to 65535. Make sure that the specified port is not already in use.
   Port Exporter	The OBProxy Prometheus listening port number, which is port 2884 by default. You can specify a custom port number ranging from 1024 to 65535. Make sure that the specified port is not already in use.
   Software path	The installation path for OBProxy, which is by default the obproxy directory in the home directory of the user who performs the deployment. You can specify a custom path, but you must have the read and write permissions for the corresponding directory.
   More configurations	Optional. You can click this arrow to view and configure the OBProxy settings. You can use the automatically assigned values or customize each parameter.

5. Click Next Step in the lower right part of the page.

Step 4: Set OCP parameters

This step corresponds to the OCP configuration phase in the deployment progress tracker dashboard.

1. Deploy service configuration.

   In the Service configuration section, specify the required parameters, as shown in the following figure.

   

   Parameter	Description
   Admin password	The password of the administrator account of OCP. You can enter a custom password or click Randomly generated to generate a random 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. Special characters are ~^*{}[]_-+ To copy the password, click Copy Password. Note Only OCP V4.2.2 and later verify passwords against the preceding complexity requirements. In OCP of a version earlier than V4.2.2, the password complexity requirements are as follows: It must be 8 to 32 characters in length. It must contain at least two uppercase letters, two lowercase letters, two digits, and two special characters. Supported special characters are ~^*{}[]_-+
   Software path	The path where OCP stores software packages of components, such as ODP and OBAgent. The default package path is the software directory created in the home directory of the deployment user. You can modify the package path. You must have the read and write privileges on the specified directory. Note If the local repository contains installation packages of OceanBase Database and ODP, obd automatically recognizes and uploads the latest installation packages to the specified directory.
   Log path	The log storage path for OCP, which is by default the logs directory in the home directory of the user who performs the deployment. You can specify a custom path, but you must have the read and write permissions for the corresponding directory.
   Package path	The software package (for example, OBProxy and OBAgent) storage path for OCP, which is by default the software directory in the home directory of the user who performs the deployment. You can specify a custom path, but you must have the read and write permissions for the corresponding directory.
   ocp.site.url	The web URL of OCP for external access. The URL must start with http or https and not end with a slash (/). The URL consists of the VIP or domain name and the port number, for example, http://localhost:8080. After you enter the URL, click Verify to test whether the URL format is correct. If the verification succeeds, the message "The current verification is successful. Proceed to the next step." is displayed under the text box of the URL. If the verification fails, modify and re-verify the URL as prompted.
   Service Port	The listening port for OCP. By default, it is set to port 8080, and it supports custom ports.

2. Plan resources.

   During the operation of OCP service, there will be computing and storage resource overhead. You can plan resources in the Resource Planning section based on the scale of the objects to be managed, including OCP service, MetaDB, and MonitorDB, as shown in the following figure.

   

   Note

   The server deployment for OCP needs to adhere to the installation planning requirements of OCP. For details about OCP installation planning, see Installation planning in the OCP documentation.

   Section	Parameter	Description
   Resource Planning	Estimated number of management hosts (units)	The number of hosts planned to be managed by OCP. By default, less than 10 hosts are managed, which can be modified according to the actual situation.
   Resource configuration	OCP application memory (GiB)	The size of memory resources allocated to OCP-Server, which is 4 GiB by default. The configuration of memory resources is related to the number of hosts managed by OCP. For more information, see Host planning in the OCP documentation.
   Metadata tenant configuration	Tenant name	The name of the metadata tenant. By default, it is set to ocp_meta, and it supports custom tenant names.
   	Password	The root user password for the metadata tenant. You can enter a custom password or click Randomly generated to have obd generate a random string. The password must meet the following complexity requirements: It must be 8 to 32 characters in length. It must include at least two uppercase letters, two lowercase letters, two digits, and two special characters. The supported special characters are ~!@#%^&*_-+=`\|(){}[]:;',.?/ To copy the root user password for the metadata tenant, click Copy password.
   	CPU (VCPUS)	The number of CPU cores allocated to the metadata tenant, which is 2 vCPUs by default. It can be modified according to the actual situation.
   	Memory (GiB)	The size of memory allocated to the metadata tenant, which is 4 GiB by default. It can be modified according to the actual situation.
   Monitor data tenant configuration	Tenant name	The name of the monitor data tenant. By default, it is set to ocp_monitor, and it supports custom tenant names.
   	Password	The root user password for the monitor data tenant. You can enter a custom password or click Randomly generated to have obd generate a random string. The password must meet the following complexity requirements: It must be 8 to 32 characters in length. It must include at least two uppercase letters, two lowercase letters, two digits, and two special characters. The supported special characters are ~!@#%^&*_-+=`\|(){}[]:;',.?/ To copy the root user password for the monitor data tenant, click Copy password.
   	CPU (VCPUS)	The number of CPU cores allocated to the monitor data tenant, which is 2 vCPUs by default. It can be modified according to the actual situation.
   	Memory (GiB)	The size of memory allocated to the monitor data tenant, which is 8 GiB by default. It can be modified according to the actual situation.

3. Click Next Step in the lower right part of the page.

Step 5: Perform a pre-check

This step corresponds to the Pre-Check phase in the deployment progress tracker dashboard.

1. In the Pre-Check section, you can view all the configuration information.

   • If there are any issues, you can click Previous step to address them.

   • If there are no issues, click Pre-Check to initiate the pre-check process. Then, the system will verify whether your environment meets the requirements for installing and configuring MetaDB and OCP.

     If any errors are reported during the pre-check, you have two options. You can click Automatic Repair to automatically fix the issues for items that can be automatically repaired. Alternatively, you can click Learn more next to each error to access the error code documentation. The documentation will guide you on making the necessary modifications based on the provided references. After making all the required modifications, you can perform the pre-check again by clicking Re-check.

   

2. After the pre-check is successful, click Deployment in the lower right part of the page.

Step 6: Deploy OCP

This step corresponds to the Deployment phase in the deployment progress tracker dashboard.

During the deployment process, the deployment logs will be displayed in the Deployment log section on the page.

• If the deployment fails, view the log information to identify the cause of the failure. Contact OceanBase Technical Support for assistance or submit a question in the Q&A section on the OceanBase official website. Professional personnel will be available to help resolve the issue. Once you have identified and fixed the cause of the installation failure, click Re-deploy. In the confirmation window that appears, click OK. The system will clean up the current failed OCP installation environment and restart the installation process.

• If the deployment is successful, you can click Copy information to save the OCP access address and account information. After copying and saving this information, click complete to exit the deployment program.

References

• Cluster commands

• Upgrade OCP on the GUI