使用 OBD 部署 ODP

本文介绍如何使用 OBD 部署 ODP，其步骤如下：

1. 检查安装环境

2. 选择合适版本

3. 通过 OBD 安装

4. 安装后检查

您也可以通过以下方式部署 ODP：

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

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

环境准备

• 平台：X86_64、ARM

• 操作系统：Linux Redhat 5u|6u|7u x86-64 及以上

• CPU：ODP 启动成功后，CPU 占用 0.7 C 左右

• 内存：ODP 启动成功后，内存占用 100 M 左右

• 磁盘空间：对磁盘大小没有特别需求，根据数据大小决定，推荐 10G 及以上

• OceanBase 集群：您需至少准备一个 OceanBase 集群，详细信息请参考 OceanBase 数据库文档 中 部署数据库 章节。

• （可选）obconfigserver：若您部署了 obconfigserver，可通过配置 obproxy_config_server_url 启动 ODP，此时的 ODP 可代理 obconfigserver 中注册的所有集群。

选择合适版本

如果只是学习使用，一般安装最新的版本即可。如果是生产环境，建议关注每个版本的功能迭代和 bugfix 情况。

ODP 的代码已经开源，在 OceanBase 开源项目中找到 OBProxy 项目，点击 Releases 可以查看每个版本的详细信息。ODP 每个版本都经过了功能测试、压力测试和性能测试，可以放心使用。

操作步骤

步骤 1：下载安装 OBD

安装部署 ODP 最快的方式是使用部署工具 OceanBase Deployer（简称 OBD），因此推荐您使用此方式部署 ODP。

按照以下步骤下载并安装 OBD。 如您的机器可以访问公网，并能够添加三方 YUM 软件源，您可以运行以下命令，使用 OceanBase 的官方软件源安装 OBD：

sudo yum install -y yum-utils
sudo yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
sudo yum install -y ob-deploy
source /etc/profile.d/obd.sh

如果您的机器无法访问公网，可使用其他机器通过官网 OceanBase 软件下载中心 下载 OBD 安装包，之后将该安装包传入您所使用的机器进行安装，具体介绍可参见官网《OceanBase 安装部署工具》文档 快速上手/安装并配置 OBD。

步骤 2：修改配置文件

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

obproxy-ce:
  version: 4.2.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.
    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
    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

步骤 3：部署 ODP

若您的机器可以访问公网，则直接执行第 4~5 步，若您的机器无法访问公网，则需先通过 Releases 页面或官网 OceanBase 软件下载中心 下载 ODP 安装包，之后将该安装包复制到本地镜像库，具体操作如下。

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

   obd mirror disable <mirror repo name>
   

   其中，参数 mirror repo name 为需禁用的镜像仓库名。如果指定为 remote，则会禁用所有远程镜像仓库。

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

   obd mirror clone <path> [-f]
   

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

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

   obd mirror list local
   

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

   obd cluster deploy <deploy_name> -c <deploy_config_path>
   

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

   说明

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

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

   obd cluster start <deploy_name> 
   

步骤 4：安装后检查

1. 通过如下命令查看部署情况：

   obd cluster display <deploy_name>
   
   # 示例
   [admin@test ~]$ obd cluster display obtest
   Get local repositories and plugins ok
   Open ssh connection ok
   Cluster status check ok
   Connect to observer ok
   Wait for observer init ok
   +---------------------------------------------------+
   |                      observer                     |
   +-----------------+---------+------+-------+--------+
   | ip              | version | port | zone  | status |
   +-----------------+---------+------+-------+--------+
   | 10.10.10.2      | 4.0.0.0 | 2881 | zone1 | ACTIVE |
   | 10.10.10.3      | 4.0.0.0 | 2881 | zone2 | ACTIVE |
   | 10.10.10.4      | 4.0.0.0 | 2881 | zone3 | ACTIVE |
   +-----------------+---------+------+-------+--------+
   obclient -h10.10.10.2 -P2881 -uroot -p****** -Doceanbase
   
   Connect to obproxy ok
   +---------------------------------------------------+
   |                      obproxy                      |
   +-----------------+------+-----------------+--------+
   | ip              | port | prometheus_port | status |
   +-----------------+------+-----------------+--------+
   | 10.10.10.1      | 2883 | 2884            | active |
   +-----------------+------+-----------------+--------+
   obclient -h10.10.10.1 -P2883 -uroot -p****** -Doceanbase
   

   通过该命令可以看到 obproxy 信息，其中 port 列为 2883 表示提供 SQL 服务的端口是 2883，也就是 JDBC URL 中需要填写的 PORT。

2. 通过 obd cluster display 命令做过状态检查后，可以使用终端登录到 obproxy 进程所在机器，执行 ps -ef | grep obproxy 命令查看进程信息。

   [admin@test ~]# ps -ef | grep obproxy | grep -v grep
   admin     6868     1  0 Nov12 ?        00:02:09 bash /home/admin/obproxy/obproxyd.sh /home/admin/obproxy 10.10.10.1 2883 daemon
   admin     6901     1  0 Nov12 ?        00:44:11 /home/admin/obproxy/bin/obproxy --listen_port 2883
   

   从上述示例中可以看到两个进程：obproxyd.sh 进程和 obproxy 进程。其中，obproxy 就是 ODP 的进程名，obproxyd.sh 是 ODP 的守护脚本，负责启动 obproxy，对 obproxy 做健康检查，如果 obproxy 进程不存在，obproxyd.sh 会主动拉起进程。

部署常见问题

启动失败

对于 Linux 系统，ODP 通过配置项 enable_strict_kernel_release 控制对操作系统版本的检查，检查不通过会导致启动失败，关键日志如下：

[2021-10-13 10:38:17.235062] WARN [PROXY] get_kernel_release_by_uname (ob_config_server_processor.cpp:1039) [2060][Y0-0] [lt=14] [dc=0] unknown uname release(uinfo.release="4.18.0-80.el8.x86_64", ret=-4016)

您可使用 uname 命令查看内核信息，该选项目前只允许 el 系列和 alios 系列通过，检查策略偏保守型，可能会产生一些误报。其它 linux 系统如果遇到上面问题，可以通过关闭该配置项予以解决。

无法连接 OceanBase 数据库

ODP 通过 proxyro 用户和 OceanBase 数据库建立连接。当该用户不存在或该用户的密码与 ODP 的配置项 observer_sys_password 不一致时，将导致无法连接 OceanBase 数据库，报错如下：

ERROR 2013 (HY000): Lost connection to MySQL server at 'reading authorization packet', system error: 11

此时需要根据具体情况选择不同的解决方法：

1. 该用户不存在

   可使用 root@sys 用户通过直连的方式进入 OceanBase 数据库，之后在 sys 租户下创建 proxyro 用户。

   create user proxyro identified by '*******';
   grant select on *.* to proxyro;
   

2. 该用户的密码与 ODP 的配置项 observer_sys_password 不一致，此时有两种解决方法

   1. 可使用 root@sys 用户通过直连的方式进入 OceanBase 数据库后修改 proxyro 用户的密码，使之与启动 ODP 时设置的observer_sys_password 参数密码一致。

      ALTER USER proxyro IDENTIFIED BY 'password';
      

   2. 使用 root@proxysys 账号登录 ODP，修改 proxyro@sys 的密码，修改后需要重启。

      alter proxyconfig set observer_sys_password = 'password';