使用 obd 白屏部署集中式版

本文介绍如何使用 obd 白屏安装 OceanBase 数据库。

功能适用性

obd 白屏部署仅适用于 OceanBase 集中式数据库 V4.2.5 BP4 及之后版本。

为方便通过 obd 部署 OceanBase 集中式数据库，OceanBase 提供了统一的安装包 oceanbase-standalone-all-in-one-4.2.5_xxx_xxx_xxxxxxxx.el7.x86_64.tar.gz。该安装包包含 obd、OBClient、OceanBase 数据库、obagent、Grafana 和 Prometheus。

部署前准备

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

准备部署所需的机器资源，且机器满足软硬件要求。详细信息可参见准备服务器。
生产环境下，您需要进行环境和配置检查，具体操作请参考部署前配置章节。
已经获取部署所需的安装包 oceanbase-standalone-all-in-one-4.2.5_xxx_xxx_xxxxxxxx.el7.x86_64.tar.gz。详细信息参见准备安装包。
说明
- 通过 obd 和 OCP 部署集中式版使用的安装包是不同的，在获取安装包的时候，务必确保获取到相应的安装包。
- 可以通过 OceanBase 官网软件下载中心获取集中式版安装包。该安装包配置有试用版许可证（非生产用途），有效期为 180 天，仅供您进行学习、测试或适配使用，不提供技术支持及 SLA 保障，不得用于营利性、商业性或生产目的。试用许可证过期后，您将无法继续使用数据库功能。如果您需要将软件用于生产环境，或营利性、商业性目的，并需要专业的技术支持保障，请联系 OceanBase 获取商业版许可。
部署用户拥有 sudo 权限。

说明

部署 OceanBase 集中式版推荐使用 admin 用户，也可以使用其他用户(不推荐 root 用户)。但是要求用户具备 sudo 权限和作为数据库相关目录的所有者。
如果跨机器部署，需要当前机器可以访问待创建 OceanBase 集群的机器，建议机器之间设置免密登录，免密登录设置可参考（可选）设置无密码 SSH 登录。

使用 obd 白屏部署

步骤一：解压集中式版安装包

执行如下命令解压安装包 oceanbase-standalone-all-in-one-4.2.5_xxx_xxx_xxxxxxxx.el7.x86_64.tar.gz。

[admin@test001 ~]$ tar -xzf oceanbase-standalone-all-in-one-4.2.5_xxx_xxx_xxxxxxxx.el7.x86_64.tar.gz

步骤二：安装 obd

安装 obd。

进入 oceanbase-standalone-all-in-one 的安装目录，执行 install_obd.sh 脚本安装 obd。

[admin@test001 oceanbase-standalone-all-in-one]$ bash bin/install_obd.sh

注意

执行 install_obd.sh 命令不需要加 sudo 。

该脚本会安装 obd 和 OBClient，并将安装目录下 rpms 目录中的所有安装包复制到 obd 的本地镜像库中，同时关闭远程镜像库。

Disable remote ok
Trace ID: 7bd73a1a-0e08-11f0-b275-00163e49899d
If you want to view detailed obd logs, please run: obd display-trace 7bd73a1a-0e08-11f0-b275-00163e49899d

add auto set env logic to profile: /root/.bash_profile

Execute this command to apply the environment config：` source ~/.oceanbase-all-in-one/bin/env.sh `

应用环境配置。

obd 安装完成后，需要应用环境配置，您可复制并执行 obd 安装完后输出的 source ~/.oceanbase-all-in-one/bin/env.sh 命令。

[admin@test001 oceanbase-standalone-all-in-one]$ source ~/.oceanbase-all-in-one/bin/env.sh

步骤三：查看机器可用内存

为了确保能够顺利完成 OceanBase 数据库的安装，安装之前，建议查询下机器的可用内存，确保可用内存满足数据库的资源要求。

运行以下命令，查看内存：

free -g

返回结果如下：

              total        used        free      shared  buff/cache   available
Mem:            174          38           6           0         129         123
Swap:             0           0           0

此处需要保障 available 的 Mem 值足够满足准备服务器内 服务器配置要求内 的配置，如果不够，可以尝试清理缓存来释放资源或者更换服务器。

执行以下命令，清理缓存：

sudo sysctl -w vm.drop_caches=3
# 或
sudo echo 3 > /proc/sys/vm/drop_caches

清理完缓存之后，可以运行以上命令，再次确认可用内存是否满足 OceanBase 数据库的要求。

步骤四：启动图形化界面

启动图形化界面

命令行执行 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 访问图形化界面。
- 执行 obd web 命令不需要加 sudo 。
（可选）鼠标放置到图形化操作界面右上角的中文字符处可根据显示的语种单击切换中英文界面。
在图形化界面中单击 开启体验之旅，在显示的 欢迎使用 OceanBase 部署向导 界面选择 OceanBase 及配套工具 模块，单击安装后进入 OceanBase 数据库部署界面。

步骤五：部署配置

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

部署配置

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

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

步骤六：节点配置

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

节点配置

模块	参数	说明
数据库节点配置	Zone 名称	配置 OceanBase 数据库中的 Zone 名称，可自定义。Zone 名称需以英文字母开头，英文或数字结尾，可包含英文、数字和下划线且长度在 2~32 个字符之间。
数据库节点配置	OBServer 节点	配置 OceanBase 集群中的 OBServer 节点 IP，此处只能输入一个 IP。
组件节点配置	Prometheus 节点	配置完 OBServer 节点 IP 后，会自动配置 Prometheus 节点 IP，如果 Prometheus 组件部署的节点与 OBServer 节点不一致，可以在此处手动填写节点 IP。注意配置与 OBServer 节点不同的节点，需要以下要求： obd 能访问到各个节点。部署 Prometheus 的机器能够访问 OBServer 所在节点。
组件节点配置	Grafana 节点	配置完 OBServer 节点 IP 后，会自动配置 Grafana 节点 IP，如果 Grafana 组件部署的节点与 OBServer 节点不一致，可以在此处手动填写节点 IP。注意配置与 OBServer 节点不同的节点，需要以下要求： obd 能访问到各个节点。部署 Grafana 的机器能够访问 OBServer 所在节点和 Prometheus 所在的节点。
部署连接配置	用户名	配置部署 OceanBase 集群的用户名，默认为当前进程的启动用户，支持自定义用户名。
	密码	对应用户登录服务器节点的密码，如各节点间已配置免密可免去输入密码。
	SSH 端口	默认为 22 端口，支持自定义 SSH 端口。
软件路径配置	软件路径	默认为部署用户的家目录，可自定义修改。配置后会在对应目录下创建集群名称同名文件夹。

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

步骤七：集群配置

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

集群配置

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

组件配置

参数	说明
Grafana 密码	Grafana 管理员账号的登录密码，可单击随机生成，由 obd 自动生成随机字符串，也可自定义设置。自定义设置时，密码复杂度需满足如下要求：长度为 8~32 个字符至少包含以下四种类型字符各 2 个：数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符（~!@#%^&*_-+=\|(){}[]:;,.?/`$"<></code>） `配置后可单击复制密码，复制后保存已配置的密码。`
Prometheus 密码	Prometheus 服务的登录密码，可单击随机生成，由 obd 自动生成随机字符串，也可自定义设置。自定义设置时，密码复杂度需满足如下要求：长度为 8~32 个字符至少包含以下四种类型字符各 2 个：数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符（~!@#%^&*_-+=\|(){}[]:;,.?/`$"<></code>） `配置后可单击复制密码，复制后保存已配置的密码。`
OBAgent 监控服务端口	默认为 `8088`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
OBAgent 管理服务端口	默认为 `8089`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
Prometheus 服务端口	Prometheus 服务监听的端口，默认为 `9090`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
Grafana 服务端口	访问 Grafana 页面时使用的 HTTP 端口，默认为 `3000`，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
更多配置	可单击更多配置前的展开按钮查看并配置对应的组件参数，可使用自动分配的值进行配置，也可自定义各个参数。

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

步骤八：预检查

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

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

预检查

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

步骤九：部署

其中：

部署成功后可复制显示的连接串连接到对应组件。在黑屏界面执行 OceanBase 数据库组件后的连接串会以 root@sys 用户连接到 OceanBase 集群。
单击输出的 Prometheus、Grafana 组件对应的连接串可对应跳转到 Prometheus、Grafana 的登录界面，通过部署界面展示的账号密码即可登录。

说明

在阿里云或其他云环境下，可能出现程序无法获取公网 IP，从而输出内网地址的情况，此 IP 非公网地址，您需要使用正确的地址访问图形化界面。
在 部署报告 里单击对应组件前的展开图标即可查看部署的日志信息。单击对应组件列表里的 查看详情 后，单击对应命令后的复制图标即可复制命令，复制后可在中控机中执行查看对应组件的日志位置。
单击 复制信息，在复制保存 OceanBase 集群的所有账密信息后，您可选择单击退出退出部署程序，也可选择单击 创建业务租户，通过图形化页面创建业务租户。建议为 OceanBase 集群创建业务租户，sys 租户仅用于管理集群，如将其作为业务租户使用，可能会引起系统运行异常。

（可选）步骤十：创建业务租户

在 OceanBase 集群部署成功后，单击部署成功页面右下角的 创建业务租户 按钮，进入创建业务租户流程，您可参照下表介绍配置租户相关信息

参数	说明
租户名称	设置待新建租户的租户名。租户名需满足如下要求：长度为 2 ~ 32 个字符。可包含大小写英文字母、数字和下划线，但需以英文字母开头，并以英文或数字结尾。
租户模式	可通过下拉框中选择 MySQL 模式或 Oracle 模式。说明在创建 Oracle 模式时，白屏页面不支持设置密码，需用户在 Oracle 租户创建后，登录数据库手动设置密码。
租户 root 密码	可单击随机生成，由 obd 自动生成随机字符串，也可自定义设置。自定义设置时，密码复杂度需满足如下要求：长度为 8~32 位字符。包含以下四种类型字符中至少三种：数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符（`~!@#%^&_-+=\|(){}[]:;,.?/`）。配置后可单击复制密码*，复制后保存已配置的密码。
模式配置	可选择最大占用、最小可用或自定义模式。最大占用：默认占用集群全部剩余资源创建业务租户，且不可修改。最小可用：默认按照租户所需的最小资源创建业务租户，且不可修改。自定义：手动设置 CPU、内存、日志盘大小。
字符集	默认为 `utf8mb4`，可通过下拉框中选择其他字符集。
表名大小写敏感	可通过下拉框进行设置，支持设置为 `0` `1` 或 `2`。 `0`：表名将按照指定的大小写形式进行存储，并以区分大小写形式进行比较。 `1`：表名将按照小写形式进行存储，并以不区分大小写形式进行比较。 `2`：表名将按照指定的大小写形式进行存储，并以不区分大小写形式进行比较。
时区	默认为 (GMT+08:00)中国标准时间，可通过下拉框选择其他时区。
IP 地址白名单	可选择自定义设置可访问的 IP，或设置为所有 IP 都可访问。选择自定义设置时，可在自定义 IP 下的输入框中指定允许登陆的客户端 IP，输入 IP 后单击键盘 Enter 键或输入英文逗号（`,`）可配置多个节点 IP。光标悬停在查看配置说明上可查看配置 IP 的说明。说明自定义时，设置为 `%` 表示所有客户端都可以连接，存在访问安全风险，请谨慎操作。

配置完成后单击 下一步:创建业务租户，系统将创建对应租户。创建完成后页面会展示业务租户信息，包含租户名、root 用户密码、连接字符串等信息。单击左下角退出按钮，即可退出创建租户流程。之后您可选择单击部署结果页面的退出按钮，退出部署程序；也可选择继续单击 创建业务租户 继续创建下一个业务租户。

创建成功