创建 OBProxy 集群

您可通过填写基本信息、部署模式、高级设置等信息，创建新的 OBProxy 集群，用于添加 OBProxy 或与 OceanBase 集群对接。

前提条件

• 当前登录 OCP 的用户为 ADMIN 角色或 ORG_ADMIN 角色。
• 仅支持 V4.3.0 及以上版本的 OBProxy 配置 RPC 端口。

操作步骤

1. 登录 OCP。

2. 在左侧导航栏单击 OBProxy ，进入 OBProxy 页面。

3. 单击右上方的 创建 OBProxy 集群，进入 创建 OBProxy 集群 页面。

4. 配置 OBProxy 集群的 基本信息 。

   参数	说明
   集群名	您可根据实际业务情况，自定义集群名称，以英文字母开头，可包含英文、数字和下划线。
   软件版本	选择 OBProxy 软件版本。 若列表中有该版本，则从列表中直接选择。 否则，可通过单击列表下方的 添加版本 来上传。 说明 仅可选择 V1.8.0 及以上版本的软件包，从安全角度考虑，建议您选择 V3.1.0 及以上版本的软件包。
   root@proxysys 密码	root@proxysys 账号用于登录 OBProxy 来进行 proxy 本身的参数管理等工作，此处需配置该账号的密码。支持自定义或随机生成。密码需要满足以下复杂度条件： 长度为 8~32 个字符。 至少包含数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符四种类型中的三种，支持的特殊字符为 ~!@#%^&*_-+=|(){}[]:;,.?/。
   录入 proxyro 账号的密码	当 OBProxy 的 软件版本 为 V4.0 以下版本时展示。proxyro 账号用于 OBProxy 访问 OceanBase 集群，未录入则使用 proxyro 账号的默认密码进行连接。密码格式要求如下： 长度为 8~32 个字符。 至少包含数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符四种类型中的三种， 支持的特殊字符为 ~!@#%^&*_-+=|(){}[]:;,.?/。
   负载均衡管理	开启负载均衡管理后，可通过配置 OBLB 来提升 OBProxy 集群的负载均衡能力。 OBLB 服务：您可选择主机上已配置的 OBLB 服务，或单击 添加 OBLB 服务 按钮，在右侧面板中新建 OBLB 服务，详情可参考 管理负载均衡 中的 新建负载均衡。 OBLB 服务地址：OBLB 的服务地址。 OBLB 服务端口：默认为 9090，可根据实际情况进行更改。 用户名及密码：OBLB 服务的用户名及密码，用于调用 OBLB 接口的认证信息。 VIP：选择 OBLB 具体的 VIP 地址。 访问端口：OBLB 的访问端口，默认为 2883，支持自定义端口号。 端口类型：访问端口类型，支持 RPC 和 SQL 两种。 域名配置（可选）：用于指向 VIP 及端口的配置信息，平台未提供 VIP 与域名的映射关系，需自行准备域名解析服务。 备注（可选）：补充额外说明信息。 说明 负载均衡管理 功能仅适用于 OCP 企业版，OCP 社区版暂不支持。 负载均衡管理 中的 阿里云 SLB 仅适用于专有云环境，请联系原厂交付实施人员。 当 OBLB 和 OBProxy 使用相同的主机部署服务时，OBLB 的访问端口不允许与 OBProxy 的 SQL 端口相同，否则应用无法连接数据库。
   访问地址	当 负载均衡管理 关闭时展示，为 OBProxy 集群的访问地址，仅用于生成租户的连接串，不影响实际使用，需要自主配置负载均衡，如果是 VIP 地址，还需要您自主申请并绑定到 OBProxy Server。
   访问端口	当 负载均衡管理 关闭时展示，默认为 2883，需要根据 VIP 的真实端口填写。
   启动方式	该 OBProxy 集群的启动方式，可取值： ConfigUrl：多集群启动方式，即该 OBProxy 集群可访问多个 OceanBase 集群。 RsList：单集群启动方式，即该 OBProxy 集群仅可访问创建 OBProxy 集群时指定的那个 OceanBase 集群，OBProxy 集群创建成功后不可追加可连接的 OceanBase 集群。
   可连接的 OceanBase 集群	设置该 OBProxy 集群可访问的 OceanBase 集群，仅可选择与此 OBProxy 集群网络一致的 OceanBase 集群。 当 启动方式 配置为 ConfigUrl 时，该参数非必填，集群创建成功后，可通过 添加可连接的 OceanBase 集群 添加。 当 启动方式 配置为 RsList 时，该参数必填。 在下拉框中选择对应的集群。 当密码箱中存在该集群 proxyro 用户的连接凭证时，会默认选择 proxyro 用户。 当密码箱中不存在该集群 proxyro 用户的连接凭证时，请单击 新建连接 ，为该集群的 proxyro 用户创建连接凭证。

   

5. （可选）配置 部署 OBProxy 。

   如需在创建 OBProxy 集群时就部署 OBProxy，可在该步骤进行配置。否则可跳过该步骤，待集群创建成功后，通过 接管 OBProxy 或 添加 OBProxy 向集群中添加 OBProxy。

   说明

   当跳过该步骤时，您所创建的 OBProxy 集群将为一个空集群，此时将无法为该 OBProxy 集群 添加可连接 OceanBase 集群。

   1. 打开配置 部署 OBProxy 的开关。

   2. 参考下表填写部署信息。

      参数	说明
      机房	OBProxy 所在的机房，一个 OBProxy 只能存在于一个机房。
      机型	可选项。如果选择了机型，后面主机列表会根据机型进行过滤。
      主机	选择部署 OBProxy 所使用的主机，支持多选。同时您可单击 添加 OBProxy，为集群添加更多主机。

      

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

      • 如需部署更多，可单击 添加 OBProxy 来增加主机。

      • 如只部署 1 个 OBProxy，可单击如上图所示的主机后的删除图标来删除该主机。

6. 为 OBProxy 集群配置启动参数。

   • 您可通过如图 ① 处，逐个添加启动参数项并为其配置值。关于 OBProxy 参数，详情可参见 OBProxy 参数说明。

   • 也可通过如图 ② 处，单击 参数模板 ，选择一个参数模板，系统会将模板中的参数连同配置自动填充到此处。在未创建集群参数模板的情况下，您可单击 新建 OBProxy 参数模板，为 OBProxy 集群创建参数模板，详情可参考 管理 OBProxy 参数模板。

   

   系统提供如下 2 种内置模板，模板中包含了常用的参数设置，您可直接应用该模板进行 OBProxy 集群的初始化设置。

   模板	说明
   4.2.1 默认参数模板	OBProxy V4.2.1 版本推荐使用的参数设置，供生产环境使用。
   列存副本默认参数模板	列存只读副本推荐使用的参数设置，供生产环境使用。

7. 打开 自定义设置，对集群端口、操作系统所属主用户及路径进行配置。

   配置	描述
   SQL 端口	默认为 2883，支持自定义。
   Exporter 端口	默认为 2884，支持自定义。
   RPC 端口	仅 OBProxy V4.3.0.0 及以上版本支持配置该端口，默认为 2885，支持自定义。
   操作系统所属主用户	用于配置安装、运行 OBProxy 的操作系统用户，不支持编辑，可通过 修改系统参数 ocp.operation.default.os.user 调整默认配置。用户修改后，仅对 创建分布式集群、创建单机、创建 OBProxy 集群和 创建仲裁服务 产生影响，不影响已有集群的其他配置。
   软件安装路径	当 操作系统所属主用户 为 admin 时，软件安装路径 默认为 /home/admin/obproxy，支持自定义路径。 当 操作系统所属主用户 为非 admin 时，软件安装路径 默认为 /opt/oceanbase/obproxy，支持自定义路径。 配置完成后，单击 测试，校验路径是否可用。若不可用，您可根据测试结果进行排查，或将路径修改为其它可用路径。

8. 单击 提交 ，开始创建 OBProxy 集群。

   说明

   安装 obproxy 时系统会检查涉及到的安装目录权限是否正确，目前支持递归检查 /home/admin/logs/obproxy 目录及其父目录对指定用户（默认 admin）是否有读权限及可执行权限。若没有，则会在日志中报 “check directory xxx permission failed, reason: xxx” 错误。