使用 obd 部署 ODP

步骤 1：修改配置文件

obd 安装成功后，可在 /usr/obd/example/ 目录下查看 obd 提供的配置文件，并根据需要选择合适的配置文件。此处以配置文件 example/obproxy/obproxy-only-example.yaml 为例进行介绍。

1. 修改用户信息

   ## Only need to configure when remote login is required
   user:
     username: admin
   #   password: your password if need
     key_file: /home/admin/.ssh/id_rsa
   #   port: your ssh port, default 22
   #   timeout: ssh connection timeout (second), default 30
   

   username 为登录到目标机器（安装 OceanBase 集群的机器）的用户名，确保您的用户名有下文 home_path 的写权限。password 和 key_file 均用于验证用户，通常情况下只需要填写一个。

   注意

   在配置秘钥路径后，如果您的秘钥不需要口令，请注释或者删除 password，以免 password 被视为秘钥口令用于登录，导致校验失败。

2. 修改 ODP 配置

   obd 支持部署社区版和企业版 ODP，此处以部署社区版 ODP 为例，若您计划部署企业版，需将配置文件中的 obproxy-ce 修改为 obproxy。

   obproxy-ce:
     version: 4.3.0.0
     servers:
       - 10.10.10.1
     global:
       listen_port: 2883 # External port. The default value is 2883.
       prometheus_listen_port: 2884 # The Prometheus port. The default value is 2884.
       rpc_listen_port: 2885
       enable_obproxy_rpc_service: true
       home_path: /home/admin/obproxy
       obproxy_config_server_url: http://10.10.10.1:8080/services?Action=GetObProxyConfig
       # rs_list: 10.10.10.1:2881;10.10.10.2:2881;10.10.10.3:2881
       enable_cluster_checkout: false
       skip_proxy_sys_private_check: true
       enable_strict_kernel_release: false
       cluster_name: obcluster
       client_session_id_version: 2 #This parameter is used to specify whether to use the new logic to generate the client session ID. The parameter type is integer. The value range is [1, 2] and the default value is 2 (use the new logic).
       proxy_id: 5 #This parameter is used to set the ID for an ODP. The parameter type is integer. The default value is 0 and the value range is [0, 8191].
       obproxy_sys_password: ****** # obproxy sys user password, can be empty. When a depends exists, obd gets this value from the oceanbase-ce of the depends.
       observer_sys_password: ****** # proxyro user pasword, consistent with oceanbase-ce's proxyro_password, can be empty. When a depends exists, obd gets this value
   

   配置项	是否必选	默认值	说明
   version	可选	默认为最新版本	待安装组件的版本，使用该配置项可以指定部署的 ODP 的版本；未配置的情况下，obd 默认部署最新版本 ODP。
   servers	必选	无	每台机器需要用 - name: 机器标识名 (换行)ip: 机器 IP 指定，多个机器就指定多次，机器标识名不能重复。 在机器 IP 不重复的情况下，也可以使用 - <ip> （换行）- <ip> 的格式指定，此时 - <ip> 的格式相当于 - name: 机器 IP（换行）ip: 机器 IP。
   listen_port	必选	2883	ODP 监听端口，默认 2883。
   prometheus_listen_port	必选	2884	ODP prometheus 监听端口，默认 2884。
   rpc_listen_port	可选	2885	ODP 中 RPC 服务监听端口，默认为 2885。 说明 该配置项自 obd V2.10.0 版本新增，并且在 enable_obproxy_rpc_service 取值为 true 时生效。
   enable_obproxy_rpc_service	可选	true	控制是否启用 ODP RPC 服务，默认为 true 表示启用 RPC 服务，取值为 false 时表示停止 RPC 服务，此时 rpc_listen_port 配置将不生效。 说明 该配置项自 obd V2.10.0 版本新增。 若未配置该配置项，升级 ODP 后该配置项默认值将被置为 false。
   home_path	必选	无	ODP 安装路径。
   obproxy_config_server_url	可选	无	obconfigserver 的 url，配置后可使用 ODP 代理 obconfigserver 中注册的所有集群。若未部署 obconfigserver，您也可使用 rs_list 配置项。 注意 rs_list 和 obproxy_config_server_url 配置项只需配置一个即可，若您选择配置 rs_list 配置项，则无需配置 obproxy_config_server_url 配置项。
   rs_list	可选	无	OceanBase 集群的 OBServer 节点列表，格式为 ip:mysql_port;ip:mysql_port，使用 rs_list 配置部署的情况下您只可代理所配置的这一个集群。 注意 rs_list 和 obproxy_config_server_url 配置项只需配置一个即可，若您选择配置 rs_list 配置项，则无需配置 obproxy_config_server_url 配置项。 若通过配置 rs_list 启动 ODP，当 OceanBase 数据库中 Root Service 列表有变动时，需手动更新 rs_list 配置项，并重启 ODP 使变动生效。
   enable_cluster_checkout	可选	true	控制是否需要校验 cluster name，开启后，ODP 会在登陆时发送集群名到 OBServer 节点进行检查。
   enable_strict_kernel_release	必选	false	是否需要校验 OS 内核，如果为 true，则 ODP 仅支持 5u/6u/7u 版本的 RedHat。为 false 时不关心 Linux 内核版本的发布，ODP 可能不稳定。
   cluster_name	可选	无	表示 ODP 可以代理的 OceanBase 集群的名字，当存在依赖项时，obd 将会从依赖项 oceanbase-ce 中获取该值。
   client_session_id_version	可选	2	用于设置是否使用新的 Client Session ID 生成逻辑。仅可配置为 1 或 2，配置为 2 时使用新的 Client Session ID 生成逻辑。 说明 obd 自 V2.7.0 起支持配置文件中配置 client_session_id_version 配置项。
   proxy_id	可选	0	用于设置标识 ODP 的 ID，以保障不同 ODP 生成的 Client Session ID 不会发生冲突。当存在多个 ODP 服务同一个 OceanBase 集群时，不同 ODP 的 proxy_id 配置项不能配置为相同的值。根据 client_session_id_version 配置项的取值不同，proxy_id 配置项的取值范围有如下两种情况。 配置项 client_session_id_version 的值配置为 1 时，配置项 proxy_id 的取值范围为 [0,255]。 配置项 client_session_id_version 的值配置为 2 时，配置项 proxy_id 的取值范围为 [0,8191]。 说明 obd 自 V2.7.0 起支持配置文件中配置 proxy_id 配置项。
   obproxy_sys_password	可选	默认为随机字符串	ODP 管理员账户（root@proxysys）的密码。使用 obd V2.1.0 及之后版本时，未设置的情况下会自动生成随机字符串，可在部署成功后通过 obd cluster edit-config 命令查看配置文件中对应的配置项获取密码。
   observer_sys_password	可选	同时部署 OceanBase 数据库时默认与 proxyro_password 相同，单独部署时默认为随机字符串	ODP 连接 OceanBase 集群使用的账户名（proxyro@sys）的密码，配置密码需和 OceanBase 数据库中 proxyro_password 的值相同。若和 proxyro_password 的值不同，部署集群后无法使用 ODP 代理连接 OceanBase 数据库。

步骤 2：部署 ODP

若您的机器可以访问公网，则直接执行第 4~5 步。若您的机器无法访问公网，或计划部署企业版 ODP，则需先获取 ODP 安装包，之后参照下文第 1~3 步将安装包复制到 obd 本地镜像库。社区版 ODP 通过 Releases 页面或官网 OceanBase 软件下载中心 下载安装包。

1. 执行如下命令禁用远程镜像仓库：

   obd mirror disable remote
   

   禁用后可通过 obd mirror list 命令进行确认，查看 Type=remote 对应行的 Enabled 列展示为 False，说明已关闭远程镜像源。示例如下：

   +-----------------------------------------------------------------------------+
   |                            Mirror Repository List                           |
   +----------------------------+--------+---------+----------+------------------+
   | SectionName                | Type   | Enabled | Avaiable | Update Time      |
   +----------------------------+--------+---------+----------+------------------+
   | local                      | local  | -       | True     | 2025-02-19 15:56 |
   | oceanbase.community.stable | remote | False   | False    | 2025-02-19 15:54 |
   | oceanbase.development-kit  | remote | False   | False    | 2025-02-19 15:54 |
   +----------------------------+--------+---------+----------+------------------+
   

2. 执行如下命令将 ODP 安装包复制到本地镜像库：

   obd mirror clone <path> [-f]
   

   其中，参数 path 为 RPM 包的路径。选项 -f 表示 --force，为可选选项，默认不开启。开启时，若镜像已经存在，则强制覆盖已有镜像。

3. 执行以下命令，查看本地镜像库的 RPM 列表：

   obd mirror list local
   

4. 执行如下命令部署 ODP:

   obd cluster deploy test -c obproxy-only-example.yaml
   

   此处以使用 obproxy-only-example.yaml 配置文件部署名为 test 的集群为例，您需根据实际情况设置集群部署名，并指定配置文件的相对路径。

   说明

   在线安装时，执行了 obd cluster deploy 命令之后，obd 将检查本地镜像库是否有 ODP 安装包。如果没有安装包，obd 将自动从 yum 源获取。

5. 执行如下命令启动 ODP：

   obd cluster start test