Create an ODP cluster

An OceanBase cluster is created when you deploy OceanBase Database. If you want to add multiple 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 the OCP User Guide.

Procedure

1. Log on to the OCP console.

2. In the left-side navigation pane, click OBProxy to go to the ODP 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. Set related parameters to specify the basic information.

      Parameter	Description
      Cluster Name	The name of the cluster. The cluster name can contain letters, digits, and underscores (_), and must be unique and start with a letter.
      Access URL	The URL of the ODP cluster. For a virtual IP (VIP) address, you must apply for the VIP and bind it to the ODP server.
      Access Port Number	The access port. The default port is 2883. You must specify the actual port based on the VIP.
      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 only access the OceanBase cluster specified when the ODP cluster is created. After an ODP cluster is created, no more connectable OceanBase clusters can be added.
      Accessible OceanBase Clusters	The OceanBase clusters that are accessible to the ODP 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. For more information, see OCP User Guide.

   2. Optional. Set parameters on the Deploy OBProxy page.

      If you want to deploy an ODP when you create an ODP cluster, specify the fields described in this step. Otherwise, you can skip this step. After the cluster is created, you can add ODPs to the cluster by taking over ODPs or adding ODPs.

      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 the ODP RPM to install.
         Fields about ODP hosts	Configure the host where ODP is deployed by specifying the following information: IDC, host type (optional), and host IP address.

         By default, fields for two hosts are displayed.

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

         • If you need to deploy only one ODP host, click the Delete icon next to the Host field to delete the host.

   3. Enable Parameter Settings, and add or modify the startup parameters and other parameters.For more information about startup parameters, see ODP startup parameters.

   For more information about other parameters, see Parameters.

5. Click Submit.