An OceanBase cluster is created when you deploy OceanBase Database. If you want to add multiple OceanBase Database Proxies (ODPs) and connect the ODPs to the OceanBase cluster, you can create an ODP cluster by using OceanBase Cloud Platform (OCP).
Prerequisites
You have logged on to the OCP console and are assigned the OBPROXY_MANAGER role that has permissions to manage ODPs. If you are not assigned the OBPROXY_MANAGER role, you must obtain the role. For more information, see Edit a user in OCP User Guide.
Procedure
Log on to the OCP console.
In the left-side navigation pane, click OBProxy to go to the ODP page.
In the upper-right corner of the page, click Create OBProxy Cluster.
On the Create OBProxy Cluster page, specify the following information:
Refer to the following table to specify fields in the Basic Information section.
ParameterDescriptionCluster Name You can customize the cluster name. The value must start with a letter and can contain letters, digits, and underscores (_). Enter the password of the proxyro user ODP accesses the OceanBase cluster by using the proxyro user. If you do not enable this parameter, the default password of the proxyro user is used. The password must meet the following requirements: - Range from 8 to 32 characters in length.
- Contain only letters, digits, and special characters. Supported special characters are
~ ! @ # % ^ & * _ - + = | ( ) { } [ ] : ; , . ? / - Contain at least two uppercase letters, two lowercase letters, two digits, and two special characters.
Manage Load Balancer After load balancing management is enabled, you can configure OceanBase Load Balancer (OBLB) to improve the load balancing capability of an ODP cluster. - OBLB Service: You can select the OBLB service configured when OCP is deployed, or click Add OBLB Service and then add the OBLB service on the right-side pane.
- OBLB Service Address: the address of the OBLB service.
- OBLB Service Port: the port of the OBLB service. The default service port is 9090. You can change the service port as needed.
- Username & Password: the username and password of the OBLB service, which are used to get the authentication information about the OBLB interface.
- VIP: the virtual IP address of the OBLB service.
- Access Port: The default access port is 2883. You can change the access port.
- Domain Name Configuration (optional): the configuration that points to the VIP and port. The platform does not provide the mappings between VIPs and domain names. You must configure the domain name resolution service.
Note
The settings of SLB Service in the Manage Load Balancer section apply only to the Apsara Stack environment. We recommend that you contact Technical Support for assistance.
Access URL The access URL of the ODP cluster. This parameter is displayed when Manage Load Balancer is disabled. In this case, you need to manually configure load balancing. The access URL is only used to generate a connection string for the tenant. If the access URL is a VIP, you must apply for the VIP and bind it to the ODP server. Access Port Number The access port number. The default port number is 2883. You must specify the actual port number based on the VIP. This parameter is displayed when you disable Manage Load Balancer. Startup Method The startup method of the ODP cluster. Valid values: - ConfigUrl: specifies the multicluster startup method, where the ODP cluster can access multiple OceanBase clusters.
- RsList: specifies the single cluster startup method, where the ODP cluster can access only the OceanBase cluster specified when the ODP cluster is created. After an ODP cluster is created, no more connectable OceanBase clusters can be added.
Select Accessible OceanBase Clusters The OceanBase clusters that are accessible to the ODP cluster. - This parameter is optional if you set Startup Method to ConfigUrl. After you create an OceanBase cluster, you can select the cluster here. For more information, see Add a connectable OceanBase cluster.
- You must specify the value of this field when Startup Method is RsList. Select the OceanBase cluster from the drop-down list.
- If the password box contains the credentials of the proxyro user of the cluster, the proxyro user is selected by default.
- Otherwise, click Create Connection to create a connection credential for the proxyro user of the cluster.
(Optional) Specify fields in the Deploy OBProxy section.
If you want to deploy the ODP when you create an ODP cluster, perform this step. Otherwise, you can skip this step. After the cluster is created, you can add an ODP to the cluster by taking the following actions: take over an ODP or add an ODP.
Toggle on the switch in the upper-right corner of the Deploy OBProxy page.
Refer to the following table to specify the parameters.
ParameterDescriptionSQL Port Number The default port is 2883. Exporter Port Number The default port is 2884. Software Version Select the version of ODP RPM to install. Note
If an OceanBase cluster V4.0 or later is available in the Accessible OceanBase Clusters section, you can only select an ODP software package of V4.0.0 or later.
IDC, Host Type (Optional), and Host Configure the host where ODP is to be deployed by setting the following parameters: IDC, Host Type (Optional), and Host. By default, fields for two ODPs are displayed.
To deploy more ODPs, click Add OBProxy to add an ODP.
If you need to deploy only one ODP, click the Delete icon to the right of an ODP to delete it.
Enable Parameter Settings to add or modify startup parameters and other parameters. For more information, see ODP startup parameters.
Click Submit.
Note
When ODP is installed, the system checks whether the permissions on the installation directory are correct. The system checks the read and execution permissions of a specified user (the admin user by default) on folders at each level of the
/home/admin/logs/obproxydirectory. If the user does not have the required permissions, the "check directory xxx permission failed, reason: xxx" error is generated in the log.