---
title: "创建 OBProxy 集群 - OceanBase 数据库 V4.0.0-preview | OceanBase 文档中心"
description: 创建 OBProxy 集群 通常在部署 OceanBase 数据库时已创建 OBProxy 集群，如果需要添加多个新的 OBProxy 与 OceanBase 集群连接，您可以通过 OCP 或者 OBD 来创建 OBProxy 集群，下面介绍如何通过 OCP 或 OBD 创建 OBProxy 集群。 通过 OCP 创…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*P8CuR4UJ_FkAAAAAAAAAAAAADiGDAQ/original) OceanBase 数据库分布式版 - V 4.0.0-preview

# 创建 OBProxy 集群

更新时间：2023-09-05 11:41:30

[编辑](https://github.com/oceanbase/oceanbase-doc/edit/V4.0.0-preview/zh-CN/700.reference/200.administrator-guide/100.database-connection-and-routing/200.obproxy-management/200.manage-obproxy-clusters/100.create-an-obproxy-cluster.md)  

通常在部署 OceanBase 数据库时已创建 OBProxy 集群，如果需要添加多个新的 OBProxy 与 OceanBase 集群连接，您可以通过 OCP 或者 OBD 来创建 OBProxy 集群，下面介绍如何通过 OCP 或 OBD 创建 OBProxy 集群。

## 通过 OCP 创建 OBProxy 集群

### 前提条件

当前登录的用户是 OBPROXY_MANAGER 角色，具有管理 OBProxy 的权限。如果当前用户不具备 OBPROXY_MANAGER 角色，需要先为用户添加该角色，具体操作请参见《OCP 用户指南》中的 [编辑用户](https://www.oceanbase.com/docs/enterprise-oceanbase-ocp-cn-10000000001542001)。

### 操作步骤

1. 登录 OCP。
 2. 在左侧导航栏单击 **OBProxy**，进入 OBProxy 页面。
 3. 单击右上方的 **创建 OBProxy 集群**。
 4. 在 **创建 OBProxy 集群** 页面填写如下信息：

      1. 参考下表，配置 **基本信息**。

        | 参数 | 说明 |
        | --- | --- |
        | 集群名 | 您可根据实际业务情况，自定义集群名称，以英文字母开头，可包含英文、数字和下划线，且不能与已有的集群重名。 |
        | 访问地址 | OBProxy 集群访问地址。如果是 vip 地址，需要用户申请完成，并绑定到 OBProxy Server。 |
        | 访问端口 | 默认为 2883，需要根据 vip 的真实端口填写。 |
        | 启动方式 | 该 OBProxy 集群的启动方式，可取值：      - ConfigUrl：多集群启动方式，即该 OBProxy 集群可访问多个 OceanBase 集群。     - RsList：单集群启动方式，即该 OBProxy 集群仅可访问创建 OBProxy 集群时指定的那个 OceanBase 集群，OBProxy 集群创建成功后不可追加可连接的 OceanBase 集群。 |
        | 可连接的 OB 集群 | 设置该 OBProxy 集群可访问的 OceanBase 集群。      - 当 **启动方式** 配置为 ConfigUrl 时，该参数非必填，集群创建成功后，可通过 [添加可连接的 OB 集群](https://www.oceanbase.com/docs/common-oceanbase-database-cn-10000000001581019) 添加。     - 当 **启动方式** 配置为 RsList 时，该参数必填。 在下拉框中选择对应的集群。              - 当密码箱中存在该集群 proxyro 用户的连接凭证时，会默认选择 proxyro 用户。             - 密码箱中不存在该集群 proxyro 用户的连接凭证时，请单击 **新建连接**，为该集群的 proxyro 用户创建连接凭证。具体操作请参见对应版本的 [OCP 用户指南](https://www.oceanbase.com/docs/enterprise-oceanbase-ocp-cn-10000000001540037)。 |

        ![08261923](https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN/2334601361/p312780.png)
      2. （可选）配置 **部署 OBProxy**。

        如需在创建 OBProxy 集群时就部署 OBProxy，可在该步骤进行配置。否则可跳过该步骤，待集群创建成功后，通过 [接管 OBProxy](https://www.oceanbase.com/docs/enterprise-oceanbase-ocp-cn-10000000001542111) 或 [添加 OBProxy](https://www.oceanbase.com/docs/common-oceanbase-database-cn-10000000001581021) 向集群中添加 OBProxy。

        操作步骤如下：

             1. 打开配置 **部署 OBProxy** 的开关。
             2. 参考下表填写部署信息。

               | 参数 | 说明 |
               | --- | --- |
               | SQL 端口 | 默认为 2883。 |
               | Exporter 端口 | 默认为 2884。 |
               | 软件版本 | 选择要安装的 OBProxy 版本。 |
               | 选择 OBProxy 主机 | 选择部署 OBProxy 所使用的主机，包括该主机的 机房、机型（可选）、机器选择方式、主机 IP。 |

               ![08261945](https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN/2334601361/p312784.png)

               系统默认显示两个主机的选择，仅够部署两个 OBProxy，

                      - 如需部署更多，可单击 **添加 OBProxy** 来增加主机。
                      - 如只部署 1 个 OBProxy，可单击如上图所示的主机后的删除图标来删除该主机。
      3. 打开 **参数设置**，添加或修改启动参数和其它参数。

        有关其他参数的详细信息，请参见 [配置参数](https://www.oceanbase.com/docs/enterprise-odp-enterprise-cn-10000000000982784)。有关启动参数的详细信息，请参见 [OBProxy 参数说明](https://www.oceanbase.com/docs/common-oceanbase-database-cn-10000000001576890)。

        ![4](https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/doc/img/ocp/400ce/obproxy%E5%8F%82%E6%95%B0%E8%AE%BE%E7%BD%AE1.png)
 5. 单击 **提交** ，开始创建 OBProxy 集群。

## 通过 OBD 创建 OBProxy 集群

#### 适用性说明

目前仅社区版 OceanBase 数据库可以通过 OBD 创建 OBProxy 集群。

### 前提条件

- 请确保您的机器可以连接公网。
 - 您已部署可供 OBProxy 连接的 OceanBase 集群，并且该集群 sys 租户下存在 proxyro 用户。

#### 说明

OBProxy 需要跟后端 OBServer 节点保持通信，所以需要提前在 OceanBase 集群的 sys 租户下为 OBProxy 创建连接用户（proxyro）和密码。  
使用 OBD 部署 OceanBase 集群时，在配置文件中配置 `proxyro_password` 参数后，部署的 OceanBase 集群中会默认在 sys 租户下创建 proxyro 用户。

### 操作步骤

1. 从 [GitHub](https://github.com/oceanbase/obdeploy/blob/master/example/obproxy/obproxy-only-example.yaml) 上下载对应的配置文件模板。
 2. 根据自身机器情况修改配置文件，配置文件各个模块的含义可参考 [配置文件说明](https://open.oceanbase.com/docs/obd-cn/V1.3.3/10000000000182168)。

   #### 注意

   您需在 `rs_list` 配置项中按要求填写该 OBProxy 集群可访问的 OceanBase 集群 IP 和 mysql_port 端口。  
   `observer_sys_password` 配置项需和部署 OceanBase 集群时配置的 `proxyro_password` 一致。
 3. 执行如下命令部署集群：

   ```bash
   obd cluster deploy <deploy_name> -c <deploy_config_path>

   ```

   其中，参数 `deploy_name` 为部署集群名称，可以理解为配置文件的别名，`deploy_config_path` 为配置文件名。

   在您执行了 `obd cluster deploy` 命令之后，OBD 将检查您的目标机器是否有 OBProxy 安装包。如果没有安装包，OBD 将自动从 yum 源获取。
 4. 运行如下命令启动集群：

   ```bash
   obd cluster start <deploy_name>

   ```
 5. 运行如下命令查看集群状态：

   ```bash
   obd cluster display <deploy_name>

   ```

   出现如下结果即表示集群创建成功：

   ```sql
   Get local repositories and plugins ok
   Open ssh connection ok
   Cluster status check ok
   Connect to obproxy ok
   +-------------------------------------------------+
   |        obproxy        |
   +---------------+------+-----------------+--------+
   | ip            | port | prometheus_port | status |
   +---------------+------+-----------------+--------+
   | xxx.xx.xxx.xx | 2883 | 2884            | active |
   +---------------+------+-----------------+--------+

   ```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线