快速体验 OceanBase 社区版

本文以部署 OceanBase 演示环境、部署 OceanBase 集群环境和部署 OceanBase 容器环境三种部署方案为例指导您如何快速体验 OceanBase 社区版。

背景信息

OceanBase 数据库自 V4.0.0 开始提供统一的安装包 all-in-one package。您可以通过这个统一的安装包一次性完成 obd、OceanBase 数据库、ODP、OBAgent、Grafana、Prometheus 的安装。您可以根据实际需求选择部分或全部组件安装。

组件介绍

• OBD

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

• ODP

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

• OBAgent

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

• Grafana

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

• Prometheus

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

方案介绍

为了助力您快速上手体验 OceanBase 数据库，我们提供了如下三种不同的方案实现快速部署 Oceanbase 数据，您可以根据自身环境情况灵活选择。

• 方案一：部署 OceanBase 演示环境

  此方案适用于仅有一台机器时，快速搭建一个可用的 OceanBase 数据库环境。部署的 OceanBase 数据库环境具备数据库的基本功能，可以有效地帮助您了解 OceanBase 数据库；但是该环境不具备任何分布式能力及高可用特性，不建议长期使用。具体操作步骤请参考 方案一：部署 OceanBase 演示环境。

• 方案二：部署 OceanBase 集群环境

  此方案适用于需要深入了解 OceanBase 分布式数据库架构原理及功能特性的用户。部署的 OceanBase 集群具备数据库完整能力及分布式高可用的特性。该方案需要您至少准备三台可用资源为 4vCPU、10 GB 内存、50 GB 磁盘的主机。具体操作步骤请参考 方案二：部署 OceanBase 集群环境。

• 方案三：部署 OceanBase 容器环境

  此方案适用于希望通过容器实现部署、管理 OceanBase 数据库的用户。该方案未经过规模化的验证，建议谨慎使用。操作步骤请参考 方案三：部署 OceanBase 容器环境。

前提条件

在参考本文安装 OceanBase 数据库之前，确保您的软硬件环境满足以下要求：

方案一：部署 OceanBase 演示环境

当您仅拥有一台可用机器时，您可参考本节内容使用 obd demo 命令快速部署单机 OceanBase 数据库。

步骤一：下载并安装 all-in-one 安装包

1. 请从 OceanBase 软件下载中心 下载最新版本 all-in-one 安装包，并将其上传到机器任一目录下。

2. 在安装包所在目录下执行如下命令解压安装包并安装。

   [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
   

步骤二：单机部署 OceanBase 数据库

1. 执行以下命令，快速部署 OceanBase 数据库

   [admin@test001 ~]$ obd demo
   

   obd demo 命令默认在当前用户家目录下以最小规格部署并启动 OceanBase 数据库及相关组件（包括 ODP、OBAgent、Grafana 和 Prometheus），固定部署名为 demo。如需更多定制化的部署形式，参见 快速部署命令。

   您也可以使用 OBD 命令管理该 OceanBase 数据库，详细命令介绍请参考 集群命令组。

   说明

   当安装 grafana 或 prometheus 时，会输出 grafana 或 prometheus 的访问地址。在阿里云或其他云环境下，可能出现因无法获取公网 IP 而输出内网地址的情况，此 IP 非公网地址，您需要使用正确的地址。

2. 执行输出中的连接命令连接数据库

   obd demo 命令成功执行后会输出通过 OBClient 连接 OceanBase 数据库的命令，示例如下。

   • 通过 2881 端口直连数据库

     [admin@test001 ~]$ obclient -h127.0.0.1 -P2881 -uroot@sys -Doceanbase -A
     

   • 通过 ODP 代理访问数据库

     [admin@test001 ~]$ obclient -h127.0.0.1 -P2883 -uroot@sys -Doceanbase -A
     

   使用 OBClient 客户端连接 OceanBase 集群的详细操作可参见 通过 OBClient 连接 OceanBase 租户。连接 OceanBase 数据库更多方法请参见 连接方式概述。

3. （可选）配置密码

   使用 obd demo 命令快速部署 OceanBase 数据库后，您可参考如下步骤为 demo 集群配置密码。

   1. 修改配置文件

      obd cluster edit-config demo
      

      执行上述命令打开配置文件后，在配置文件中 oceanbase-ce 组件下添加 root_password: xxxx，添加完成后保存退出。示例如下：

      oceanbase-ce:
        servers:
          - 127.0.0.1
        global:
          home_path: /home/admin/oceanbase-ce
          ... # 省略部分配置项
          log_disk_size: 13G
          root_password: ******
      

   2. 重启集群

      修改并保存配置文件后，OBD 会输出待执行的重启命令，直接复制执行即可，示例如下。

      [admin@test001 ~]$ obd cluster edit-config demo
      Search param plugin and load ok
      Search param plugin and load ok
      Parameter check ok
      Save deploy "demo" configuration
      Use `obd cluster reload demo` to make changes take effect.
      Trace ID: 29dd12fa-3d73-11ee-91bc-00163e01cd7a
      If you want to view detailed obd logs, please run: obd display-trace 29dd12fa-3d73-11ee-91bc-00163e01cd7a
      

      从输出可以看出，修改配置文件中 root@sys 用户密码后，需执行 obd cluster reload demo 命令重启 demo 集群。

方案二：部署 OceanBase 集群环境

当您拥有多台可用机器时，可参考本节内容使用 obd web 命令启动白屏，在白屏界面部署分布式 OceanBase 集群。

步骤一：下载并安装 all-in-one 安装包

1. 请从 OceanBase 软件下载中心 下载最新版本 all-in-one 安装包，并将其上传到机器任一目录下。

2. 在安装包所在目录下执行如下命令解压安装包并安装。

   [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
   

步骤二：使用白屏部署 OceanBase 数据库

1. 命令行执行 obd web 命令启动白屏界面，根据输出地址登录白屏界面并单击 开启体验之旅 开始部署。

   [admin@test001 ~]$ obd web
   start OBD WEB in 0.0.0.0:8680
   please open http://172.xx.xxx.233:8680
   

   说明

   • 白屏界面默认使用 8680 端口，您可使用 obd web -p <PORT> 命令指定端口。

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

   • obd web 命令绑定在 0.0.0.0 上，在多网卡部署的情况下，您可通过任一一个可访问的 IP 访问白屏界面。

2. 在 部署配置 界面修改 集群名称 并勾选待部署组件，也可不做修改，使用默认配置（默认部署所有组件）。单击 下一步 进入 节点配置 页面。

   

3. 在 节点配置 页面输入节点 IP 和用户密码，单击 下一步 进入 集群配置 页面。

   

4. 在 集群配置 页面配置集群的部署模式、密码、目录、端口以及更多配置，您也可不做修改，使用默认配置。单击 下一步 进入 预检查 页面。

   

5. 在 预检查 页面查看配置信息，无误后单击 预检查 进行检查。若预检查报错，您可根据页面建议选择 自动修复 或者单击 了解更多方案 跳转至错误码文档，参考文档自行修改。所有报错修改后，可单击 重新检查 再次进行预检查。

   

6. 预检查通过后，单击 部署 开始 OceanBase 集群的部署。部署成功会输出各个组件的连接方式，您可复制进行访问。

   

7. 单击 完成，结束部署流程。

8. 使用 OBClient 客户端连接 OceanBase 数据库。

   使用 OBClient 客户端连接 OceanBase 集群的详细操作可参见 通过 OBClient 连接 OceanBase 租户。连接 OceanBase 数据库更多方法请参见 连接方式概述。

   • 通过 2881 端口直连数据库，以直连 10.10.10.1 节点为例

     [admin@test001 ~]$ obclient -h10.10.10.1 -P2881 -uroot@sys -p -Doceanbase -A
     

   • 通过 ODP 代理访问数据库，以 ODP 所在节点为 10.10.10.1 为例

     [admin@test001 ~]$ obclient -h10.10.10.1 -P2883 -uroot@sys -p -Doceanbase -A
     

方案三：部署 OceanBase 容器环境

您可参考本节内容在 Docker 容器里启动 OceanBase 数据库，帮助您快速了解 OceanBase 数据库。

（可选）步骤一：拉取 OceanBase 数据库镜像

运行如下命令，拉取 OceanBase 数据库所需镜像。

• 搜索 OceanBase 数据库相关镜像

  [admin@test001 ~]$ sudo docker search oceanbase
  

• 拉取 OceanBase 数据库最新镜像

  [admin@test001 ~]$ sudo docker pull oceanbase/oceanbase-ce
  

  说明

  上述命令默认拉取最新版本，可根据实际需求在 Docker 镜像 中选择版本。

步骤二：启动 OceanBase 数据库实例

运行如下命令，启动 OceanBase 数据库实例。

• 根据当前容器部署最大规格实例

  [admin@test001 ~]$ sudo docker run -p 2881:2881 --name obstandalone -e MODE=NORMAL -d oceanbase/oceanbase-ce
  

• 部署 mini 的独立实例

  [admin@test001 ~]$ sudo docker run -p 2881:2881 --name obstandalone -e MODE=MINI -d oceanbase/oceanbase-ce
  

其中：

• --name 用于设置 Docker 容器名称，比如示例中创建一个名为 obstandalone 的 Docker 容器。

• -e 用于设置环境变量，其中 MODE 用于设置 OceanBase 数据库的部署规格。详细的环境变量介绍可参见下文 支持配置的环境变量。

启动预计需要 2~5 分钟。执行以下命令，如果返回 boot success!，则表示启动成功。

[admin@test001 ~]$ sudo docker logs obstandalone | tail -1
boot success!

步骤三：连接 OceanBase 数据库实例

oceanbase-ce 镜像安装了 OBD（OceanBase Deployer，OceanBase 安装部署工具）和 OBClient（OceanBase 命令行客户端）。您可选择进入容器，使用 OBD 命令管理和 OBClient 客户端连接实例，也可使用宿主机本地 OBClient 或 MySQL 客户端连接到 OceanBase 数据库实例。

进入容器后连接

1. 进入 Docker 容器

   [admin@test001 ~]$ sudo docker exec -it obstandalone bash
   

2. 查看集群详情

   # 查看集群列表
   obd cluster list
   # 查看 obcluster 集群详情
   obd cluster display obcluster
   

3. 连接集群

   obclient -h127.0.0.1 -uroot@sys -A -Doceanbase -P2881 -p
   

使用宿主机本地客户端连接

您可选择使用宿主机本地 OBClient 或 MySQL 客户端连接到 OceanBase 数据库实例，示例如下：

[admin@test001 ~]$ obclient -uroot@sys -h127.0.0.1 -P2881 -p

连接成功后，终端将显示如下内容：

Welcome to the OceanBase.  Commands end with ; or \g.
Your OceanBase connection id is 3221487727
Server version: OceanBase_CE 4.1.0.0 (r100000192023032010-0265dfc6d00ff4f0ff4ad2710504a18962abaef6) (Built Mar 20 2023 10:12:57)

Copyright (c) 2000, 2018, OceanBase and/or its affiliates. All rights reserved.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

obclient [(none)]>

支持配置的环境变量

相关文档

了解更多关于部署企业版 OceanBase 数据库，参见 部署 OceanBase 企业版。