--- title: "部署 OMS - 安装部署工具 OBD V4.1.0 | OceanBase 文档中心" description: 部署 OMS 本文以 x86 架构的 CentOS Linux 7.9 镜像作为环境介绍如何使用 obd 配置文件部署 OceanBase 迁移服务（OceanBase Migration Service，OMS）。 说明 目前 obd 仅支持管理 OMS 社区版 V4.2.11 及以上版本。 前提条件 在开始之前，… --- 切换语言 - 中文站 - 简体中文 - International - English - 日本站 - 日本語 文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*Qq8pT6yBPTcAAAAAAAAAAAAADiGDAQ/original) 安装部署工具 OBDV 4.1.0 # 部署 OMS 更新时间：2026-01-29 11:43:06 [编辑](https://github.com/oceanbase/obd-doc/edit/V4.1.0/zh-CN/400.user-guide/300.command-line-operations/200.deploy-component/360.deploy-oms.md) 本文以 x86 架构的 CentOS Linux 7.9 镜像作为环境介绍如何使用 obd 配置文件部署 OceanBase 迁移服务（OceanBase Migration Service，OMS）。 #### 说明 目前 obd 仅支持管理 OMS 社区版 V4.2.11 及以上版本。 ## 前提条件 在开始之前，请确保您已满足以下条件： - 您已安装 obd V4.0.0 或之后版本，建议安装最新版本，详细信息请参考 [安装 obd](https://www.oceanbase.com/docs/common-obd-cn-1000000005150939)。 - 待部署 OMS 的机器满足部署要求，具体可参见官网《OceanBase 迁移服务》文档 [部署 OMS 社区版](https://www.oceanbase.com/docs/community-oms-cn-1000000004253109) 章节。 - 待部署 OMS 的机器已安装 Docker。 - 如需 OMS 收集和展示监控数据，需部署并配置时序数据库。目前支持的时序数据库为 InfluxDB V1.8，具体部署操作可参见 [部署时序数据库](https://www.oceanbase.com/docs/community-oms-cn-1000000004253199)。 - 若计划单独部署 OMS，需确保已准备用于存储 OMS 社区版元信息的数据库，该数据库可以是 MySQL 或 OceanBase 数据库，建议您使用 OceanBase 数据库社区版。 #### 说明 为提升系统可靠性，建议 MetaDB 实施高可用数据库方案，这将有效保障 OMS 核心服务的 7x24 小时稳定运行，降低业务中断风险。 - 若同时部署 OceanBase 集群作为 MetaDB，需确保 OBServer 节点机器支持 AVX 指令集（仅 x86 架构服务器有此限制）。可执行 `lscpu | grep Flags | grep avx` 命令查看是否支持 AVX 指令集。 #### 说明 当使用 x86 架构机器时，若待部署的 OceanBase 数据库版本在以下范围中，不再限制机器是否支持 AVX 指令集： - 对于 V4.2.x 版本，要求为 V4.2.5.6 或之后版本。 - 对于 V4.3.x 版本，要求为 V4.3.5.4 或之后版本。 - 对于 V4.4.x 版本，要求为 V4.4.1.0 或之后版本。 - 离线部署场景下，若同时部署 OceanBase 集群作为 MetaDB，且使用 ARM 架构服务器部署，需查看 OBServer 节点机器是否支持 LSE 指令集，可执行 `lscpu | grep Flags | grep atomics` 命令查看是否支持。若机器不支持 LSE 指令集，需下载带 `nonlse` 的 OceanBase 数据库安装包，并使用 `obd mirror clone` 命令将安装包上传到 obd 本地镜像库。 #### 说明 OceanBase All in One 包中未包含带有 `nonlse` 的 OceanBase 数据库安装包。 - 同时部署 OceanBase 集群作为 MetaDB 时，需确保 obd 镜像库中有部署所需组件安装包（如 OceanBase 数据库）。 若 obd 所在机器可以连接外部网络，部署时会自动从远程镜像库获取社区版组件安装包。若 obd 所在机器无法连接外部网络，可访问 [OceanBase 软件下载中心](https://www.oceanbase.com/softwarecenter) 获取所有安装包，并执行 `obd mirror clone` 命令上传至 obd 本地镜像库，上传后可执行 `obd mirror list local` 命令查看本地镜像库中的安装包。 ## 注意事项 OMS 社区版默认关闭高可用（HA）功能。如果您需要开启，可在部署完成后，通过访问 OMS 管理控制台修改 `ha.config` 参数中 `enable` 的取值为 `true` 的方式启动 HA。详情请参见《OceanBase 迁移服务》文档 [系统管理/系统参数/修改高可用功能的配置](https://www.oceanbase.com/docs/community-oms-cn-10000000042531647)。 ## 操作步骤 #### 说明 本文以 x86 架构的 CentOS Linux 7.9 镜像环境为例提供操作指导。 单独部署 OMS 依赖 OceanBase 数据库部署 OMS ### 步骤一：加载 OMS 社区版包 #### 说明 如计划部署多节点 OMS，每个节点都需要执行如下操作。 1. 获取 OMS 安装包 可访问官网 [OceanBase 软件下载中心](https://www.oceanbase.com/softwarecenter) 下载 OMS 社区版安装包，通常是以 `oms` 开头的 `tar.gz` 文件，如 `oms_4.2.11-ce.tar.gz`。 2. 加载下载的 OMS 安装包至 Docker 容器的本地镜像仓库 ```shell [admin@test ~]$ sudo docker load -i oms_4.2.11-ce.tar.gz ``` 3. 验证加载是否成功 ```shell [admin@test ~]$ sudo docker images ``` 输出如下： ```shell REPOSITORY TAG IMAGE ID CREATED SIZE reg.docker.alibaba-inc.com/oceanbase/oms-ce feature_4.2.11_ce 26f5f1554fc5 2 days ago 12.5GB ``` ### 步骤二：修改配置文件 1. 创建配置文件 执行如下命令创建配置文件，此处以名为 `oms-only-config.yaml` 为例，您可自定义配置文件名。 ```shell [admin@test ~]$ vim oms-only-config.yaml ``` 2. 修改用户信息 您可复制如下内容，根据自身实际场景进行修改。 ```yaml ## 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` 为登录到目标机器的用户名，确保您的用户名有家目录的写权限。`password` 和 `key_file` 均用于验证用户，通常情况下只需要填写一个。 #### 注意 在配置秘钥路径后，如果您的秘钥不需要口令，请注释或者删除 `password`，以免 `password` 被视为秘钥口令用于登录，导致校验失败。 3. 修改 OMS 配置 您可复制如下内容，根据自身实际场景进行修改。配置项的具体含义可参见 [配置文件说明](https://www.oceanbase.com/docs/common-obd-cn-1000000005151023) 中 **配置项说明**。 ```yaml oms: type: docker tag: feature_4.2.11_ce image_name: reg.docker.alibaba-inc.com/oceanbase/oms-ce servers: - name: server1 ip: 10.10.10.1 - name: server2 ip: 10.10.10.2 - name: server3 ip: 10.10.10.3 global: oms_meta_host: "10.10.10.1" # OMS meta database host address oms_meta_password: "******" # Password for OMS meta database user oms_meta_port: 2881 # Port number for OMS meta database connection oms_meta_user: root # Username for OMS meta database connection mount_path: /data/1/oms # Mount path for OMS data storage ghana_server_port: 8090 # Port for ghana server nginx_server_port: 8089 # Port for nginx server cm_server_port: 8088 # Port for cluster manager server # tsdb_enabled: "true" # tsdb_password: "" # tsdb_service: "INFLUXDB" # tsdb_url: "10.10.10.1:8086" # tsdb_username: "admin" regions: - cm_location: 1 cm_is_default: true cm_region: hz cm_url: http://10.10.10.1:8088 cm_nodes: - 10.10.10.1 - 10.10.10.3 - cm_location: 2 cm_is_default: false cm_region: bj cm_url: http://10.10.10.2:8088 cm_nodes: - 10.10.10.2 ``` ### 步骤三：部署 OMS 1. 部署 OMS ```shell [admin@test ~]$ obd cluster deploy oms -c oms-only-config.yaml ``` 命令里的 `oms` 为集群名，您可根据实际情况自定义集群名。部署成功后命令行会输出对应的启动命令，输出如下： ```shell Open ssh connection ok +---------------------------------------------------------+ | Packages | +------------+-------------------+---------+--------------+ | Repository | Tag | Release | Hash | +------------+-------------------+---------+--------------+ | oms | feature_4.2.11_ce | - | 26f5f1554fc5 | +------------+-------------------+---------+--------------+ Repository integrity check ok Load param plugin ok Initializes OMS mount path ok Parameter check ok oms deployed Please execute ` obd cluster start oms ` to start Trace ID: 75241e2a-c133-11f0-910c-00163e1c4eb2 If you want to view detailed obd logs, please run: obd display-trace 75241e2a-c133-11f0-910c-00163e1c4eb2 ``` 2. 启动 OMS ```shell [admin@test ~]$ obd cluster start oms ``` 启动成功后会输出集群的相关信息，输出如下： ```shell Start oms ok OMS health check ok +-----------------------------------------------------------+ | oms | +--------+-------------------+---------------+--------------+ | region | url | cm_is_default | nodes | +--------+-------------------+---------------+--------------+ | hz | 10.10.10.1:8089 | True | 10.10.10.1 | | bj | 10.10.10.2:8089 | False | 10.10.10.2 | +--------+-------------------+---------------+--------------+ oms running Trace ID: 796b1a4c-c133-11f0-b9ac-00163e1c4eb2 If you want to view detailed obd logs, please run: obd display-trace 796b1a4c-c133-11f0-b9ac-00163e1c4eb2 ``` ### 步骤一：加载 OMS 社区版包 可访问官网 [OceanBase 软件下载中心](https://www.oceanbase.com/softwarecenter) 下载 OMS 安装包，通常是以 `oms` 开头的 `tar.gz` 文件，如 `oms_4.2.11-ce.tar.gz`。 2. 加载下载的 OMS 安装包至 Docker 容器的本地镜像仓库 ``` 输出如下： ``` 执行如下命令创建配置文件，此处以名为 `oms-config.yaml` 为例，您可自定义配置文件名。 ```shell [admin@test ~]$ vim oms-config.yaml ``` #### 注意 在配置秘钥路径后，如果您的秘钥不需要口令，请注释或者删除 `password`，以免 `password` 被视为秘钥口令用于登录，导致校验失败。 3. 修改 OceanBase 数据库配置 ```yaml oceanbase-ce: # version: 4.3.0.1 # release: 100000242024032211.el7 # package_hash: c4a03c83614f50c99ddb1c37dda858fa5d9b14b7 servers: - name: server1 ip: 10.10.10.1 - name: server2 ip: 10.10.10.2 - name: server3 ip: 10.10.10.3 global: appname: obcluster mysql_port: 2881 rpc_port: 2882 home_path: /home/admin/oceanbase data_dir: /home/admin/oceanbase/data redo_dir: /home/admin/oceanbase/redo obshell_port: 2886 scenario: htap cpu_count: 20 memory_limit: 64G system_memory: 30G log_disk_size: 192G datafile_size: 192GB datafile_maxsize: 32G enable_syslog_recycle: true enable_syslog_wf: false max_syslog_file_count: 4 root_password: ******** server1: zone: zone1 server2: zone: zone2 server3: zone: zone3 ``` OceanBase 数据库的配置项详细介绍可参见 [配置文件说明](https://www.oceanbase.com/docs/common-obd-cn-1000000005151023) 中 **配置项说明**。 4. 修改 OMS 配置 ```yaml oms: depends: - oceanbase-ce type: docker tag: feature_4.2.11_ce image_name: reg.docker.alibaba-inc.com/oceanbase/oms-ce servers: - name: server1 ip: 10.10.10.1 - name: server2 ip: 10.10.10.2 - name: server3 ip: 10.10.10.3 global: mount_path: /data/1/oms ghana_server_port: 8090 nginx_server_port: 8089 # tsdb_enabled: "true" # tsdb_password: "" # tsdb_service: "INFLUXDB" # tsdb_url: "10.10.10.1:8086" # tsdb_username: "admin" regions: - cm_location: 1 cm_is_default: true cm_region: hz cm_url: http://10.10.10.1:8088 cm_nodes: - 10.10.10.1 - 10.10.10.3 - cm_location: 2 cm_is_default: false cm_region: bj cm_url: http://10.10.10.2:8088 cm_nodes: - 10.10.10.2 ``` ```shell [admin@test ~]$ obd cluster deploy oms -c oms-config.yaml ``` ```shell Open ssh connection ok install oceanbase-ce-4.4.1.0 for local ok +------------------------------------------------------------------------------------------------------+ | Packages | +--------------+-------------------+------------------------+------------------------------------------+ | Repository | Version/Tag | Release | Hash | +--------------+-------------------+------------------------+------------------------------------------+ | oms | feature_4.2.11_ce | - | 26f5f1554fc5 | | oceanbase-ce | 4.4.1.0 | 100000032025101610.el7 | 547ad7ed9d402424c6a41fc281a30f46bd836871 | +--------------+-------------------+------------------------+------------------------------------------+ Repository integrity check ok Load param plugin ok Open ssh connection ok Initializes observer work home ok Initializes oms mount path ok Parameter check ok Remote oceanbase-ce-4.4.1.0-100000032025101610.el7-547ad7ed9d402424c6a41fc281a30f46bd836871 repository install ok Remote oceanbase-ce-4.4.1.0-100000032025101610.el7-547ad7ed9d402424c6a41fc281a30f46bd836871 repository lib check ok oms deployed Please execute ` obd cluster start oms ` to start Trace ID: 0c9ae43e-bbbf-11f0-8e7f-00163e514885 If you want to view detailed obd logs, please run: obd display-trace 0c9ae43e-bbbf-11f0-8e7f-00163e514885 ``` ```shell Wait for observer init ok +------------------------------------------------+ | oceanbase-ce | +--------------+---------+------+-------+--------+ | ip | version | port | zone | status | +--------------+---------+------+-------+--------+ | 10.10.10.1 | 4.4.1.0 | 2881 | zone1 | ACTIVE | | 10.10.10.2 | 4.4.1.0 | 2881 | zone2 | ACTIVE | | 10.10.10.3 | 4.4.1.0 | 2881 | zone3 | ACTIVE | +--------------+---------+------+-------+--------+ obclient -h10.10.10.1 -P2881 -uroot@sys -p'******' -Doceanbase -A cluster unique id: c121d9a7-cd68-567f-937a-6fcfaab80ef0-19a5dbbb699-00010404 +-----------------------------------------------------------+ | oms | +--------+-------------------+---------------+--------------+ | region | url | cm_is_default | nodes | +--------+-------------------+---------------+--------------+ | hz | 10.10.10.1:8089 | True | 10.10.10.1 | | bj | 10.10.10.2:8089 | False | 10.10.10.2 | +--------+-------------------+---------------+--------------+ obshell program health check ok display obshell dashboard ok +---------------------------------------------------------+ | obshell Dashboard | +--------------------------+------+--------------+--------+ | url | user | password | status | +--------------------------+------+--------------+--------+ | http://10.10.10.1:2886 | root | '******' | active | +--------------------------+------+--------------+--------+ oms running Trace ID: 7f71bf32-bbbf-11f0-b617-00163e514885 If you want to view detailed obd logs, please run: obd display-trace 7f71bf32-bbbf-11f0-b617-00163e514885 ``` ## 相关文档 部署成功后，即可通过浏览器访问 OMS 控制台页面，具体操作可参见《OceanBase 迁移服务》文档 [登录 OMS 社区版控制台](https://www.oceanbase.com/docs/community-oms-cn-1000000004253104)。 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线