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

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

名词介绍

• OceanBase 数据库

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

• obd

  OceanBase Deployer，OceanBase 安装部署工具，简称为 obd。详细信息请参考 OceanBase 安装部署工具文档。

• ODP

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

• OBAgent

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

• obconfigserver

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

• Grafana

  Grafana 是一款开源的数据可视化工具，它可以将数据源中的各种指标数据进行可视化展示，以便更直观地了解系统运行状态和性能指标。详细信息可参见 Grafana 官网。

• Prometheus

  Prometheus 是一个开源的服务监控系统和时序数据库，其提供了通用的数据模型以及快捷数据采集、存储和查询接口。详细信息可参见 Prometheus 官网。

• Alertmanager

  Alertmanager 是一个开源的告警管理器，用于处理来自 Prometheus 等监控系统的告警，并提供告警的去重、分组、路由和静默等功能。详细信息可参见 Prometheus 官网。

前提条件

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

• 您的机器满足软硬件要求。详细信息，参考 软硬件要求。

• 生产环境下，您需要进行环境和配置检查，具体操作请参考 部署前配置 章节。

• 仅部署 OceanBase 数据库，至少需要 2vCPU、6 GB 内存、20 GB 磁盘的可用资源。需要注意，要求中的内存限制是指执行 free -g 命令后，输出中的 available 列对应的值。

• 部署 OceanBase 数据库及全部组件，至少需要 4vCPU、10 GB 内存、25 GB 磁盘的可用资源，推荐内存在 16 GB 以上。需要注意，要求中的内存限制是指执行 free -g 命令后，输出中的 available 列对应的值。

准备软件

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

• 在线部署：obd 所在机器需保证能访问外部网络，无需提前配置部署所需安装包，部署过程中 obd 会从远程镜像仓库获取部署所需安装包。

• 离线部署：部署过程中无需访问外部网络，您需提前将部署所需安装包上传至 obd 本地镜像库。选择离线部署时推荐直接下载所需版本的 OceanBase 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

离线部署

当您选择离线部署时，可参考本节命令下载并安装 OceanBase All in One。

您可从 OceanBase 软件下载中心 下载最新的 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

操作步骤

步骤一：启动图形化界面

1. 启动图形化界面

   命令行执行 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 访问图形化界面。

   • 可使用 nohup 或 screen 命令设置在后台执行 obd web 命令。

2. （可选）鼠标放置到图形化操作界面右上角的 中文 字符处可根据显示的语种单击切换中英文界面。

   

3. 在图形化界面中单击 开启体验之旅，在显示的 欢迎使用 OceanBase 部署向导 界面选择 OceanBase 及配套工具 模块，单击 安装 后进入 OceanBase 数据库部署界面。

步骤二：部署配置

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

1. 集群配置

   

   模块	说明
   部署配置	集群名称为 obd 专用部署产品的唯一名称，默认为 myoceanbase，可自定义，但不可和已有部署名重复。集群名需以英文字母开头、英文或数字结尾，可包含英文、数字和下划线，且长度在 2 ~ 32 个字符之间。您可通过 obd cluster list 命令查看 obd 中管理的集群。
   部署数据库	单击 版本 下的下拉框可自行选择 OceanBase 数据库的版本，单击对应组件后的 了解更多 可跳转查看对应组件的文档介绍。
   负载类型	单击 类型 下的下拉框可自行选择 OceanBase 集群的负载类型，不同类型负载均衡下有对应描述，方便了解各类型的适用场景。 说明 该模块仅在待部署的 OceanBase 数据库版本号不小于 V4.2.5 时展示。

2. 组件选择

   

   默认仅勾选 OBProxy 组件，您可通过单击 可选组件 下对应组件前的勾选框设置是否部署对应组件。组件版本固定为最新版本，单击对应组件后的 了解更多 可跳转查看对应组件的文档介绍。

   说明

   Grafana 和 AlertManager 组件的部署依赖 OBAgent 和 Prometheus 组件，Prometheus 组件的部署依赖 OBAgent 组件。具体体现如，勾选 Grafana 或 AlertManager 组件时会自动勾选 OBAgent 和 Prometheus 组件，取消勾选 OBAgent 组件时会自动取消勾选 Grafana、AlertManager 和 Prometheus 组件。

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

步骤三：节点配置

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

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

步骤四：集群配置

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

1. 集群配置

   

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

2. 组件配置

   

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

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

步骤五：预检查

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

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

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

步骤六：部署

其中：

• 部署成功后可复制显示的连接串连接到对应组件。在黑屏界面执行 OceanBase 数据库组件后的连接串会以 root@sys 用户连接到 OceanBase 集群，执行 OBProxy 组件后的连接串会以 root@proxysys 用户连接到 ODP。

• 单击输出的 Prometheus、Grafana、AlertManager 和 obshell Dashboard 组件对应的连接串可对应跳转到 Prometheus、Grafana、Alertmanager 和 obshell Dashboard 的登录界面，通过部署界面展示的账号密码即可登录。

  说明

  在阿里云或其他云环境下，可能出现程序无法获取公网 IP，从而输出内网地址的情况，此 IP 非公网地址，您需要使用正确的地址访问图形化界面。

• 在 部署报告 里单击对应组件前的展开图标即可查看部署的日志信息。单击对应组件列表里的 查看详情 后，单击对应命令后的复制图标即可复制命令，复制后可在中控机中执行查看对应组件的日志位置。

• 单击 复制信息，在复制保存 OceanBase 集群的所有账密信息后，您可选择单击 退出 退出部署程序，也可选择单击 创建业务租户，通过图形化页面创建业务租户。

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

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

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

相关操作

管理部署后的集群

您可执行如下命令对 obd 部署的集群进行管理。更多操作详见 集群命令组。

# 查看集群列表
[admin@test001 ~]$ obd cluster list

# 查看集群状态，以部署名为 myoceanbase 为例
[admin@test001 ~]$ obd cluster display myoceanbase

# 停止运行中的集群，以部署名为 myoceanbase 为例
[admin@test001 ~]$ obd cluster stop myoceanbase

# 销毁已部署的集群，以部署名为 myoceanbase 为例
[admin@test001 ~]$ obd cluster destroy myoceanbase

部署特定版本组件

使用 OceanBase All in One 部署时，OceanBase All in One 的包是基于 OceanBase 数据库版本进行迭代，若包中有其他组件存在更新版本，您可从 OceanBase 软件下载中心 下载最新版本的组件，参考如下步骤将其上传至本地镜像库，obd 部署时会自动获取本地镜像库中的最新版本。

1. 进到组件安装包所在目录下，将安装包添加至本地镜像库

   [admin@test001 rpm]$ obd mirror clone *.rpm
   

2. 查看本地镜像库中安装包列表

   [admin@test001 rpm]$ obd mirror list local