使用 OBD 图形化部署单点OceanBase数据库

OBD简介

obd 全称为 OceanBase Deployer，是 OceanBase 数据库的安装部署工具，可以通过命令行部署或白屏界面部署，已成为集群与单机环境安装的 "标配利器"。按是否支持配置文件方式有可细分三种灵活部署模式：可视化界面（obd web）配置操作、交互式命令（obd cluster deploy -i）向导式配置、配置文件（config.yaml）批量部署，将复杂配置流程标准化，降低集群部署难度。

其中，命令行支持编辑配置文件，可以更加灵活的进行配置调整，适用于需要深度了解 OceanBase 的用户，有一定的使用门槛；白屏界面配置简单，通过页面的引导配置即可完成集群部署，适用于需要快速体验，构建标准环境的用户。

在集群部署之外，obd 还提供了包管理器、压测软件、集群管理等常用的运维能力，更好地支持用户体验使用 OceanBase 分布式数据库。

补充：

配置文件（config.yaml）本质也是属于命令行部署的一种。 obd cluster deploy -i 属于命令行形式，本质属于定制化部署的一种，相比obd demo/obd perf

通过OceanBase All in One方式安装OBD

安装 obd 的方法有3种，分别是通过 OceanBase All in One 安装、使用 RPM 安装以及使用源码安装，其中RPM 安装方式部署，需要考虑所用机器是否可以连接外部网络，分为在线安装和离线安装两种安装方法。需要注意的是，通过 RPM 包安装时仅安装 obd，当机器可以连接外部网络时，obd 会访问远程镜像源获取部署集群所需安装包；当机器无法连接网络时，成功安装 obd 后，您还需手动配置 obd 的本地镜像库。

OceanBase 从 V4.0.0 开始提供统一的安装包 OceanBase All in One。目前包括 OceanBase 数据库软件和 OCP、obd、OBProxy（又称为 ODP）、OBClient、OCP Express（自 V4.1.0 起支持）、Prometheus、Grafana，以及诊断和测试工具。

具备以下优点：

● 部署便捷性：一键安装脚本 ./install.sh，自动完成 OBD、OBProxy、OBAgent、OCP Express 等组件的本地镜像加载，极大简化部署流程。

● 离线支持：提供完整离线包，适合无公网环境，避免逐一下载依赖，提升部署可靠性。

● 图形化支持：支持 obd web 启动图形化界面，向导式配置集群参数、节点、端口、目录等，降低新手门槛。

● 组件完整性：默认集成 Grafana、OBAgent、OCP Express、TPCH/TPCC 工具包，适合性能测试与可视化监控,可自由勾选要安装的组件。

● 版本选择：支持版本(4.2.x/4.3.x)手动选择。

说明：

● OceanBase All in One 不同系列安装包中包含的产品不同，V4.3.x 系列中自 V4.3.3 起包含 OCP、V4.2.x 系列中自 V4.2.5 起包含 OCP、V4.2.1 系列中自 V4.2.1_CE_BP9_HF1 起包含 OCP。

● 建议通过下载 OceanBase All in One 进行安装，OceanBase All in One 目前提供部署所需要的全部组件（除 obbinlog 组件），且组件已经经过相互适配测试，为官方推荐版本。

下载最新的 OceanBase All in One

官方下载地址：https://www.oceanbase.com/softwarecenter

在"一键安装"模块中单机右上角向下的箭头，选择最新版本V4.3.5，根据部署环境选择对应的安装介质，本文环境是Centos7.6 2C10GB。

注意：选择对应的版本，OBD V4.3.5.版本支持el7和el8

由于服务器归属内网无法连接网络，只能采用离线安装。OceanBase All in One本身是支持在线和离线安装的。

将下载文件 oceanbase-all-in-one-4.3.5_bp3_hf1_20250902.el7.x86_64.tar.gz 上传至/opt目录下，该文件稍微有些大，1.7G

离线安装OceanBase All in One

在安装包所在目录下执行如下命令解压安装包并安装。整个安装过程非常快，前后不到2分钟。

tar -xzf oceanbase-all-in-one-*.tar.gz

cd oceanbase-all-in-one/bin/

./install.sh

source ~/.oceanbase-all-in-one/bin/env.sh

输出如下：

name = vcdrom

baseurl = file:///mnt/cdrom

gpgcheck = 0

enabled = 1

安装依赖包

yum install net-tools

目录规划

部署 OceanBase 数据库社区版需要规划以下三个目录，同时要求文件系统类型为 XFS 或 EXT4。

● 安装目录：用于存放 OceanBase 数据库运行软件以及运行过程中系统日志的目录，为保证性能，空间要求 25G 以上。

● 日志保存目录：用于存放 OceanBase 数据库日志，空间要求最小为内存大小的两倍，推荐配置为内存大小的三倍以上。注意是可用空间不然会报错

● 数据保存目录：用于存储数据，空间要求最小为内存大小的两倍以上，取决于所需存储的数据大小。注意是可用空间不然会报错

--安装目录为 /data/base，日志保存目录为 /data/log1 ，数据保存目录为 /data/1

mkdir -p /data/{base,log1,1}

创建用户

不推荐在 root 用户下部署 OceanBase 数据库，建议创建其他用户用于部署，推荐使用 admin 用户。用户需为数据库相关目录的所有者。

● 配置 limits.conf

● 配置 sysctl.conf

● 关闭防火墙和 SELinux

obd 支持通过主机命令组对主机和对应用户执行初始化操作，可选择通过 obd 命令进行上述配置配置，也可选择手动配置。推荐通过 obd 命令配置。

obd host user init -u admin --host=192.168.40.110 -p admin

--参数说明

--host=192.168.40.110：待创建用户的主机 IP（--host）

-u：待创建并初始化的用户

-p：用户密码

--赋予安装目录权限

chown -R admin:admin /data/base

chmod -R 775 /data/base

启动图形化界面进行部署

进入 OceanBase 数据库部署界面

启动图形化界面

命令行执行 obd web 命令启动图形化界面，默认端口8680，后台启动运行。

obd web

--扩展

自定义端口启动：obd web -p <端口号>

输出如下：

--示例

obd cluster start dxjobsingle -S

--参数说明

-S：在启动前会做相关的检查

输出如下：

root@localhost \~\]# obd cluster start dxjobsingle -S Get local repositories ok Load cluster param plugin ok Cluster status check ok Deploy "dxjobsingle" is running Trace ID: f896ff90-8df1-11f0-b87b-000c29e13c26 If you want to view detailed obd logs, please run: obd display-trace f896ff90-8df1-11f0-b87b-000c29e13c26 重启一个运行中集群 重启一个运行中集群。重启默认是无参重启。当使用 edit-config 修改一个运行的集群的配置信息后，可以通过 obd cluster restart --wp 命令应用修改。 参数 deploy name 为部署名，可以理解为配置文件的别名。 选项说明见下表： 选项名 是否必选 数据类型 默认值 说明 -s/--servers 否 string 空 机器列表，后跟 yaml文件中 servers对应的 name值，若 servers后未配置 name值，则使用 ip值，用 ,间隔，用于指定需要重启的机器。 -c/--components 否 string 空 组件列表，用 ,间隔。用于指定需要重启的组件。如果配置下的组件没有全部启动，该配置不会进入 running 状态。 --wp/--with-parameter 否 bool false 带参重启。用于让重启生效的配置项生效。 --语法 obd cluster restart --示例 obd cluster restart dxjobsingle -c obproxy-ce --wp obd cluster restart dxjobsingle 参数说明： --wp：带参重启。用于让重启生效的配置项生效。 -c：组件列表，用 ,间隔。用于指定需要重启的组件。如果配置下的组件没有全部启动，该配置不会进入 running 状态。 输出如下： \[root@localhost \~\]# obd cluster restart dxjobsingle Get local repositories and plugins ok Load cluster param plugin ok Open ssh connection ok Cluster status check ok Check before start ob-configserver ok Connect to ob-configserver ok Connect to observer 192.168.40.110:2881 ok Server check ok Connect to obproxy ok Check before start obagent ok Connect to Obagent ok Check before start prometheus ok Connect to Prometheus ok Check before start grafana ok Stop ob-configserver ok Start ob-configserver ok ob-configserver program health check ok Connect to ob-configserver ok ±-------------------------------------------------------------------+ \| ob-configserver \| ±---------------±-----±---------------±---------±-------±------+ \| server \| port \| vip_address \| vip_port \| status \| pid \| ±---------------±-----±---------------±---------±-------±------+ \| 192.168.40.110 \| 8080 \| 192.168.40.110 \| 8080 \| active \| 95705 \| ±---------------±-----±---------------±---------±-------±------+ curl -s 'http://192.168.40.110:8080/services?Action=GetObProxyConfig' Stop observer ok Stop obshell ok cluster scenario: htap Start observer ok observer program health check ok obshell start ok obshell program health check ok Connect to observer 192.168.40.110:2881 ok Wait for observer init ok ±-------------------------------------------------+ \| oceanbase-ce \| ±---------------±--------±-----±------±-------+ \| ip \| version \| port \| zone \| status \| ±---------------±--------±-----±------±-------+ \| 192.168.40.110 \| 4.3.5.3 \| 2881 \| zone1 \| ACTIVE \| ±---------------±--------±-----±------±-------+ obclient -h192.168.40.110 -P2881 -uroot@sys -p'61608Hhd820.' -Doceanbase -A cluster unique id: 62580c30-5efe-52ce-bc39-8f5fe845fe62-199315e9bc1-03050304 Stop obproxy-ce ok start obproxy ok obproxy program health check ok Connect to obproxy ok ±-------------------------------------------------------------------+ \| obproxy-ce \| ±---------------±-----±----------------±----------------±-------+ \| ip \| port \| prometheus_port \| rpc_listen_port \| status \| ±---------------±-----±----------------±----------------±-------+ \| 192.168.40.110 \| 2883 \| 2884 \| 2885 \| active \| ±---------------±-----±----------------±----------------±-------+ obclient -h192.168.40.110 -P2883 -uroot@proxysys -p'IC3X+QhIPd4s.1H(KY+jV:!Y=e?g\]' -Doceanbase -A Stop obagent ok Start obagent ok obagent program health check ok Connect to Obagent ok ±------------------------------------------------------------------+ \| obagent \| ±---------------±-------------------±-------------------±-------+ \| ip \| mgragent_http_port \| monagent_http_port \| status \| ±---------------±-------------------±-------------------±-------+ \| 192.168.40.110 \| 8089 \| 8088 \| active \| ±---------------±-------------------±-------------------±-------+ Stop prometheus ok Start promethues ok prometheus program health check ok Connect to Prometheus ok ±-----------------------------------------------------------------+ \| prometheus \| ±---------------------------±------±-------------------±-------+ \| url \| user \| password \| status \| ±---------------------------±------±-------------------±-------+ \| http://192.168.40.110:9090 \| admin \| 'bF!0!Kb\&g#HFpk1\[' \| active \| ±---------------------------±------±-------------------±-------+ Stop grafana ok Start grafana ok grafana program health check ok Connect to grafana ok ±------------------------------------------------------------------------------------+ \| grafana \| ±---------------------------------------±------±--------------------------±-------+ \| url \| user \| password \| status \| ±---------------------------------------±------±--------------------------±-------+ \| http://192.168.40.110:3000/d/oceanbase \| admin \| 'Fov2(CO\~Y/OznP0L2U86amr' \| active \| ±---------------------------------------±------±--------------------------±-------+ dxjobsingle restart Trace ID: 147f97ee-8df2-11f0-8dc5-000c29e13c26 If you want to view detailed obd logs, please run: obd display-trace 147f97ee-8df2-11f0-8dc5-000c29e13c26 注意：并非所有的配置项都可以通过 restart 来应用。有些配置项需要重部署集群才能生效。请根据 edit-config 后返回的信息进行操作。 销毁集群 重新部署一个运行中集群即销毁集群。当使用 edit-config 修改一个运行的集群的配置信息后，可以通过 redeploy 命令应用修改。 参数 deploy name 为部署名，可以理解为配置文件的别名。 选项名 是否必选 数据类型 默认值 说明 -f/--force-kill 否 bool false obd 执行销毁命令前会检查是否还有进程在运行中。这些运行中的进程可能是 start 失败留下的，也可能是因为配置与其他集群重叠，进程是其他集群的。但无论是哪个原因导致工作目录下有进程未退出，obd 都会直接停止执行 obd cluster redeploy命令。开启 -f 选项后，检查到工作目录下有运行中的进程时，会强制停止进程，强制执行 obd cluster redeploy。 --confirm 否 bool false 执行该命令过程中需要您二次确认是否重启集群，开启该选项后，将跳过二次确认过程，直接重启集群。 --igs/--ignore-standby 否 string 空 检查到集群中租户在其他集群中存在备租户时，强制执行 obd cluster redeploy，集群销毁后备租户将无法使用 --语法 obd cluster redeploy \[-f

--示例

obd cluster redeploy test -f

参数说明：

-f ：检查到工作目录下有运行中的进程时，会强制停止进程，强制执行 obd cluster redeploy。

注意：该命令会销毁集群，重新部署，集群中的数据会丢失，请先做好备份。

总结

OceanBase All in One 是"懒人福音"，通过 OceanBase All in One 安装 OceanBase 数据库，是一种官方推荐的部署方式，尤其适合社区用户和中小企业快速搭建测试或轻量级生产环境。但在生产环境中，仍需结合资源规划与命令行调优。

附录：OceanBase 服务端进程 & 生态产品默认端口号

介绍 OceanBase 服务端进程和 OceanBase 生态各产品进程的默认端口号。

OceanBase 服务端进程默认端口号

OceanBase 产品族中，目前运行在服务端的进程包括 observer、obproxy 等。目前他们使用的默认端口号如下。

产品默认端口号配置项是否支持自定义含义

observer 2881 mysql_port 1.使用 OBD 部署和手动部署支持自定义；

2.使用 OCP 4.0.3 及以上版本部署支持自定义 SQL 服务端口

observer 2882 rpc_port 1.使用 OBD 部署和手动部署支持自定义；

2.使用 OCP 4.0.3 及以上版本部署支持自定义 RPC 服务端口

obproxy 2883 listen_port 是 SQL 服务端口

obproxy 2884 prometheus_listen_port 是 OBProxy prometheus 监听端口

obagent 8088 server_port 是 OBAgent 的监控采集端口

obagent 8089 pprof_port 是 OBAgent 的运维监听端口

生态产品默认端口号

OceanBase 生态产品，包括 OCP、ODC、OMS 等，有诸多组件。目前他们使用的默认端口号如下。

产品默认端口号是否支持自定义含义

ODC 8989 是 WEB 服务监听端口

OMS 8089/8090 否 OMS 管理控制台对应端口

OMS 8088 否 OMS 集群管理 http 端口

OMS 9000/9001 否 OMS Worker agent http 端口

OMS 16000~16499

17000~17499

18000~18499

7100-7499 否 OMS 内部组件通信使用

OCP 8080 是 OCP-Server web 服务监听端口，通常其它组件通过 SLB/DNS 地址访问 OCP-Server

OCP 62888 否 OCP-Agent 的运维监听端口

OCP 62889 否 OCP-Agent 的监控采集端口

OCP 2911 否备份 Agent 监听端口（当使用逻辑备份功能，并安装Backup-Agent 时，才监听该端口。逻辑备份最高支持到内核2.2.52版本）

OCP 2912 否恢复 Agent 监听端口（当使用逻辑备份功能，并安装Backup-Agent 时，才监听该端口。逻辑备份最高支持到内核2.2.52 版本）

OCP-Express 8180 是 Server 的 Web 服务监听端口

OBD Web 8680 是 OBD 白屏 web 工具端口

Prometheus 9090 是 prometheus 的 Web 服务监听端口

Grafana 3000 是 grafana-server 的 Web 服务监听端口

参考链接：https://www.oceanbase.com/docs/common-obd-cn-1000000003754441#11-title-使用 obd 图形化界面部署集群

https://ask.oceanbase.com/t/topic/35630741