OceanBaseの使用｜OceanBase構築ガイド

OceanBaseデータベースの導入には、利用シーンに応じて2つの方法があります。この記事では、主に手軽に始められる「クイックスタート」の方法を詳しく解説します。また、実際の運用環境を想定した「本番環境へのデプロイ」についても紹介します。

コンポーネント

OceanBaseデータベースは、主に以下のコンポーネントから構成されています。

obd (OceanBase Deployer)

OceanBaseのインストールやデプロイを行うためのツールです。詳細については、公式ドキュメントOceanBaseインストール・デプロイツールを参照してください。
ODP (OceanBase Database Proxy)

アプリケーションからのリクエストを受け付ける専用の窓口(プロキシ)です。リクエストを適切なサーバーに振り分ける役割を担います。OBProxyとも呼ばれます。詳細については、公式ドキュメントOceanBase データベースプロキシを参照してください。
OCP Express

WebベースのOceanBaseデータベース4.xの管理ツールです。クラスタのパフォーマンスの確認や基本的なデータベース操作を行えます。詳細については、OceanBaseクラウドプラットフォームExpress (OCP Express)を参照してください。
OBAgent

OceanBaseデータベースの稼働状況を監視するためのデータを収集するフレームワークです。プッシュ(push)とプル(pull)の2種類のデータ収集モードに対応しており、さまざまな利用シーンに対応可能です。
Grafana

オープンソースのデータ可視化ツールで、データソースから各種指標データを可視化し、システムの稼働状況やパフォーマンス指標を直感的に把握できるようにします。詳細については、Grafana公式サイトを参照してください。
Prometheus

オープンソースのモニタリングシステムおよび時系列データベースで、汎用的なデータモデルと高速なデータ収集、保存、クエリインターフェースを提供します。詳細については、Prometheus公式サイトを参照してください。

前提条件

OceanBaseデータベースをインストールする前に、使用するソフトウェアおよびハードウェア環境が以下の要件を満たしていることを確認してください。

項目	説明
対応OS	Anolis OS 8.x(Linuxカーネル4.19以降) Alibaba Cloud Linux 2 / 3(Linuxカーネル4.19以降) Red Hat Enterprise Linux Server 7.x, 8.x(Linuxカーネル4.19以降) CentOS Linux 7.x, 8.x(Linuxカーネル 4.19 以降) Debian 9.x 以降(Linuxカーネル4.19以降) Ubuntu 20.x 以降(Linuxカーネル4.19以降) SUSE/OpenSUSE 15.x 以降(Linuxカーネル4.19以降) openEuler 22.03および24.03(Linuxカーネル5.10.0以降) KylinOS V10
CPU	最小2コア、推奨4コア以上。
メモリ	最小6GB、推奨16GB～1024GB。
ディスクの種類	SSDストレージを使用。
ディスクストレージ容量	最小20GB。
ファイルシステム	EXT4またはXFS。データ容量が16TBを超える場合はXFSを使用してください。
ポート	コンポーネントのデフォルトポートが他のプロセスで使用されていないことを確認してください。 OceanBaseデータベースは、デフォルトで2881、2882、2886ポートを使用します。 ODPは、デフォルトで2883、2884、2885ポートを使用します。 OBAgentは、デフォルトで8088、8089ポートを使用します。 Prometheusは、デフォルトで9090ポートを使用します。 Grafanaは、デフォルトで3000ポートを使用します。
all-in-oneインストールパッケージ	V4.1.0以降のバージョンを選択する必要があります。
Docker	Dockerを使用してOceanBaseデータベースをデプロイするには、事前にDockerをインストールし、Dockerサービスを起動しておく必要があります。詳しい手順については、Dockerドキュメントを参照してください。説明 x86x86アーキテクチャのMacマシンを使用する場合、OceanBaseデータベースのデプロイにはV4.9.0以前のバージョンのDockerのみがサポートされています。該当するDockerはこちらのリンクからダウンロードできます。

方法1：クイックスタート

説明

この方法は本番環境には適用できません。本番環境でOceanBaseデータベースをデプロイするには、本記事の方法 2：本番環境へのデプロイをご確認ください。

この方法は、マシンが1台しかない状況で、手早くOceanBaseデータベースの動作環境を構築したい場合に最適です。この方法で構築した環境ではデータベースの基本機能を利用でき、OceanBaseがどのようなものかを理解するのに役立ちます。ただし、分散機能や高可用性は備えていないため、本番環境での利用や長期間の運用には向いていない点にご注意ください。

以下の4つのオプションから、お好きな方法でOceanBaseデータベースを体験してみましょう。

オプション1：All in Oneインストールパッケージ

bash -c "$(curl -s https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/download-center/opensource/oceanbase-all-in-one/installer.sh)"
source ~/.oceanbase-all-in-one/bin/env.sh
obd demo

クイック体験用のコマンドです。上記のコマンドを実行すると、最新版のOceanBase All-in-Oneパッケージがオンラインでダウンロードされ、現在ログインしているユーザーとしてOceanBaseデータベースがデプロイされ、デモ環境が構築されます。環境構築後は、obdコマンドでデータベースを管理できます。

obd demoコマンドの実行に成功すると、デプロイされた各コンポーネントへの接続情報が出力されます。oceanbase-ceの接続文字列をコピーして実行し、rootユーザーでクラスタのsysテナントにログインしてください。ログイン後は、SQL文の実行を通して基本的な機能を確認できます。詳しくはSQLの基本操作・MySQLモードをご覧ください。

オフラインインストール手順や、obd demoコマンドの詳細なオプションについては、公式ドキュメントのobdのインストールとobdクイックデプロイコマンドを参照してください。

オプション2：RPMパッケージ

説明

このオプションはsystemctlコマンドを使用するため、コンテナ環境以外で操作を行ってください。
このオプションでOceanBaseデータベースをインストールする場合、以下のOSのみがサポート対象です。
- Anolis OS 8.x（Linuxカーネル 4.19 以降）
- CentOS Linux 8.x（Linuxカーネル 4.19 以降）
- Debian 10, 11, 12（Linuxカーネル 4.19 以降）
- openEuler 22.03 および 24.03（Linuxカーネル 5.10.0 以降）
- Ubuntu 18.04, 20.04, 22.04（Linuxカーネル 4.19 以降）

sudo bash -c "$(curl -s https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/download-center/opensource/service/installer.sh)"

クイック体験用のコマンドです。上記のコマンドを実行すると、最新版のRPMパッケージがオンラインでダウンロードされ、rootアカウントでシステムに直接インストールします。インストール完了後は、systemctlコマンドを使って、OceanBaseデータベースを管理できます。

コマンドが正常に実行されると、OceanBaseデータベースへの接続情報が表示されます。表示された接続文字列をコピーして実行し、rootユーザーでクラスターのsysテナントにログインします。ログイン後は、SQL文の実行を通して基本的な機能を確認できます。詳しくはSQLの基本操作・MySQLモードをご覧ください。

詳細な設定やオフラインでのインストール手順については、公式ドキュメントsystemdを使用したOceanBaseデータベースのデプロイを参照してください。

オプション 3：Docker

Linux以外のOS (例：Windows、macOS)でOceanBaseデータベースを手軽に試す場合、コンテナを使用する方法が便利です。ただし、このオプションは主に機能を体験することを目的としており、大規模な検証は行われていません。利用の際はその点を考慮してください。

このオプションを利用するには、事前にDockerをインストールし、起動しておく必要があります。詳細はDockerドキュメントを参照してください。

補足説明

x86アーキテクチャのMacマシンをお使いの場合、OceanBaseデータベースのデプロイには、V4.9.0以前のバージョンのDockerのみがサポートされています。該当するDockerは、こちらのリンクからダウンロードしてください。

sudo docker run -p 2881:2881 --name obstandalone -e MODE=MINI -d quay.io/oceanbase/oceanbase-ce

クイック体験用のコマンドです。上記のコマンドを実行すると、最新のデータベースイメージがオンラインでダウンロードされ、最小構成のOceanBaseデータベースのコンテナが起動します。起動後は、dockerコマンドでOceanBaseデータベースを管理できます。

デプロイに成功したら、下記のコマンドを実行して、rootユーザーとしてクラスターのsysテナントにログインします。ログイン後、SQL文を実行して基本的な機能をお試しいただけます。詳しくはSQLの基本操作・MySQLモードをご覧ください。

#Dockerコンテナにアクセスします
sudo docker exec -it obstandalone bash
#クラスタに接続します。パスワードはデフォルトで空。
obclient -uroot@sys -h127.0.0.1 -Doceanbase -P2881 -p

詳細な設定については、公式ドキュメントのOceanBaseデータベースコンテナ環境のデプロイを参照してください。

オプション 4：OceanBaseデータベースデスクトップ版

OceanBase Desktopは、OceanBaseデータベースの管理と操作を行うためのデスクトップアプリケーションです。グラフィカルユーザーインターフェースにより、ユーザーはデータベース管理、クエリ実行、データインポート・エクスポートなどの操作を容易に行うことができます。

説明

OceanBase Desktopは、Windows (x86-64アーキテクチャ)およびmacOSに対応しています。
インストールを開始する前に、必須のソフトウェアを導入しておく必要があります。Windowsの場合はWSL、macOSの場合はOrbStackがそれぞれ必要です。これらの導入手順については、ご自身で慣れた方法で行うか、こちらのドキュメントをご参照ください。

インストールパッケージをダウンロードする

OceanBaseダウンロードセンターにアクセスして、OceanBaseデスクトップ版セクションから、ご利用のOSに適したパッケージをダウンロードします。
OceanBase Desktopをインストールして起動する

インストールを完了すると、データベース環境がstop状態で自動的に準備されています。画面に表示されているstartボタンをクリックすると、OceanBaseデータベースが起動します。
OceanBase Desktopに接続する

データベースが起動したら、画面上のconnectボタンをクリックすることでOceanBase Detabaseに接続できます。ログイン後、SQL文を実行して基本的な機能をお試しいただけます。詳しくはSQLの基本操作・MySQLモードをご覧ください。

方法 2：本番環境へのデプロイ

OceanBaseクラスタの本番環境は、状況に応じて以下のいずれかの方法でデプロイできます。

オプション 1：OceanBase All-in-One パッケージ

このオプションは、OceanBase分散データベースのアーキテクチャや機能を深く理解したユーザーに適しています。デプロイされたOceanBaseクラスタは、すべての機能と高可用性を提供します。このオプションでは、最低3台のホストが必要で、それぞれが4vCPU、16GBメモリ、100GB以上のSSD高性能ディスクを搭載している必要があります。

(推奨) OceanBaseクラスタのグラフィカル管理

複数のOceanBaseクラスタをデプロイする場合、OCP (OceanBaseクラウドプラットフォーム) のデプロイを推奨します。OCPはOceanBaseデータベースの運用保守と管理を効率化し、運用保守作業を大幅に削減します。

まずは、3台のマシンを使用してOCPおよび、そのMetaDBをデプロイする必要があります。詳細な手順については、公式ドキュメントGUIによるOCPのデプロイを参照してください。OCPのデプロイを完了すると、OCPで新しいOceanBaseクラスタを作成することで、ビジネスを支援できます。詳細な手順については、公式ドキュメントのクラスタ管理セクションを参照してください。

注意

MetaDBはOCPのメタデータベースとしてのみ使用し、業務データを格納する用途には対応していません。
OceanBaseクラスタのコマンドライン管理

構築するOceanBaseクラスタが1つだけであれば、obdツールを使ってデプロイから管理まで一貫して行うのが適した方法です。具体的なデプロイ操作については、公式ドキュメントobdグラフィカルユーザーインターフェースによるOceanBaseクラスタのデプロイを参照してください。また、obdコマンドの詳細については、公式ドキュメントobd コマンド / クラスタコマンドグループを参照してください。

オプション 2：Kubernetes環境でのOceanBaseクラスタのデプロイ

このオプションは、本番環境でKubernetesを大規模に導入しており、OceanBaseデータベースについて一定の知識と経験を持つユーザーを対象としています。デプロイ済みのOceanBaseクラスタは、すべての機能と分散型高可用性を備えています。始める前に、以下の条件を満たしていることをご確認ください。

使用可能なKubernetesクラスタがあり、CPU 9コア以上、メモリ33GB以上、ストレージ360GB以上のリソースが必要です。
ob-operatorはcert-managerに依存しています。cert-managerがインストール済みであることをご確認ください。インストール方法については、対応するインストールドキュメントを参照してください。

具体的な操作手順については、公式ドキュメントKubernetes環境でのOceanBaseクラスタのデプロイを参照してください。