部署 OCP

本文以创建全新的 OceanBase 数据库作为 OCP 的 MetaDB 为例介绍如何使用 obd 图形化界面部署 OceanBase 云平台（后文简称 OCP）。

名词介绍

• OceanBase 数据库

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

• obd

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

• OBProxy

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

• OCP

  OceanBase Cloud Platform，OceanBase 云平台，简称为 OCP。详细信息请参见 OceanBase 云平台文档。

• MetaDB

  OCP 的重要组成部分，为 OCP 管理元信息及监控数据提供底层存储能力，OCP-Server 通过调用 MetaDB 数据提供 OceanBase 数据库全生命周期管理服务。

前提条件

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

• 已安装 obd V2.4.0 或以上版本，建议安装最新版本。安装 obd 的详细操作您可参见 安装 obd。

• 部署 OCP 的用户和机器资源满足部署要求，具体可参见官网《OceanBase 云平台》文档 安装规划 章节。

• 待部署 OCP 的机器中已安装 clockdiff 命令。

• 您的机器可以联网，或者 obd 本地镜像库中有部署所需安装包。

  可执行 obd mirror list local 命令查看本地镜像库中的安装包。若您通过 OceanBase All in One 安装 obd，本地镜像库中默认包含所有部署所需组件的安装包。

• 部署 OCP 时要求 MetaDB 的版本为 V4.2.1.8，使用全新的 OceanBase 数据库部署 OCP 时需确保 obd 的镜像库中包含 4.2.1.8 版本的 OceanBase 数据库软件包。目前未对使用已有 OceanBase 数据库作为 MetaDB 的场景做强制要求，建议使用的 OceanBase 数据库版本为 V4.2.1.8。

操作步骤

步骤一：启动白屏界面

1. 执行 obd web 命令启动白屏界面，单击输出的地址访问 obd 的图形化操作界面。

   [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 云平台 模块，将鼠标放置在 安装 按钮上，根据显示选择对应安装方式后进入 欢迎使用 OCP 部署向导 界面。

   您可根据实际情况在此界面选择 OCP 安装方式。此处以选择 使用全新的 OceanBase 数据库 为例介绍如何使用 obd 部署 OCP，其他详细介绍可参见 《云平台 OCP》中 使用图形化界面部署 OCP。

步骤二：部署配置

您可在 部署配置 界面配置 OCP 的集群名称、产品版本等。部署配置 界面内容如下。

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

步骤三：MetaDB 配置

您可在 MetaDB 配置 页面配置 MetaDB 集群的信息，如 OBServer 节点 IP、端口、目录和密码等，本节将分别为您介绍。

1. 部署用户配置

   部署用户配置 模块用于配置部署 OCP 的用户信息，界面如下图所示。

   

   说明

   为避免操作系统用户冲突，建议为 MetaDB 及 OCP 配置独立的操作系统用户。

   参数	说明
   用户名	提供主机操作系统的用户以便安装程序进行自动化配置，配置的用户名必须拥有免密执行 sudo 的权限。
   密码（可选）	用户名对应的密码，若已为该用户配置免密，可忽略此项配置。
   SSH 端口	默认为 22 端口，支持自定义端口。
   使用运行用户	勾选后会出现 运行用户名 的输入框，可为 OCP 服务配置独立的操作系统用户。

2. 节点配置

   您可在 OCP 节点配置 中配置 OCP 所在的主机 IP，并在 数据库节点配置 中配置 MetaDB 所在的 OBServer 节点 IP，界面如下图所示。

   

   参数	说明
   选择主机	配置 OCP 所在的主机 IP，支持部署多台主机，建议使用非 127.0.0.1 IP 地址。
   Zone 名称	配置 MetaDB 中的 Zone 名称，可自定义。Zone 名称需以英文字母开头，英文或数字结尾，可包含英文、数字和下划线且长度在 2~32 个字符之间。部署多 Zone 的 OceanBase 集群必须有一个 Zone 与主 Zone 的 Region 相同。可单击 + 新增 Zone 或对应 Zone 后的删除图标新增或删除 Zone。
   OBServer 节点	配置 MetaDB 中的 OBServer 节点 IP，输入 IP 后单击键盘 Enter 可配置多个节点 IP。 注意 当 OBServer 节点配置为 127.0.0.1 时，此 OceanBase 集群不支持扩展为分布式集群和配置主备租户。
   RootServer 节点	可通过下拉框在 OBServer 节点 配置的 IP 中选择一个 IP 作为 MetaDB 的 RootServer 节点。对于多副本的 OceanBase 集群，其每个 Zone 都需指定一个 RootServer。

3. 集群配置

   您可在 集群配置 模块配置 MetaDB 数据库的 root@sys 密码、目录、端口等信息，界面如下图所示。

   

   参数	说明
   root@sys 密码	可自定义输入，也可单击 随机生成，由 obd 生成随机字符串。root@sys 密码需要满足以下复杂度条件： 长度为 8~32 个字符 包含以下四种类型字符中至少三种：数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符（~!@#%^&*_-+=|(){}[]:;,.?/）
   软件安装路径	MetaDB 的安装路径，默认在部署用户的家目录下创建 oceanbase 目录，可自定义修改，您需拥有对应目录的读写权限。
   数据路径	MetaDB 的数据存放路径，需为以 / 开头的绝对路径，支持自定义设置。您需拥有对应目录的读写权限，且确保设置的目录为空。
   日志路径	MetaDB 的日志存放路径，需为以 / 开头的绝对路径，支持自定义设置。您需拥有对应目录的读写权限，且确保设置的目录为空。
   SQL 端口	SQL 服务协议端口号，默认为 2881，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
   RPC 端口	远程访问的协议端口号，默认为 2882，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
   更多配置	（可选）单击可查看并配置 OceanBase 集群配置项，您可使用自动分配的值进行配置，也可自定义各个参数。OceanBase 集群配置项的详细介绍可参见《OceanBase 数据库》文档 配置项 章节。

   注意

   需保证 软件路径、数据路径 及 日志路径 所在目录的磁盘空间充足，否则将部署失败。

4. OBProxy 配置

   OBProxy 配置 模块可以配置 OBProxy 的节点、端口和路径等信息，界面如下图所示。

   

   参数	说明
   OBProxy 节点	配置部署 OBProxy 的机器 IP，仅支持配置一个 IP，即仅支持单节点 OBProxy 安装，建议使用非 127.0.0.1 IP 地址。
   SQL 端口	OBProxy 监听端口，默认为 2883，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
   Exporter 端口	OBProxy prometheus 监听端口，默认为 2884，可自定义设置（仅支持 1025~65535 范围），需确保设置的端口未被占用。
   软件路径	OBProxy 的安装路径，默认在部署用户的家目录下创建 obproxy 目录，可自定义修改，您需拥有对应目录的读写权限。
   更多配置	（可选）单击可查看并配置 OBProxy 配置项，您可使用自动分配的值进行配置，也可自定义各个参数。

全部配置完成后可单击 下一步 进入 OCP 配置 页面。

步骤四：OCP 配置

您可在 OCP 配置 页面配置 OCP 服务及租户信息，本节将分别为您介绍。

1. 服务配置

   您可在 服务配置 模块配置 OCP 的登录密码、路径、URL 及端口，界面如下图所示。

   

   参数	说明
   Admin 密码	配置 OCP 管理员账号的登录密码，可自定义输入，也可单击 随机生成，由 obd 生成随机字符串。密码需要满足以下复杂度条件： 长度为 8~32 位字符 包含以下四种类型字符中至少三种：数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符（~^*{}[]_-+） 单击 复制密码 可复制配置的 Admin 密码。 说明 仅当部署的 OCP 版本为 V4.2.2 及之后版本时使用上述密码条件进行校验，部署的 OCP 为 V4.2.2 之前版本时，密码复杂度条件为： 长度为 8~32 位字符 支持字母、数字和特殊字符，且至少包含大、小写字母、数字和特殊字符各 2 个 支持的特殊字符为 ~^*{}[]_-+
   软件路径	OCP 的安装路径，默认在部署用户的家目录下创建 ocp 目录，可自定义修改，您需拥有对应目录的读写权限。
   日志路径	OCP 的日志存放路径，默认在用户家目录下创建 logs 目录，可自定义修改，您需拥有对应目录的读写权限。
   软件包路径	OCP 中存放软件包（如 OBProxy、OBAgent 等）的路径，默认在用户家目录下创建 software 目录，可自定义修改，您需拥有对应目录的读写权限。 说明 若本地仓库中存在 OceanBase 数据库和 OBProxy 的安装包，obd 会在部署 OCP 过程中自动识别并上传最新版本的 OceanBase 数据库和 OBProxy 安装包到该目录下。
   ocp.site.url	外部访问 OCP 网站的地址，要求是以 http/https 开始，包含 VIP 地址/域名/端口的网址，且结尾不含斜杠（/），比如 http://localhost:8080。 设置完成后可单击 URL 后的 校验 按钮验证设置内容格式是否符合要求，符合要求会在 URL 文本框下显示 “当前校验成功，请进行下一步”。若校验失败，请根据提示信息进行修改并重新校验。
   服务端口	OCP 的服务监听端口，默认为 8080，支持自定义端口。

2. 资源规划

   OCP 服务在运行过程中会有计算和存储资源开销，您可在 资源规划 模块根据待管理的对象规模进行资源规划，包括 OCP 服务、MetaDB 和 MonitorDB，界面如下图所示。

   

   说明

   部署 OCP 的机器需参照 OCP 的安装规划要求进行，详细介绍可参见《云平台 OCP》中 安装规划 章节。

   模块	参数	说明
   资源规划	预计管理主机数量（台）：	计划使用 OCP 管理的主机数，默认管理 10 台以下主机，可根据实际情况修改。
   资源配置	OCP 应用内存（GiB）	分配给 OCP 主机的内存资源，默认分配 4GiB，内存资源的配置与 OCP 管理的主机数量相关，详细介绍可参见 《云平台 OCP》中 主机规划 一文。
   元信息租户配置	租户名称	元信息租户名称，默认为 ocp_meta，支持自定义。
   	密码	配置元信息租户的 root 用户密码，可自定义输入，也可单击 随机生成，由 obd 生成随机字符串。自定义密码需要满足以下复杂度条件： 长度为 8~32 个字符 支持字母、数字和特殊字符，且至少包含大、小写字母、数字和特殊字符各 2 个 支持的特殊字符为 ~!@#%^&*_-+=`|(){}[]:;',.?/ 单击 复制密码 可复制配置的元信息租户 root 用户密码。
   	CPU（VCPUS）	为元信息租户分配的 CPU 资源，默认为 2VCPUS，支持调整。
   	内存（GiB）	为元信息租户分配的内存资源。默认为 4GiB，支持调整。
   监控数据租户配置	租户名称	监控数据租户名称，默认为 ocp_monitor，支持自定义。
   	密码	配置监控数据租户的 root 用户密码，可自定义输入，也可单击 随机生成，由 obd 生成随机字符串。自定义密码需要满足以下复杂度条件： 长度为 8~32 个字符 支持字母、数字和特殊字符，且至少包含大、小写字母、数字和特殊字符各 2 个 支持的特殊字符为 ~!@#%^&*_-+=`|(){}[]:;',.?/ 单击 复制密码 可复制配置的监控数据租户 root 用户密码。
   	CPU（VCPUS）	为监控数据租户分配的 CPU 资源，默认为 2VCPUS，支持调整。
   	内存（GiB）	为监控数据租户分配的内存资源。默认为 8GiB，支持调整。

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

步骤五：预检查

您可在 预检查 页面查看所有配置信息，若发现问题可单击 上一步 进行修改；确认无误后，单击 预检查 进行检查，系统将验证您的环境是否满足安装、配置 MetaDB 与 OCP 的所有要求。

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

预检查通过后单击 下一步 即可进入 部署 页面开始 OCP 的部署。

步骤六：部署

部署过程中，部署页面 会输出部署日志，您可通过 部署日志 模块查看详细安装日志。

• 若部署失败，请查看日志信息获取失败原因，并联系技术支持同学进行处理，或到官网 问答区 进行提问，会有专业人员为您解决。待定位安装失败问题原因且修复问题后，单击 重新部署 ，在弹出的确认窗口后单击 确认，系统将清理当前失败的 OCP 安装环境，并重新执行安装程序。

• 若部署成功，可单击 复制信息，在复制保存 OCP 的访问地址及账密信息后，单击 完成 退出部署程序。

相关文档

• 部署 OCP 后的使用可参见官网 OceanBase 云平台 文档。

• 可使用 obd 命令管理部署的 OCP 集群，命令介绍可参见 集群命令组。

• 如需升级 OCP，具体操作可参见 通过图形化界面升级 OCP。