Create an OBProxy cluster

You can create an OBProxy cluster and enter the basic information, deployment mode, and advanced settings. Then, you can add OBProxy instances to the cluster and connect to OceanBase clusters.

Prerequisite

You have the OBPROXY_MANAGER role or the permissions to manage OBProxy.

Procedure

1. Log on to the OceanBase Cloud Platform (OCP) console.

2. In the left-side navigation pane, click OBProxy to go to the OBProxy page.

3. In the upper-right corner of the page, click Create OBProxy Cluster .

4. On the Create OBProxy Cluster page, specify the following information:

   1. Refer to the following table to specify Basic Information .

      Parameter	Description
      Cluster Name	You can customize the cluster name. The value must start with a letter and can contain letters, digits, and underscores (_).
      Access URL	The URL of the OBProxy cluster. For a virtual IP (VIP) address, you apply for the VIP and bind it to the OBProxy server.
      Access Port Number	The default port is 2883. You must enter the actual port number.
      Startup Method	The startup method of the OBProxy cluster. Valid values: ConfigUrl: specifies the multi-cluster startup method, where the OBProxy cluster can access multiple OceanBase clusters. RsList: specifies the single cluster startup method, where the OBProxy cluster can only access the OceanBase cluster specified when the OBProxy cluster is created. After an OBProxy cluster is created, no more connectable OceanBase clusters can be added.
      Connectable OceanBase Cluster	Specifies OceanBase clusters that are accessible to the OBProxy cluster. This field is optional when Startup Method is ConfigUrl. After the cluster is created, you can click Add Connectable OceanBase Cluster to add more OceanBase clusters. 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.

      

   2. (Optional) Configure fields of the Deploy OBProxy page.

      You can deploy OBProxy when creating an OBProxy cluster. Otherwise, you can skip this step. After the cluster is created, you can add OBProxy to the cluster by taking the following actions: Take over OBProxy or Add OBProxy.

      1. Toggle on the switch in the upper-right corner of the Deploy OBProxy page.

      2. Refer to the following table to specify the fields.

         Parameter	Description
         SQL Port Number	The default port is 2883.
         Exporter Port Number	The default port is 2884.
         Software Version	Select the version of OBProxy RPM to install.
         Fields about OBProxy Hosts	Configure the host where OBProxy is deployed by specifying the following fields: IDC, Host Type (Optional), Selection Method, and Host IP Address.

         

         • To deploy more hosts, click Add OBProxy to add a host.

         • If you need to deploy only one OBProxy host, click the delete icon next to the Host IP Address field to delete the host.

   3. Enable Advanced Settings to add or modify startup parameters and other parameters. For more information, see OBProxy parameters.

      

5. Click Submit .