使用图形化界面部署 OCP

本节为您介绍如何通过 OceanBase 安装部署工具（OceanBase Deployer，OBD）白屏化部署 OCP。

MetaDB 是 OCP 的重要组成部分，MetaDB 为 OCP 管理元信息及监控数据提供底层存储能力，OCP-Server 通过调用 MetaDB 数据为您提供 OceanBase 数据库全生命周期管理服务。您可选择以下任意一种 MetaDB 的配置方式来部署 OCP：

• （推荐）创建全新的 OceanBase 数据库作为 OCP 的 MetaDB。

• 使用已有的 OceanBase 数据库作为 OCP 的 MetaDB。

前提条件

• 仅支持部署 V4.0.3 及以上版本的 OCP-CE。

• 已安装并配置 Java 环境，目前仅支持 JDK1.8 版本，并要求构建版本号至少需为 161。

• 当 OCP 宿主机上存在历史版本的 OCP 软件包解压目录时，为避免与新版本软件包的解压目录混淆，您需对旧的解压目录进行重命名或删除操作。

• 已参见 安装准备 获取 ocp-all-in-one-4.3.4-YYYYMMDDhhmmss.el7.x86_64.tar.gz 软件包，将软件包上传至 OCP 宿主机的任一目录，并执行如下命令进行解压。

  tar zxf ocp-all-in-one-4.3.4-YYYYMMDDhhmmss.el7.x86_64.tar.gz
  

（推荐）创建全新的 OceanBase 数据库作为 OCP 的 MetaDB

步骤一：启动 obd

1. 登录 OCP 宿主机。

2. 执行如下命令进入解压后软件包的 bin 目录下，并安装部署程序。

   cd ocp-all-in-one/bin && bash install.sh
   

3. 执行如下命令，使环境变量生效。

   source ~/.oceanbase-all-in-one/bin/env.sh
   

4. 执行 obd web install ，在返回信息中获取部署向导页面的 IP 地址。

   

步骤二：进入 OCP 部署向导页面

1. 通过浏览器访问 步骤一 获取的 IP 地址，进入部署向导页面，单击 开启体验之旅。

   

2. 选择 OCP 产品，单击 确定。

   

3. 选择 创建全新的 OceanBase 数据库，用以作为 OCP 的 MetaDB，并单击 确定。

   

步骤三：配置部署相关信息

1. 自定义待管理的 OceanBase 集群名称。

   该名称具有唯一性，且集群名称必须以英文字母开头，英文或数字结尾，长度为 2~32 字符。

2. 选择要部署的产品版本。

   OceanBase 与 OBProxy 的版本具有关联性。例如，当选择部署 V4.1.0 及以上版本的 OceanBase 数据库时，仅支持部署 V4.1.0 及以上版本的 OBProxy。

步骤四：配置 MetaDB

创建全新的 MetaDB，OCP-Server 将访问本地 MetaDB 以获得更好的服务可靠性。

1. 配置部署用户。

   说明

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

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

2. 配置 OCP 节点。

   选择部署 OCP 的主机，支持配置多台主机。

   注意

   主机地址不能为 127.0.0.1。

3. 配置数据库节点。

   参数	说明
   Zone 名称	可保持默认也可自定义。Zone 名称必须以英文字母开头，英文或数字结尾，长度为 2~32 字符。部署多 Zone 的 OceanBase 集群必须有一个 Zone 与主 Zone 的 Region 相同。
   OBServer 节点	选择部署 MetaDB 的主机，支持配置多台主机。
   RootServer 节点	您需选择一个 IP 作为 RootService 所在的机器。多副本的 OceanBase 集群，其每个 Zone 都需指定一个 RootServer。

   默认添加 1 个 Zone 的信息，如果您希望部署的集群 Zone 的个数大于 1 个，您可以在下方单击 新增 按钮，增加 Zone 信息。如果部署的集群 Zone 的个数小于 1 个，您可以单击 Zone 后面的删除图标。

4. 配置集群相关信息。

   参数	说明
   root@sys 密码	支持自定义或随机生成。密码需要满足以下复杂度条件： 长度为 8~32 个字符 至少包含数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符四种类型中的三种，支持的特殊字符为 ~!@#%^&*_-+=|(){}[]:;,.?/。
   软件路径	MetaDB 的安装路径，默认值为 /部署用户/oceanbase，支持自定义目录，您需拥有对应目录的读写权限。
   数据路径	MetaDB 的数据存储路径，默认值为 /data/1，支持自定义目录。您需拥有对应目录的读写权限，且确保设置的目录为空。
   日志路径	MetaDB 的日志存储路径，默认值为 /data/log1，支持自定义目录。您需拥有对应目录的读写权限，且确保设置的目录为空。
   SQL 端口	MetaDB 的 SQL 端口，默认值为 2881，支持自定义端口（仅支持 1024~65535 范围），需确保设置的端口未被占用。
   RPC 端口	MetaDB 的 RPC 端口，默认值为 2882，支持自定义端口（仅支持 1024~65535 范围），需确保设置的端口未被占用。
   更多配置	（可选）单击可查看并配置 OceanBase 集群配置项，您可使用自动分配的值进行配置，也可自定义各个参数。OceanBase 集群相关参数说明，请参见 查看参数列表。

   注意

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

5. 配置 OBProxy 相关信息。

   参数	说明
   OBProxy 节点	选择部署 OBProxy 的主机。仅支持配置一个 IP，即仅支持单节点 OBProxy 安装。
   SQL 端口	OBProxy 的 SQL 端口，默认值为 2883，支持自定义端口（仅支持 1024~65535 范围），需确保设置的端口未被占用。
   Exporter 端口	OBProxy prometheus 监听端口，默认值为 2884，支持自定义端口（仅支持 1024~65535 范围），需确保设置的端口未被占用。
   软件路径	OBProxy 的安装路径，默认值为 /部署用户/obproxy，支持自定义目录，您需拥有对应目录的读写权限。
   更多配置	（可选）配置 OBProxy 集群参数。相关参数说明，请参见 OBProxy 参数说明。

步骤五：配置 OCP

本步骤用于配置 OCP 服务及租户信息。

1. 配置 OCP 服务。

   参数	说明
   Admin 密码	OCP 管理员的账号密码，密码需要满足以下复杂度条件： 长度为 8~32 个字符 至少包含数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符四种类型中的三种，支持的特殊字符为 ~^*{}[]_-+。
   软件路径	OCP 的安装路径，默认值为 /部署用户/ocp，支持自定义软件路径，您需拥有对应目录的读写权限，且保证此路径的磁盘空间充足。
   日志路径	OCP 的日志存放路径，默认值为 /home/部署用户/logs，支持自定义日志路径，您需拥有对应目录的读写权限，且保证此路径的磁盘空间充足。
   软件包路径	OCP Agent 的安装路径，默认值为 /home/部署用户/software，支持自定义软件包路径，您需拥有对应目录的读写权限，且保证此路径的磁盘空间充足。
   ocp.site.url	外部访问 OCP 网站的地址。要求以 http/https 开始，包含 VIP 地址/域名/端口的网址，且结尾不含斜杠（/），比如 http://localhost:8080。 设置完成后，您可单击 校验 测试地址连通性。若校验失败，需根据提示信息进行修改。
   服务端口	OCP 的服务监听端口，默认值为 8080，支持自定义端口（仅支持 1024~65535 范围），需确保设置的端口未被占用。

2. 规划资源分配。

   OCP 服务在运行过程中会有大量的计算和存储开销，所以需要根据待管理的对象规模进行资源规划。同时，OCP 需要在 MetaDB 中配置必要的租户以实现对 OceanBase 数据库全生命周期管理，配置完成后，系统将自动创建 元信息租户 和 监控数据租户。

   1. 填写所管理的主机大小。

      系统默认管理 10 台以下的主机，您可根据实际情况进行修改。

   2. 配置内存资源。

      默认分配内存 16GiB。内存资源的配置与管理的主机数量相关，关于 OCP 主机资源规划详情，可参考 主机规划。

   3. 配置元信息租户信息。

      参数	说明
      租户名称	元信息租户名称，默认为 ocp_meta，支持自定义。
      密码	配置元信息租户的账号密码，密码支持随机生成或自定义。自定义密码需要满足以下复杂度条件： 长度为 8~32 个字符 至少包含数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符四种类型中的三种，支持的特殊字符为 ~!@#%^&*_-+=|(){}[]:;,.?/。
      CPU	为元信息租户分配 CPU 资源。默认 1VCPUS，支持调整。
      内存	为元信息租户分配内存资源。默认 2GiB，支持调整。

   4. 配置监控数据租户信息。

      参数	说明
      租户名称	监控数据租户名称，默认为 ocp_monitor，支持自定义。
      密码	配置监控数据租户的账号密码，密码支持随机生成或自定义。自定义密码需要满足以下复杂度条件： 长度为 8~32 个字符 至少包含数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符四种类型中的三种，支持的特殊字符为 ~!@#%^&*_-+=|(){}[]:;,.?/。
      CPU	为监控数据租户分配 CPU 资源。默认 2VCPUS，支持调整。
      内存	为监控数据租户分配内存资源。默认 4GiB，支持调整。

步骤六：环境预检查

OCP 安装信息配置完成后，您需先检查并确认配置信息，确定后开始预检查。

• 若配置有误，单击 上一步 返回配置页面进行修改。

  

• 若配置无误，单击 预检查，系统将验证您的环境是否满足安装、配置 MetaDB 与 OCP 的所有最低要求。

  • 若存在检查失败项，OCP 提供修复方案说明，您可参考修复方案对问题进行排查修复。针对可自动修复的检查项，支持单击 自动修复 进行修复。

    修复完成后，您可单击 重新检查 重新执行环境预检查程序。

  • 若检查通过，单击 下一步。

  

步骤七：部署 OCP

OCP 部署过程中，您可以通过 部署日志 模块查看详细安装日志。

• 若部署失败，请查看日志信息获取失败原因，并联系技术支持同学进行处理。待定位安装失败问题原因且修复问题后，单击 重新部署 ，系统将清理当前失败的 OCP 安装环境，并重新执行安装程序。

• 若部署成功，单击 完成 退出部署程序。在退出程序前，可复制访问地址及账密信息，用以登录所部署的 OCP 平台。

使用已有的 OceanBase 数据库作为 OCP 的 MetaDB

此方式适用于使用已有的 OceanBase 数据库作为 OCP 的 MetaDB。

步骤一：启动 obd

1. 登录 OCP 宿主机。

2. 执行如下命令进入解压后软件包的 bin 目录下，并安装部署程序。

   cd ocp-all-in-one/bin && sh install.sh
   

3. 执行如下命令，使环境变量生效。

   source ~/.oceanbase-all-in-one/bin/env.sh
   

4. 执行 obd web install ，在返回信息中获取部署向导页面的 IP 地址。

   

步骤二：进入 OCP 部署向导页面

1. 通过浏览器访问 步骤一 获取的 IP 地址，进入部署向导页面，单击 开启体验之旅。

   

2. 选择 OCP 产品，单击 确定。

   

3. 选择 使用已有的 OceanBase 数据库，用以作为 OCP 的 MetaDB，并单击 确定。

   

步骤三：配置部署相关信息

1. 自定义待管理的 OceanBase 集群名称。

   该名称具有唯一性，且必须以英文字母开头，可支持大小写字母、数字和下划线，长度为 2~32 字符。

2. 选择要部署的 OCP 版本。

步骤四：连接 OceanBase 集群

OCP 将根据所填写的 MetaDB 信息执行部署程序。

1. 填写 OceanBase 数据库的连接信息。

   OCP 将使用该连接信息的数据库作为 MetaDB 存储元信息及监控数据。

   参数	说明
   主机 IP	数据库访问 IP 地址，仅支持填写一个，用于 OCP 连接 MetaDB。
   访问端口	数据库连接访问端口。
   访问账号	数据库的访问账号，仅可使用 sys 租户，默认为 root@sys，支持自定义。
   访问密码	数据库 访问账号 的密码。

2. 确认信息无误后，单击 下一步，系统将校验该 MetaDB 是否连接成功。

步骤五：配置 OCP

1. 配置部署用户。

   说明

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

   参数	说明
   用户名	需提供主机操作系统的用户以便安装程序进行自动化配置，该用户名需具有 sudo 权限。
   用户密码	需输入 用户名 的对应密码。当主机已设置免密时，可忽略此项配置。
   SSH 端口	主机的 SQL 端口，默认值为 22。
   使用运行用户	（可选）为 OCP 配置独立运行服务的用户。

2. 配置 OCP 节点。

   选择部署 OCP 的主机，支持配置多台主机。

   注意

   主机地址不能为 127.0.0.1。

3. 配置 OCP 服务。

   参数	说明
   Admin 密码	OCP 管理员的账号密码，密码需要满足以下复杂度条件： 长度为 8~32 个字符 至少包含数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符四种类型中的三种，支持的特殊字符为 ~!@#%^&*_-+=|(){}[]:;,.?/$`'"<>\。
   软件路径	OCP 的安装路径，默认值为 /home/部署用户/ocp，支持自定义软件路径，您需拥有对应目录的读写权限，且保证此路径的磁盘空间充足。
   日志路径	OCP 的日志存放路径，默认值为 /home/部署用户/logs，支持自定义日志路径，您需拥有对应目录的读写权限，且保证此路径的磁盘空间充足。
   软件包路径	OCP Agent 的安装路径，默认值为 /home/部署用户/software，支持自定义软件包路径，您需拥有对应目录的读写权限，且保证此路径的磁盘空间充足。
   ocp.site.url	外部访问 OCP 网站的地址。要求以 http/https 开始，包含 VIP 地址/域名/端口的网址，且结尾不含斜杠（/），比如 http://localhost:8080。 设置完成后，您可单击 校验 测试地址连通性。若校验失败，需根据提示信息进行修改。
   服务端口	OCP 的服务端口，默认值为 8080，支持自定义端口（仅支持 1024~65535 范围），需确保设置的端口未被占用。

4. 规划资源分配。

   OCP 服务在运行过程中会有大量的计算和存储开销，所以需要根据待管理的对象规模进行资源规划。同时，OCP 需要在 MetaDB 中配置必要的租户以实现对 OceanBase 数据库全生命周期管理，配置完成后，系统将自动创建 元信息租户 和 监控数据租户。

   1. 填写所管理的主机数量。

      系统默认管理 10 台以下的主机，您可根据实际情况进行修改。

   2. 配置内存资源。

      默认分配内存 16GiB。内存资源的配置与所管理的主机数量相关，关于 OCP 主机资源规划详情，可参考 主机规划。

   3. 配置元信息租户信息。

      参数	说明
      租户名称	元信息租户名称，默认为 ocp_meta，支持自定义。
      密码	配置元信息租户的账号密码，密码支持随机生成或自定义。自定义密码需要满足以下复杂度条件： 长度为 8~32 个字符 至少包含数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符四种类型中的三种，支持的特殊字符为 ~!@#%^&*_-+=|(){}[]:;,.?/。
      CPU	为元信息租户分配 CPU 资源。默认 1VCPUS，支持调整数。
      内存	为元信息租户分配内存资源。默认 2GiB，支持调整。

   4. 配置监控数据租户信息。

      参数	说明
      租户名称	监控数据租户名称，默认为 ocp_monitor，支持自定义。
      密码	配置监控数据租户的账号密码，密码支持随机生成或自定义。自定义密码需要满足以下复杂度条件： 长度为 8~32 个字符 至少包含数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符四种类型中的三种，支持的特殊字符为 ~!@#%^&*_-+=|(){}[]:;,.?/。
      CPU	为监控数据租户分配 CPU 资源。默认 2VCPUS，支持调整。
      内存	为监控数据租户分配内存资源。默认 4GiB，支持调整。

步骤六：环境预检查

OCP 安装信息配置完成后，您需先检查并确认配置信息，确定后开始预检查。

• 若配置有误，单击 上一步 返回配置页面进行修改。

  

• 若配置无误，单击 预检查，系统将验证您的环境是否满足安装、配置 MetaDB 与 OCP 的所有最低要求。

  • 若存在检查失败项，OCP 提供修复方案说明，您可参考修复方案对问题进行排查修复。针对可自动修复的检查项，支持单击 自动修复 进行修复。

    修复完成后，您可单击 重新检查 重新执行环境预检查程序。

  • 若检查通过，单击 下一步。

    

步骤七：部署 OCP

OCP 部署过程中，您可以通过 部署日志 模块查看详细日志。

• 若部署失败，请查看日志信息获取失败原因，并联系技术支持同学进行处理。待定位安装失败问题原因且修复问题后，单击 重新部署 ，系统将清理当前失败的 OCP 安装环境，并重新执行安装程序。

• 若部署成功，单击 完成 退出部署程序。在退出程序前，您可复制访问地址及账密信息，用以登录所部署的 OCP 平台。