0.obd-demo.md

# 快速部署命令

## obd demo

使用该命令可在不传入配置文件的情况下直接在本机部署并启动指定的组件，固定部署名 `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、obproxy-ce、obagent、grafana、Prometheus。

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

```bash
# 部署指定组件版本
obd demo -c oceanbase-ce,obproxy-ce --oceanbase-ce.version=3.1.3
# 指定部署特定组件——hash
obd demo -c oceanbase-ce,obproxy-ce --oceanbase-ce.package_hash=f38723204d49057d3e062ffad778edc1552a7c114622bf2a86fea769fbd202ea
# 指定部署全部组件的安装路径
## 将 oceanbase-ce 和 obproxy-ce 部署到 /data/demo 下并根据组件建立对应的工作目录
obd demo -c oceanbase-ce,obproxy-ce --home_path=/data/demo
# 指定部署全部组件的安装路径
obd demo --home_path=/path
# 指定部署特定组件的安装路径
## 将 oceanbase-ce 部署到家目录下并根据组件建立对应的工作目录，而 obproxy-ce 部署到 /data/demo/obproxy-ce
obd demo -c oceanbase-ce,obproxy-ce --obproxy-ce.home_path=/data/demo/
# 指定自定义组件配置
## 指定 oceanbase-ce 组件的 mysql_port
obd demo --oceanbase-ce.mysql_port=3881
```

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