使用 OCP 部署 ODP

本文介绍如何使用 OCP 部署 ODP。您也可以通过以下方式部署 ODP：

• 通过 OBD 安装部署 ODP 请参考 使用 OBD 部署 ODP。

• 通过命令行安装部署 ODP 请参考 通过命令行部署 ODP。

前提条件

• 您已部署 OCP，详细操作请参考 OceanBase 云平台/部署指南。

• 当前登录 OCP 的用户需具备 管理主机 和 管理 OBProxy 的权限。

• 已上传 ODP 软件包至 OCP。

• 待部署 ODP 的机器以安装 nc 命令。

操作步骤

步骤一：添加机器到 OCP 资源池

部署 ODP 前，您需先参考本节内容将机器添加到 OCP 资源池。

1. 使用 admin 账号登录 OCP。

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

3. 在 主机 页面右上角单击 添加主机。

   

4. 在弹出的对话框中填写机器信息。

   

   各字段填写说明如下表所示。

   字段	描述
   IP 地址	待添加机器的 IP，请输入机器的 IPv4 地址。
   SSH 端口	默认为 22。
   机型	为配置相同的主机指定的一个标签，便于 OCP 更好地管理主机。如果没有对应的机型，可在下拉菜单中单击 新增机型，添加新的机型。
   机房	选择机器所处机房。如果没有对应的机房，可在下拉菜单中单击 新增机房 在 OCP 中新增机房信息。机房信息包括 机房 与 区域。 机房是 OceanBase 集群需要记录的一种主机属性，这个属性会作为 OceanBase 负载均衡和 SQL 语句路由策略的参考项，请按照实际情况填写。 区域用于表示主机所处的地理区域，是 OceanBase 集群需要记录的主机属性之一，对于 OceanBase 集群的负载均衡和 SQL 语句路由策略会有一定的影响，请按照实际情况填写。 说明 OCP V3.1.1 版本开始支持多 AZone 模式，新增机房时，将在当前 OCP 所在的 AZone 中创建新的机房。
   主机类型	有 物理机 和 容器 两种选项。
   凭据	选择远程登录物理机使用的凭据，您可以在下拉菜单中单击 新增凭据 来新建凭据。 新增凭据时需注意： 凭据名：以英文字母开头、英文或数字结尾，可包含英文、数字和下划线，且长度为 2 ~ 32。 授权类型：包含用户名/密码和 SSH 私钥两种方式。 用户类型：支持拥有 root 权限的 SSH 用户，拥有 root 权限的普通用户须先配置免密执行 sudo 指令。OCP 目前仅支持配置所有指令免密执行 sudo，即在 /etc/sudoers 文件中，添加 username ALL=(ALL) NOPASSWD:ALL。
   主机别名（可选）	主机别名是您为配置相同的主机指定的一个标签，建议您指定有意义的名称，便于更好地管理主机。
   说明（可选）	主机的注释，便于更好地管理主机。

5. 填写完成后，单击 确定。

步骤二：创建 ODP 集群

您可参考本节内容创建 ODP 集群，您可在创建 ODP 集群时部署 ODP，也可在创建 ODP 集群后通过 添加 OBProxy 方式部署 ODP。

1. 登录 OCP

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

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

4. 在 创建 OBProxy 集群 页面填写如下信息。

   1. 配置 基本信息

      基本信息 页签包含内容如下。

      

      参考下表进行配置。

      参数	说明
      集群名	您可根据实际业务情况，自定义集群名称，以英文字母开头，可包含英文、数字和下划线。
      录入 Proxyro 账号的密码	Proxyro 账号用于 OBProxy 访问 OceanBase 集群，未录入则使用 Proxyro 账号的默认密码进行连接。密码格式要求如下： 长度为 8 ~ 32 个字符。 只能包含字母、数字和特殊字符 ~!@#%^&*_-+=\|(){}[]:;,.?/。 大小写字母、数字和特殊字符都至少包含 2 个。
      负载均衡管理	开启负载均衡管理后，可通过配置 OBLB 来提升 OBProxy 集群的负载均衡能力。 OBLB 服务：您可选择部署 OCP 时已配置的 OBLB 服务，或单击 添加 OBLB 服务 按钮，在右侧面板中新建 OBLB 服务，详情可参考 管理负载均衡 中的 添加负载均衡。 OBLB 服务地址：OBLB 的服务地址。 OBLB 服务端口：默认为 9090，可根据实际情况进行更改。 用户名及密码：OBLB 服务的用户名及密码，用于调用 OBLB 接口的认证信息。 VIP：选择 OBLB 具体的 VIP 地址。 访问端口：默认为 2883，支持自定义端口号。 域名配置（可选）：用于指向 VIP 及端口的配置信息，平台未提供 VIP 与域名的映射关系，需自行准备域名解析服务。 说明 负载均衡管理 中的 SLB 服务 仅适用于专有云环境，建议联系技术支持同学进行协助。
      访问地址	当 负载均衡管理 关闭时展示，为 OBProxy 集群的访问地址，仅用于生成租户的连接串，不影响实际使用，需要自主配置负载均衡。如果是 VIP 地址，还需要您自主申请并绑定到 OBProxy Server。
      访问端口	当 负载均衡管理 关闭时展示，默认为 2883，需要根据 VIP 的真实端口填写。
      启动方式	设置该 OBProxy 集群的启动方式，可取值： ConfigUrl：多集群启动方式，即该 OBProxy 集群可访问多个 OceanBase 集群。 RsList：单集群启动方式，即该 OBProxy 集群仅可访问创建 OBProxy 集群时指定的那个 OceanBase 集群，OBProxy 集群创建成功后不可追加可连接的 OceanBase 集群。
      选择可连接的 OB 集群	设置该 OBProxy 集群可访问的 OceanBase 集群。 当 启动方式 配置为 ConfigUrl 时，该参数非必填，集群创建成功后，可通过 添加可连接的 OB 集群 添加。 当 启动方式 配置为 RsList 时，该参数必填。 在下拉框中选择对应的集群。 当密码箱中存在该集群 proxyro 用户的连接凭证时，会默认选择 proxyro 用户。 当密码箱中不存在该集群 proxyro 用户的连接凭证时，请单击 新建连接，为该集群的 proxyro 用户创建连接凭证。

   2. （可选）配置 部署 OBProxy

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

      部署 OBProxy 页签包含内容如下。

      

      可参考下表进行配置。

      参数	说明
      SQL 端口	默认为 2883。
      Exporter 端口	默认为 2884。
      软件版本	选择要安装的 ODP 版本。 说明 若 可连接的 OB 集群 中存在 V4.0 及以上版本的 OceanBase 集群时，仅支持选择 V4.0.0 及以上版本的 ODP 软件包。
      机房	选择部署 ODP 需使用主机所在的机房，如果没有对应的机房，可以单击 新增机房。
      机型（可选）	选择部署 ODP 需使用主机所属机型，如果没有对应的机型，可以单击 新增机型。
      主机	选择部署 ODP 需使用的主机，如果没有对应的主机，可以单击 添加主机。

      说明

      系统默认显示两个主机的选择，仅够部署两个 ODP，如需部署更多，可单击 添加 OBProxy 来增加主机。如只需部署 1 个 ODP，可单击对应主机后的删除图标来删除该主机。

   3. 参数设置

      打开 参数设置，添加或修改启动参数和其他参数。参数说明可参见 配置参数 章节。

      

5. 单击 提交，开始创建 ODP 集群。

步骤三：添加 ODP

本节介绍在创建好 ODP 集群后如何添加 ODP。

1. 登录 OCP。

2. 在左侧导航栏单击 OBProxy。

3. 在集群列表中选择需要操作的 OBProxy 集群，单击对应集群名，进入该集群的 总览 页面。

4. 单击右上方 添加 OBProxy。

5. 在弹出框中填写 软件版本、SQL 端口、Exporter 端口、机房、机型（可选）、主机 等信息。可参考下表进行配置。

   

   参数	说明
   软件版本	选择要安装的 ODP 版本。 说明 若 可连接的 OB 集群 中存在 V4.0 及以上版本的 OceanBase 集群时，仅支持选择 V4.0.0 及以上版本的 ODP 软件包。
   SQL 端口	默认为 2883。
   Exporter 端口	默认为 2884。
   机房	选择部署 ODP 需使用主机所在的机房，如果没有对应的机房，可以单击 新增机房。
   机型（可选）	选择部署 ODP 需使用主机所属机型，如果没有对应的机型，可以单击 新增机型。
   主机	选择部署 ODP 需使用的主机，如果没有对应的主机，可以单击 添加主机。

   说明

   • 当 OBProxy 集群为 V4.0 及之后版本时，仅支持选择 V4.0.0 及之后版本的软件包。

   • 当 OBProxy 集群为 V3.x 及之前版本时，仅支持选择 V1.8.0 及之后、V4.0.0 之前版本的软件包。

   • 当 OBProxy 集群中未创建或接管 OBProxy 时，添加 OBProxy 时可自定义 SQL 端口和 Exporter 端口；当 OBProxy 集群中已存在 OBProxy 时，SQL 端口和 Exporter 端口默认继承创建 OBProxy 集群中部署 OBProxy 时配置的端口号，不支持自定义。

6. 单击 确定。