快速部署命令 - 安装部署工具 OBD V4.0.0

快速部署命令

更新时间：2026-01-20 11:28:28

本文介绍 obd 的快速部署命令，使用快速部署命令可在不传入配置文件的情况下直接在本机部署并启动指定的组件。

您可以在每个命令中使用 -h/--help 选项查看命令的帮助信息，当命令执行报错时，您亦可使用 -v/--verbose 查看命令的详细执行过程。

obd demo

使用该命令可在不传入配置文件的情况下直接在本机以 OceanBase 数据库最小规格部署并启动指定的组件，固定部署名 demo，部署后使用命令 obd cluster list 查看集群列表时可以查看到该集群，也可以通过其他的集群命令进行管理，比如 obd cluster display demo 等。

obd demo [-c/--components]

选项说明见下表：

选项名	是否必选	数据类型	默认值	说明
-c/--components	否	string	oceanbase-ce,obproxy-ce,obagent,prometheus,grafana	组件列表，使用英文逗号（`,`）间隔。用于指定需要部署的组件。

该命令默认在当前用户的家目录下进行最小规格部署，部署的组件版本默认为最新版本。当前支持组件为：oceanbase-ce、oceanbase、oceanbase-standalone、obproxy-ce、obproxy、obagent、grafana、prometheus、ob-configserver。

说明

obd 自 V2.9.0 起支持使用 obd demo 命令部署 ob-configserver 组件；自 V3.2.0 起支持使用 obd demo 命令部署 oceanbase-standalone 组件；自 V3.4.0 起支持使用 obd demo 命令部署 oceanbase 和 obproxy 组件。

示例

使用时可以通过选项控制部署版本和配置，比如：

指定组件

部署社区版 OceanBase 数据库和 ODP
```
obd demo -c oceanbase-ce,obproxy-ce
```
仅部署 obconfigserver
```
obd demo -c ob-configserver
```

指定组件版本

指定组件版本部署

obd demo -c oceanbase-ce,obproxy-ce --oceanbase-ce.version=4.3.2.0

指定组件 hash 部署

obd demo -c oceanbase-ce,obproxy-ce --oceanbase-ce.package_hash=f38723204d49057d3e062ffad778edc1552a7c114622bf2a86fea769fbd202ea

自定义组件配置

本节以指定组件安装路径和组件端口为例，如需了解配置文件中的相关配置项可参考配置文件说明一文中 配置项说明 部分。

注意

该命令只支持通过选项传入一级配置（即 global 下第一级配置）。

统一指定组件安装路径

将 oceanbase-ce 和 obproxy-ce 部署到 /data/demo 下并根据组件建立对应的工作目录。
```
obd demo -c oceanbase-ce,obproxy-ce --home_path=/data/demo
```
指定特定组件的安装路径

将 oceanbase-ce 部署到家目录下并根据组件建立对应的工作目录，而 obproxy-ce 部署到 /data/demo/obproxy-ce。
```
obd demo -c oceanbase-ce,obproxy-ce --obproxy-ce.home_path=/data/demo/
```

指定组件端口

obd demo --oceanbase-ce.mysql_port=3881

obd perf

使用该命令可在不传入配置文件的情况下直接在本机以 OceanBase 数据库最大规格部署并启动指定的组件，固定部署名 perf，部署后使用命令 obd cluster list 查看集群列表时可以查看到该集群，也可以通过其他的集群命令进行管理，比如 obd cluster display perf 等。

说明

该命令自 obd V3.4.0 起新增。

obd perf [-c/--components]