通过图形化界面部署 OceanBase 集群

本文以 x86 架构的 CentOS Linux 7.9 镜像作为环境介绍如何使用 obd 图形化界面部署 OceanBase 数据库。

背景信息

obd 自 V2.0.0 起支持图形化界面部署 OceanBase 数据库及相关组件，如 OBAgent、ODP、OCP Express 等，图形化界面配置简单，通过页面的引导配置即可完成单集群部署。

名词介绍

OceanBase 数据库

一款完全自研的企业级原生分布式数据库，详细信息请参见 OceanBase 数据库文档。
ODP

OceanBase Database Proxy，OceanBase 数据库代理，是 OceanBase 数据库专用的代理服务器，简称为 ODP（又称为 OBProxy）。详细信息请参见 OceanBase 数据库代理文档。
OCP Express

基于 Web 的 OceanBase 数据库 4.x 管理工具，融合在 OceanBase 数据库集群中，支持对数据库集群关键性能及基本数据库管理功能。详细信息请参考 OceanBase 云平台 Express (OCP Express)。
OBAgent

OBAgent 是 OceanBase 数据库监控采集框架，支持推、拉两种数据采集模式，可以满足不同的应用场景。
obconfigserver

OceanBase Configserver，obconfigserver 可提供 OceanBase 的元数据注册，存储和查询服务。详细信息请参见 ob-configserver。

前提条件

在开始之前，请确保您已满足以下条件：

您的机器满足软硬件要求。详细信息，参考官网《OceanBase 数据库》文档软硬件要求。
仅部署 OceanBase 数据库，至少需要 2vCPU、8 GB 内存、19 GB 磁盘的可用资源。
部署 OceanBase 数据库及全部组件，至少需要 4vCPU、10 GB 内存、25 GB 磁盘的可用资源，推荐内存在 16 GB 以上。
部署 OCP Express 组件需先安装配置 Java 环境，目前仅支持 JDK1.8 版本。详细操作可参考常见问题中 部署 OCP Express 前如何配置 Java 环境。

注意

obd 是通过 SSH 远程执行安装部署，所以您需通过 SSH 验证 Java 环境是否可用，详细操作请参见下文 Java 环境验证。

准备软件

使用 obd 图形化部署 OceanBase 数据库时，可以选择在线部署或离线部署两种部署方式。

在线部署：obd 所在机器需保证能访问外部网络，无需提前配置部署所需安装包，部署过程中 obd 会从远程镜像仓库获取部署所需安装包。
离线部署：部署过程中无需访问外部网络，您需提前将部署所需安装包上传至 obd 本地镜像库。选择离线部署时推荐直接下载所需版本的 all-in-one 安装包。

根据不同的部署方式有不同的准备软件方法，您可根据实际情况选择合适的方法准备软件。

在线部署

当您选择在线部署时，可以参考本节命令在中控机上安装 obd。

[admin@test001 ~]$ sudo yum install -y yum-utils
[admin@test001 ~]$ sudo yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
[admin@test001 ~]$ sudo yum install -y ob-deploy
[admin@test001 ~]$ source /etc/profile.d/obd.sh

离线部署

当您选择离线部署时，可参考本节命令下载并安装 all-in-one 安装包。

您可从 OceanBase 软件下载中心下载最新的 all-in-one 安装包，并将其复制到中控机中。执行如下命令解压并安装：

[admin@test001 ~]$ tar -xzf oceanbase-all-in-one-*.tar.gz
[admin@test001 ~]$ cd oceanbase-all-in-one/bin/
[admin@test001 bin]$ ./install.sh
[admin@test001 bin]$ source ~/.oceanbase-all-in-one/bin/env.sh

操作步骤

步骤一：启动图形化界面

启动图形化界面

命令行执行 obd web 命令启动图形化界面，单击输出的地址访问图形化界面。
```
[admin@test001 ~]$ obd web
start OBD WEB in 0.0.0.0:8680
please open http://10.10.10.1:8680
```
说明
- 图形化界面默认使用 8680 端口，您可使用 obd web -p <PORT> 命令指定端口。
- 在阿里云或其他云环境下，可能出现程序无法获取公网 IP，从而输出内网地址的情况，此 IP 非公网地址，您需要使用正确的地址访问图形化界面。
- obd web 命令绑定在 0.0.0.0 上，在多网卡部署的情况下，您可通过任意一个可访问的 IP 访问图形化界面。
（可选）鼠标放置到图形化操作界面右上角的中文字符处可根据显示的语种单击切换中英文界面。
在图形化界面中单击 开启体验之旅，在显示的 欢迎使用 OceanBase 部署向导 界面选择 OceanBase 及配套工具 模块，单击安装后进入 OceanBase 数据库部署界面。

步骤二：部署配置

您可在 部署配置 界面配置集群名称，负载类型和部署组件，部署配置 界面内容如下。

部署配置

模块	说明
部署配置	集群名称为 obd 专用部署产品的唯一名称，默认为 `myoceanbase`，可自定义，但不可和已有部署名重复。集群名需以英文字母开头、英文或数字结尾，可包含英文、数字和下划线，且长度在 2 ~ 32 个字符之间。您可通过 `obd cluster list` 命令查看 obd 中管理的集群。
部署数据库	单击版本下的下拉框可自行选择 OceanBase 数据库的版本，单击对应组件后的了解更多可跳转查看对应组件的文档介绍。
负载类型	单击类型下的下拉框可自行选择 OceanBase 集群的负载类型，可切换不同类型查看对应描述，了解各类型的适用场景。
可选组件	默认仅勾选 OBProxy 组件，您可通过单击可选组件下对应组件前的勾选框设置是否部署对应组件，组件版本固定为最新版本，单击对应组件后的了解更多可跳转查看对应组件的文档介绍。说明勾选 OCP Express 组件时会自动勾选 OBAgent 组件，取消勾选 OBAgent 组件时会自动取消勾选 OCP Express 组件。

配置完成之后单击 下一步 可进入到 节点配置 页面。

步骤三：节点配置

您可在 节点配置 界面配置数据库和组件节点，部署用户以及软件安装路径，节点配置 界面内容如下。

节点配置

模块	参数	说明
数据库节点配置	Zone 名称	配置 OceanBase 数据库中的 Zone 名称，可自定义。Zone 名称需以英文字母开头，英文或数字结尾，可包含英文、数字和下划线且长度在 2~32 个字符之间。部署多 Zone 的 OceanBase 集群必须有一个 Zone 与主 Zone 的 Region 相同。可单击 + 新增 Zone 或对应 Zone 后的删除图标新增或删除 Zone。
	OBServer 节点	配置 OceanBase 集群中的 OBServer 节点 IP，输入 IP 后单击键盘 Enter 可配置多个节点 IP。
	RootServer 节点	可通过下拉框在 OBServer 节点配置的 IP 中选择一个 IP 作为 OceanBase 集群的 RootServer 节点。对于多副本的 OceanBase 集群，其每个 Zone 都需指定一个 RootServer。
组件节点配置	OCP Express 节点	既可从下选框选择 OBServer 节点 IP，也可输入新的节点 IP，仅支持选择或输入一个节点。
	OBProxy 节点	支持配置多个节点，既可通过下选框选择 OBServer 节点 IP，也可输入新的节点 IP，输入 IP 后单击键盘 Enter 可配置多个节点 IP。
	obconfigserver 节点	支持配置多个节点，既可通过下选框选择 OBServer 节点 IP，也可输入新的节点 IP，输入 IP 后单击键盘 Enter 可配置多个节点 IP。为 obconfigserver 配置多个节点时，您需提前配置负载均衡，并在集群配置页面的组件配置模块打开更多配置按钮，配置 `vip_address` 和 `vip_port`。
部署用户配置	用户名	配置部署 OceanBase 集群的用户名，默认为当前进程的启动用户，支持自定义用户名。
	密码	用户名对应用户的登录密码，如各节点间已配置免密可免去输入密码。
	SSH 端口	默认为 22 端口，支持自定义 SSH 端口。
软件路径配置	软件路径	默认为部署用户的家目录，可自定义修改。配置后会在对应目录下创建 `myoceanbase` 文件夹。

配置完成之后单击 下一步 可进入到 集群配置 页面。

步骤四：集群配置

集群配置 界面可对集群进行配置，包括系统租户的管理员用户（root@sys）密码、数据和日志目录、数据库及各组件的端口和参数配置等，本节将分别进行介绍。

集群配置

参数	说明
模式配置	可选择最大占用或最小可用，最大占用模式将最大化利用环境资源，保证集群的性能与稳定性，推荐使用；最小可用模式配置满足集群正常运行的资源参数。两种模式的详细介绍可参考模式配置规则一文。
root@sys 密码	可点击随机生成，由 obd 自动生成随机字符串，也可自定义设置。自定义设置时，密码复杂度需满足如下要求：长度为 8~32 位字符包含以下四种类型字符中至少三种：数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符（`~!@#%^&_-+=\|(){}[]:;,.?/`）配置后可单击复制密码*，复制后保存已配置的密码。
数据目录	默认在节点配置页面中配置的软件路径下，需为以 `/` 开头的绝对路径，支持自定义设置，但需确保设置的目录为空。
日志目录	默认在节点配置页面中配置的软件路径下，需为以 `/` 开头的绝对路径，支持自定义设置，但需确保设置的目录为空。
SQL 端口	SQL 服务协议端口号，默认为 `2881`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
RPC 端口	远程访问的协议端口号，默认为 `2882`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
更多配置	可单击更多配置后的按钮查看对应的集群参数，可使用自动分配的值进行配置，也可自定义各个参数。说明您可通过在更多配置中设置 `scenario` 配置项来设置集群负载类型，未配置的情况下默认 `scenario` 为 `htap`。

组件配置

参数	说明
OCP Express 管理员密码	OCP Express 管理员账号的登录密码，可点击随机生成，由 obd 自动生成随机字符串，也可自定义设置。自定义设置时，密码复杂度需满足如下要求：长度为 8~32 位字符至少包含以下四种类型字符各 2 个：数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符（~!@#%^&_-+=`\|(){}[]:;',.?/）配置后可单击复制密码*，复制后保存已配置的密码。
OBProxy SQL 端口	ODP 监听端口，默认为 `2883`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
OBProxy Exporter 端口	OBProxy 的 Exporter 端口，用于 Prometheus 拉取 OBProxy 监控数据。默认为 `2884`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
OBProxy RPC 端口	默认为 `2885`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
OBAgent 监控服务端口	默认为 `8088`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
OBAgent 管理服务端口	默认为 `8089`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
OCP Express 端口	访问 OCP Express 的 HTTP 端口，默认为 `8180`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
obconfigserver 服务端口	obconfigserver 服务监听的端口，默认为 `8080`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
更多配置	可单击更多配置后的按钮查看对应的组件参数，可使用自动分配的值进行配置，也可自定义各个参数。说明若在节点配置中的 obconfigserver 节点处配置了多个节点，您需打开更多配置按钮，并配置 `vip_address` 和 `vip_port`，否则预检查时会报错。

全部配置完成后，单击 下一步 即可进入到 预检查 页面。

步骤五：预检查

在 预检查 页面查看所有配置信息，若发现问题可单击 上一步 进行修改；确认无误后，单击 预检查 进行检查。

若预检查报错，您可根据页面建议选择 自动修复（针对可自动修复的检查项）或者单击 了解更多方案 跳转至错误码文档，参考文档自行修改。所有报错修改后，可单击 重新检查 再次进行预检查。

预检查通过后，单击部署即可开始 OceanBase 数据库的部署。

步骤六：部署

其中：

部署成功后可复制显示的连接串连接到对应组件。在黑屏界面执行 OceanBase 数据库组件后的连接串会以 root@sys 用户连接到 OceanBase 集群，执行 OBProxy 组件后的连接串会以 root@proxysys 用户连接到 ODP。
单击输出的 OCP Express 组件的连接串可跳转到 OCP Express 的登录界面，通过部署界面展示的账号密码登录并修改密码后可使用图形化界面管理集群。

说明

在阿里云或其他云环境下，可能出现程序无法获取公网 IP，从而输出内网地址的情况，此 IP 非公网地址，您需要使用正确的地址访问图形化界面。
在 部署报告 里单击对应组件前的展开图标即可查看部署的日志信息。单击对应组件列表里的 查看详情 后，单击对应命令后的复制图标即可复制命令，复制后可在中控机中执行查看对应组件的日志位置。
可单击 一键复制，在复制保存 OceanBase 集群的所有账密信息后，单击完成退出部署程序。

注意

如需部署多个集群，您需在图形化界面单击完成结束当前 obd 进程后才可再次执行 obd web 命令进行下一集群的部署。