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からイメージを取得します。

  • このステップのコマンドにおけるリポジトリアドレスを変更した後、ステップ2のコマンドでも同様にリポジトリアドレスを置き換える必要があります。2つのコマンドで使用するリポジトリは統一しておく必要があります。

  • 上記のコマンドはデフォルトで最新バージョンを取得します。実際のニーズに応じて、dockerhub、quay.io または ghcr.ioからバージョンを選択できます。

ステップ2：OceanBaseデータベースインスタンスを起動する

以下のコマンドを実行して、OceanBaseデータベースインスタンスを起動します。

[admin@test001 ~]$ sudo docker run -p 2881:2881 -p 2886:2886 -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 -p 2886:2886 -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

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

例におけるオプションの役割は以下のとおりです：

• -p は、コンテナのポートをホストのポートにマッピングするために使用されます。この例では、コンテナ内の 2881 ポートと 2886 ポートをそれぞれホストの 2881 ポートと 2886 ポートにマッピングします。

• -v は、コンテナとホスト間でファイルやディレクトリを共有し、データの永続化や設定の共有を実現するために使用されます。デフォルトでは、システムはコンテナの /root/ob ディレクトリにOceanBaseデータベースをデプロイし、その設定は /root/.obd/cluster に保存されます。このオプションを使用することで、ホスト上にデータを永続化できます。

  -v オプションを使用して、実行するSQLをマウントして実行することもできます。例を以下に示します。{init_sql_folder_path} を実際の初期化SQLファイルのパスに変更する必要があります。

  [admin@test001 ~]$ sudo docker run -p 2881:2881 -p 2886:2886 -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!

ステップ3：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.5.3 (r103010012025090210-8b80b225c2dcba7dd0c83f3d5a24e3c1ffc03f24) (Built Sep  2 2025 10:25:24)

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

ステップ4：obshell Dashboard管理ページにアクセスする

ホストシステムの2886ポートにアクセスすることで、obshellが提供するobshell DashboardのWeb管理ページにアクセスできます。

設定可能な環境変数