---
title: "快速部署命令 - 安装部署工具 OBD V4.3.0 | OceanBase 文档中心"
description: 快速部署命令 本文介绍 obd 的快速部署命令，使用快速部署命令可在不传入配置文件的情况下直接在本机部署并启动指定的组件。 您可以在每个命令中使用 -h / --help 选项查看命令的帮助信息，当命令执行报错时，您亦可使用 -v / --verbose 查看命令的详细执行过程。 obd demo 使用该命令可在不传…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*Qq8pT6yBPTcAAAAAAAAAAAAADiGDAQ/original) 安装部署工具 OBDV 4.3.0

# 快速部署命令

更新时间：2026-04-25 17:24:25

[编辑](https://github.com/oceanbase/obd-doc/edit/V4.3.0/zh-CN/300.obd-command/000.obd-demo.md)  

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

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

## obd demo

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

```bash
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

  ```shell
  obd demo -c oceanbase-ce,obproxy-ce

  ```
 - 仅部署 obconfigserver

  ```shell
  obd demo -c ob-configserver

  ```

#### 指定组件版本

- 指定组件版本部署

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

  ```
 - 指定组件 hash 部署

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

  ```

#### 自定义组件配置

本节以指定组件安装路径和组件端口为例，如需了解配置文件中的相关配置项可参考 [配置文件说明](https://www.oceanbase.com/docs/common-obd-cn-1000000005623785) 一文中 **配置项说明** 部分。

#### 注意

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

- 统一指定组件安装路径

  将 oceanbase-ce 和 obproxy-ce 部署到 `/data/demo` 下并根据组件建立对应的工作目录。

  ```shell
  obd demo -c oceanbase-ce,obproxy-ce --home_path=/data/demo

  ```
 - 指定特定组件的安装路径

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

  ```shell
  obd demo -c oceanbase-ce,obproxy-ce --obproxy-ce.home_path=/data/demo/

  ```
 - 指定组件端口

  ```shell
  obd demo --oceanbase-ce.mysql_port=3881

  ```

## obd perf

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

#### 说明

obd 自 V3.4.0 提供最大规格部署命令（`obd pref`），并于 V4.0.0 起更新命令为 `obd perf`。

```bash
obd perf [-c/--components]

```

选项说明见下表：

| 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 |
| --- | --- | --- | --- | --- |
| -c/--components | 否 | string | oceanbase-ce,obproxy-ce,obagent,prometheus,grafana | 组件列表，使用英文逗号（`,`）间隔。用于指定需要部署的组件，部署的组件版本默认为 obd 镜像库中最新版本。当前支持组件为：oceanbase-ce、oceanbase、oceanbase-standalone、obproxy-ce、obproxy、obagent、grafana、prometheus、ob-configserver。 |
| --server | 否 | string | 当前机器 | 待部署 OceanBase 集群的服务器 IP 地址，未配置的情况下默认为当前机器。 |
| --username | 否 | string | 命令执行用户 | SSH 连接所用的用户名，未配置的情况下默认为当前执行命令的用户。obd 将会在该选项指定的用户家目录下进行最大规格部署。 |
| --password | 否 | string | 空 | 设置连接用户的登录密码。若目标机器中连接用户配置有密码，且未配置当前执行命令用户与目标机器中连接用户之间的 SSH 免密，需通过该选项指定用户密码。 |
| --port | 否 | int | 22 | SSH 连接所用的端口。 |
| --key-file | 否 | string | 空 | 用于 SSH 连接的私钥文件路径，需配置为绝对路径，用于基于私钥的 SSH 无密码身份验证。 |

#### 指定部署机器

- 指定部署机器并通过密码连接

  ```shell
  obd perf -c oceanbase-ce --server=10.10.10.1 --username=admin --password=******

  ```
 - 指定部署机器并通过私钥连接

  ```shell
  obd perf -c oceanbase-ce --server=10.10.10.1 --username=admin --key-file=/home/admin/.ssh/id_rsa

  ```

  #### 说明

  当私钥文件为默认路径（`~/.ssh/id_ rsa`）时，命令中可省略 `--key-file` 配置。

  ```shell
  obd perf -c oceanbase-ce,obproxy-ce

  ```shell
  obd perf -c ob-configserver

  ```

  ```shell
  obd perf -c oceanbase-ce,obproxy-ce --oceanbase-ce.version=4.3.2.0

  ```shell
  obd perf -c oceanbase-ce,obproxy-ce --oceanbase-ce.package_hash=f38723204d49057d3e062ffad778edc1552a7c114622bf2a86fea769fbd202ea

  ```

  将 oceanbase-ce 和 obproxy-ce 部署到 `/data/perf` 下并根据组件建立对应的工作目录。

  ```shell
  obd perf -c oceanbase-ce,obproxy-ce --home_path=/data/perf

  将 oceanbase-ce 部署到家目录下并根据组件建立对应的工作目录，而 obproxy-ce 部署到 `/data/perf/obproxy-ce`。

  ```shell
  obd perf -c oceanbase-ce,obproxy-ce --obproxy-ce.home_path=/data/perf/

  ```shell
  obd perf --oceanbase-ce.mysql_port=3881

  ```

 上一篇 下一篇 ![有帮助](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) 咨询热线