4.8 KiB
如何使用这个镜像
部署 OceanBase 数据库的方式有很多，使用 Docker 是其中较方便的一种。本仓库提供了 OceanBase 数据库的 Docker 镜像 oceanbase-standalone。oceanbase-standalone 是 OceanBase 数据库的单机镜像。默认会根据当前容器情况部署最大规格的实例，也可以通过环境变量指定MINI MODE部署最小规格实例。
前提条件
在部署 oceanbase-standalone 镜像之前，您需要确认以下信息：
- 确保您的机器至少提供 2 核 10GB 以上的资源。
- 您的机器已经安装以下程序：
应用程序 推荐版本 参考文档 Docker 最新版 Docker 文档 - 您的机器已经启动 Docker 服务。
启动 OceanBase 实例
运行以下命令，启动 OceanBase 的实例：
# 根据当前容器情况部署最大规格的实例
docker run -p 2881:2881 --name obstandalone -d oceanbase/oceanbase-ce-standalone
# 部署最小规格实例
docker run -p 2881:2881 --name obstandalone -e MINI_MODE=1 -d oceanbase/oceanbase-ce-standalone
启动预计需要 2-5 分钟。执行以下命令，如果返回 boot success!，则启动成功。
$ docker logs obstandalone | tail -1
boot success!
WARNING: 如果observer进程出现异常退出，容器不会自动退出。
连接 OceanBase 实例
oceanbase-standalone 镜像安装了 OceanBase 数据库客户端 obclient，并提供了默认连接脚本 ob-mysql。
docker exec -it obstandalone ob-mysql sys # 连接 sys 租户
docker exec -it obstandalone ob-mysql root # 连接用户租户的 root 账户
docker exec -it obstandalone ob-mysql test # 连接用户租户的 test 账户
您也可以运行以下命令，使用您本机的 obclient 或者 MySQL 客户端连接实例。
$mysql -uroot -h127.1 -P2881
Welcome to the MySQL monitor. Commands end with ; or \g. Your MySQL connection id is 167310 Server version: 5.7.25 OceanBase 3.1.0 (r-00672c3c730c3df6eef3b359eae548d8c2db5ea2) (Built Jun 22 2021 12:46:28)
Copyright (c) 2000, 2021, Oracle and/or its affiliates.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
mysql>
## 支持的环境变量
下表列出了当前版本的 oceanbase-standalone 镜像支持的环境变量：
变量名称 | 默认值 | 描述
------- | ----- | ---
MINI_MODE | false | OceanBase 数据库实例是否采用mini模式部署，该模式仅供研究、学习和评估使用，不适用于生产环境或性能测试场景。
EXIT_WHILE_ERROR | true | OceanBase 如果启动失败，是否退出容器。比如初次run镜像失败，或start容器失败，可以将此参数设置为false,那么OB启动失败，也可以进入容器，查看OceanBase的运行日志，然后进行排查。
OB_HOME_PATH | /root/ob | OceanBase 数据库实例的部署路径。
OB_DATA_DIR | empty | OceanBase 数据库使用的数据存储路径。默认在部署路径下的 `store` 目录
OB_REDO_DIR | empty | OceanBase 数据库使用的clog，ilog，slog路径。默认与数据存储路径一致。
OB_MYSQL_PORT | 2881 | OceanBase 数据库实例的 MySQL 协议端口。
OB_RPC_PORT | 2882 | OceanBase 数据库实例的 RPC 通信端口。
OB_ROOT_PASSWORD | empty | OceanBase 数据库实例 sys 租户的密码。
OB_CLUSTER_NAME | obcluster | OceanBase 数据库实例名称，OBD 将使用这个名称作为集群名。
OB_TENANT_NAME | test | OceanBase 数据库实例默认初始化的用户租户的名称。
## 运行 Sysbench 脚本
oceanbase-ce 镜像默认安装了 Sysbench 工具，并进行了简单配置。您可以依次执行以下命令，使用默认配置运行 Sysbench 脚本。
```bash
docker exec -it obstandalone obd test sysbench [OB_CLUSTER_NAME]
磁盘挂载
如果想要将容器中的数据持久化保存下来，通常的做法是在run docker镜像时，使用 -v /host/path:/container/path 的方式将数据保存在宿主机上。
oceanbase-ce镜像的数据库数据默认保存在/root/ob目录下。但是仅仅映射/root/ob目录，会导致新的镜像无法启动，因为oceanbase-ce镜像是使用obd 来管理集群的，新的镜像启动时，没有oceanbase的集群信息，所以需要同时挂载/root/ob和/root/.obd目录。
挂载目录运行示例：
docker run -d -p 2881:2881 -v $PWD/ob:/root/ob -v $PWD/obd:/root/.obd --name oceanbase oceanbase/oceanbase-ce
注意需要按照实际情况调整自己的目录。 docker -v 参数的详细说明可以参考 docker volumn