部署 OceanBase 数据库容器环境

本文介绍如何通过 Docker 容器部署单节点 OceanBase 数据库。

前提条件

在执行本文操作前，您需确认以下信息：

• 您已安装 Docker 并启动 Docker 服务，详细操作请参考 Docker 文档。

  说明

  在使用 x86 架构的 MAC 机器中，仅支持使用 V4.9.0 及以下版本的 Docker 部署 OceanBase 数据库，可点击 链接 下载 Docker。

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

部署 OceanBase 数据库

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

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

• 搜索 OceanBase 数据库相关镜像

  [admin@test001 ~]$ sudo docker search oceanbase
  

• 拉取 OceanBase 数据库最新镜像

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

  说明

  • 若拉取 Docker 镜像失败，您也可从 quay.io 或者 ghcr.io 仓库中拉取镜像，只需将上述拉取命令中的 oceanbase/oceanbase-ce 对应替换为 quay.io/oceanbase/oceanbase-ce 或 ghcr.io/oceanbase/oceanbase-ce，如执行 sudo docker pull quay.io/oceanbase/oceanbase-ce 从 quay.io 中拉取镜像。

  • 本步骤命令中的仓库地址更换后，步骤二中的命令需同步替换仓库地址，两条命令所用仓库需保持统一。

  • 上述命令默认拉取最新版本，可根据实际需求在 dockerhub、quay.io 或 ghcr.io中选择版本。

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

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

[admin@test001 ~]$ sudo docker run -p 2881:2881 -v $PWD/ob:/root/ob -v $PWD/obd/cluster:/root/.obd/cluster --name obstandalone -e MODE=NORMAL -e OB_TENANT_PASSWORD=***** -d oceanbase/oceanbase-ce

[admin@test001 ~]$ sudo docker run -p 2881:2881 -v $PWD/ob:/root/ob -v $PWD/obd/cluster:/root/.obd/cluster --name obstandalone -e MODE=MINI -e OB_TENANT_PASSWORD=***** -d oceanbase/oceanbase-ce

示例中的选项作用如下：

• -p 用于将容器的端口映射到宿主机端口，示例中是将容器中的 2881 端口映射到宿主机的 2881 端口。

• -v 用于在容器与宿主机之间共享文件或目录，实现数据持久化或配置共享。默认情况下，系统会在容器的 /root/ob 目录下部署 OceanBase 数据库，并在 /root/.obd/cluster 下保存其配置。您可使用该选项在宿主机上持久化数据。

  您也可使用 -v 选项挂载需要执行的 SQL 去执行，示例如下，您需将 {init_sql_folder_path} 修改为实际初始化 SQL 的文件路径。

  [admin@test001 ~]$ sudo docker run -p 2881:2881 -v {init_sql_folder_path}:/root/boot/init.d --name obstandalone -e MODE=SLIM -d oceanbase/oceanbase-ce
  

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

• -e 用于设置环境变量，示例中 MODE 用于设置 OceanBase 数据库的启动模式，OB_TENANT_PASSWORD 用于设置 OceanBase 数据库中 root@test 用户密码。详细的环境变量介绍可参见下文 支持配置的环境变量。

启动预计需要 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 3221711319
Server version: OceanBase_CE 4.3.0.1 (r100000242024032211-0193a343bc60b4699ec47792c3fc4ce166a182f9) (Built Mar 22 2024 13:19:48)

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)]>

支持配置的环境变量