集群命令组
- 集群命令组
- obd cluster autodeploy
- obd cluster edit-config
- obd cluster deploy
- obd cluster start
- obd cluster list
- obd cluster display
- obd cluster reload
- obd cluster restart
- obd cluster redeploy(不要使用)
- obd cluster stop
- obd cluster destroy
- obd cluster upgrade
- obd cluster reinstall
- obd cluster tenant create
- obd cluster tenant show
- null
- obd cluster tenant drop
- obd cluster check4ocp
OBD 有多级命令，您可以在每个层级中使用 -h/--help 选项查看子命令的帮助信息。同样的，当各层级的子命令执行报错时，您亦可使用 -v/--verbose 查看命令的详细执行过程。
OBD 集群命令操作的最小单位为一个部署配置。部署配置是一份 yaml 文件，里面包含各个整个部署的全部配置信息，包括服务器登录信息、组件信息、组件配置信息和组件服务器列表等。
在使用 OBD 启动一个集群之前，您需要先注册这个集群的部署配置到 OBD 中。您可以使用 obd cluster edit-config 创建一个空的部署配置，或使用 obd cluster deploy -c config 导入一个部署配置。
obd cluster autodeploy
使用该命令可传入一个简易的配置文件，OBD 会根据目标机器资源自动生成最大规格的完整配置并部署启动集群。
obd cluster autodeploy <deploy name> -c <yaml path> [-f] [-U] [-A] [-s]example
obd cluster autodeploy test -c all-components.yaml
参数 deploy name 为部署名，可以理解为配置文件的别名。
obd cluster edit-config
修改一个部署配置，当部署配置不存在时创建。
obd cluster edit-config <deploy name>example
obd cluster edit-config test
参数 deploy name 为部署名，可以理解为配置文件的别名。
obd cluster deploy
使用该命令可以根据配置部署集群。
此命令会根据部署配置文件中组件的信息查找合适的镜像，并安装到本地仓库，此过程称为本地安装。再将本地仓库中存在合适版本的组件分发给目标服务器，此过程称为远程安装。
在本地安装和远程安装时都会检查服务器是否存在组件运行所需的依赖。此命令可以直接使用 OBD 中已注册的 deploy name 部署，也可以通过传入 yaml 的配置信息。
obd cluster deploy <deploy name> [-c <yaml path>] [-f] [-U] [-A]example
obd cluster deploy test -c all-components-min.yaml
obd cluster start
启动已部署的集群，成功时打印集群状态。
obd cluster start <deploy name> [flags]example
obd cluster start test -S
obd cluster list
显示当前 OBD 内注册的全部集群（deploy name）的状态。
obd cluster list
obd cluster display
展示指定集群的状态。obd cluster display <deploy name># example
obd cluster display test
obd cluster reload
重载一个运行中集群。当您使用 edit-config 修改一个运行的集群的配置信息后，可以通过 reload 命令应用修改。
并非全部的配置项都可以通过 reload 来应用。有些配置项需要重启集群，甚至是重新部署集群才能生效。请根据 edit-config 后返回的信息进行操作。
obd cluster reload <deploy name>example
obd cluster reload test
obd cluster restart
重启一个运行中集群。重启默认是无参重启。当您使用 edit-config 修改一个运行的集群的配置信息后，可以通过 obd cluster restart
obd cluster restart <deploy name>example
obd cluster restart test -c obproxy-ce --wp并非所有的配置项都可以通过 restart 来应用。有些配置项需要重部署集群才能生效。请根据 edit-config 后返回的信息进行操作。
obd cluster redeploy(不要使用)
重启一个运行中集群。当您使用 edit-config 修改一个运行的集群的配置信息后，可以通过 redeploy 命令应用修改
该命令会销毁集群，重新部署，您集群中的数据会丢失，请先做好备份。
obd cluster redeploy <deploy name> [-f]example
obd cluster redeploy test -f
参数 deploy name 为部署名，可以理解为配置文件的别名。
OBD 执行重启命令前会检查是否还有进程在运行中。这些运行中的进程可能是 start 失败留下的，也可能是因为配置与其他集群重叠，进程是其他集群的。但无论是哪个原因导致工作目录下有进程未退出，OBD 都会直接停止执行 obd cluster redeploy 命令。
选项 -f 为 --force-kill。作用为：检查到工作目录下有运行中的进程时，强制停止进程。使用该选项会强制停止运行中的进程，强制执行 obd cluster redeploy，非必填项。数据类型为 bool。默认不开启。
obd cluster stop
停止一个运行中的集群。
obd cluster stop <deploy name>
# example
obd cluster stop test -s server1
obd cluster destroy
销毁已部署的集群。如果集群处于运行中的状态，该命令会先尝试执行 stop，成功后再执行 destroy。
obd cluster destroy <deploy name> [-f]# example
obd cluster destroy test -f
参数 deploy name 为部署名，可以理解为配置文件的别名。
OBD 执行销毁命令前会检查是否还有进程在运行中。这些运行中的进程可能是 start 失败留下的，也可能是因为配置与其他集群重叠，进程是其他集群的。但无论是哪个原因导致工作目录下有进程未退出，OBD 都会直接停止执行 obd cluster destroy 命令。
选项 -f 为 --force-kill。作用为：检查到工作目录下有运行中的进程时，强制停止进程。使用该选项会强制停止运行中的进程，强制执行 obd cluster destroy，非必填项。数据类型为 bool。默认不开启。
obd cluster upgrade
使用该命令可升级一个已经启动的组件。
obd cluster upgrade <deploy name> -c <component name> -V <version> [tags]# example
obd cluster upgrade test -c oceanbase-ce -V 4.0.0.0 --usable=c63bb73384b17d74299b34fe3aceb0ae310fd319d2ccdb1acd39f31ba6673198
obd cluster reinstall
使用该命令可重新安装一个已部署的组件的仓库，新的仓库必须与当前仓库版本号相同。该命令在部署状态为 running 时，替换仓库后会使用无参启动，重新拉起组件。
obd cluster reinstall <deploy name> -c <component name> --hash <hash> [-f/--force]example
obd mirror list
+------------------------------------------------------------------+
| Mirror Repository List |
+----------------------------+--------+---------+------------------+
| SectionName | Type | Enabled | Update Time |
+----------------------------+--------+---------+------------------+
| oceanbase.community.stable | remote | True | 2022-12-16 10:41 |
| oceanbase.development-kit | remote | True | 2022-12-16 10:41 |
| local | local | - | 2022-12-16 10:52 |
+----------------------------+--------+---------+------------------+
Use `obd mirror list <section name>` for more details
obd mirror list oceanbase.community.stable | grep -e " oceanbase-ce " | grep -e " 4.0.0.0 "
| oceanbase-ce | 4.0.0.0 | 100000272022110114.el7 | x86_64 | 759074414c7b7b723013855353f62a7ba0aae0f493216ef2511825850ce77b51 |
| oceanbase-ce | 4.0.0.0 | 100000282022112511.el7 | x86_64 | debb18ab3c0b3d16f145c41cd21c30686863580b721d45ddaa068e6309e03b64 |
| oceanbase-ce | 4.0.0.0 | 102000032022120718.el7 | x86_64 | c63bb73384b17d74299b34fe3aceb0ae310fd319d2ccdb1acd39f31ba6673198 |obd cluster reinstall test -c oceanbase-ce --hash=c63bb73384b17d74299b34fe3aceb0ae310fd319d2ccdb1acd39f31ba6673198
obd cluster tenant create
创建租户。该命令仅对 OceanBase 数据库有效。该命令会自动创建资源单元和资源池，用户不需要手动创建。
obd cluster tenant create <deploy name> [-n <tenant name>] [flags]example
obd cluster tenant create test -n obmysql --max-cpu=2 --memory-size=2G --log-disk-size=3G --max-iops=10000 --iops-weight=2 --unit-num=1 --charset=utf8
obd cluster tenant show
使用该命令可查看集群中的租户，该命令仅对 OceanBase 数据库有效。
obd cluster tenant show <deploy name>example
obd cluster tenant show test
obd cluster tenant drop
使用该命令可以删除租户。该命令仅对 OceanBase 数据库有效。
该命令会自动删除对应的资源单元和资源池。
obd cluster tenant drop <deploy name> -n <tenant name>
# example
obd cluster tenant drop test -n obmysql
obd cluster chst
使用该命令可以转换配置风格。
obd cluster chst <deploy name> --style <STYLE> [-c/--components]# example
obd cluster chst test -c oceanbase-ce --style cluster
obd cluster check4ocp
检查当前配置是否满足 OCP 接管的条件。
obd cluster check4ocp <deploy name> [-c/--components] [-V/--version]# example
obd cluster check4ocp test -V 4.0.0