obd グラフィカルユーザーインターフェースによる OceanBase クラスタのデプロイ

本記事では、x86 アーキテクチャの CentOS Linux 7.9 イメージを環境として、どのように obd グラフィカルユーザーインターフェースを用いて OceanBase データベースをデプロイするかについて説明します。

用語解説

• OceanBase データベース

  完全自社開発のエンタープライズレベルのネイティブ分散データベースです。詳細については、OceanBase データベースドキュメントを参照してください。

• obd

  OceanBase Deployer、OceanBaseインストール・デプロイツール、略称はobd。詳細はOceanBaseインストール・デプロイツールドキュメントを参照してください。

• ODP

  OceanBase Database Proxy、OceanBase データベースプロキシは、OceanBase データベース専用のプロキシサーバーであり、ODP (OBProxy とも呼ばれる) と略称されます。詳細については、OceanBase データベースプロキシドキュメントを参照してください。

• OBAgent

  OBAgent は OceanBase データベースの監視データ収集フレームワークであり、プッシュ型とプル型の 2 種類のデータ収集モードをサポートし、様々なユースケースに対応することができます。

• obconfigserver

  OceanBase Configserver (obconfigserver)は、OceanBaseのメタデータの登録、保存、および検索サービスを提供します。詳細については、ob-configserverを参照してください。

• Grafana

  Grafanaはオープンソースのデータ可視化ツールであり、データソース内のさまざまなメトリックデータを可視化表示することで、システムの運用状況やパフォーマンス指標をより直感的に理解できます。詳細については、Grafana公式サイトを参照してください。

• Prometheus

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

• Alertmanager

  Alertmanagerはオープンソースのアラート管理ツールであり、Prometheusなどの監視システムから送信されるアラートを処理し、アラートの重複排除、グループ化、ルーティング、および静的無視などの機能を提供します。詳細については、Prometheus公式サイトを参照してください。

前提条件

開始する前に、以下の条件を満たしていることを確認してください：

• お使いのマシンはソフトウェアとハードウェアの要件を満たしています。詳細については、ソフトウェアとハードウェアの要件を参照してください。

• 本番環境では、環境と設定の確認が必要です。具体的な手順については、デプロイ前の設定 セクションを参照してください。

• OceanBaseデータベースのみをデプロイする場合、最低でも2vCPU、6 GBのメモリ、20 GBのディスク容量が必要となります。注意：メモリの制限は、free -gコマンドを実行した後、出力結果のavailable列に対応する値を指します。

• OceanBaseデータベースとすべてのコンポーネントをデプロイする場合、少なくとも4vCPU、10 GBのメモリ、25 GBのディスク容量が必要となります。16 GB以上のメモリが推奨されます。注意：メモリの制限は、free -gコマンドを実行した後、出力結果のavailable列に対応する値を指します。

ソフトウェアの準備

OceanBase データベースを obd を使用してグラフィカルにデプロイする場合、オンラインデプロイメントとオフラインデプロイメントの 2 つのデプロイ方法を選択することができます。

• オンラインデプロイメント：obd が稼働するマシンは外部ネットワークへのアクセスが可能である必要があります。デプロイメントに必要なパッケージは事前にインストールする必要がなく、デプロイメントプロセス中に obd がリモートイメージリポジトリから必要なインストールパッケージを取得します。

• オフラインデプロイメント：デプロイのプロセスにおいて外部ネットワークへのアクセスは不要です。必要なインストールパッケージについては、事前に obd ローカルイメージリポジトリにアップロードする必要があります。オフラインデプロイメントを選択する場合は、必要なバージョンの OceanBase All in One インストールパッケージを直接ダウンロードすることを推奨します。

デプロイの方法によってソフトウェアを準備する方法が異なります。状況に応じて適切な方法を選択してソフトウェアを準備することができます。

オンラインデプロイメント

オンラインデプロイメントを選択した場合、このセクションのコマンドを参照して、コントロールマシンにobdをインストールすることができます。

[admin@test001 ~]$ sudo yum install -y yum-utils
[admin@test001 ~]$ sudo yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
[admin@test001 ~]$ sudo yum install -y ob-deploy
[admin@test001 ~]$ source /etc/profile.d/obd.sh

オフラインデプロイメント

オフラインデプロイを選択した場合、このセクションのコマンドを参照して、OceanBase All in One をダウンロードおよびインストールすることができます。

最新のOceanBase All in Oneは、OceanBaseソフトウェアダウンロードセンターからダウンロードして、コントロールマシンにコピーすることができます。以下のコマンドを実行して解凍し、インストールします：

[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

操作手順

ステップ1：グラフィカルユーザーインターフェース(GUI)を起動する

1. グラフィカルユーザーインターフェース(GUI)を起動する

   コマンドラインで obd web コマンドを実行するとGUIが起動します。出力されたアドレスをクリックしてGUIにアクセスします。

   [admin@test001 ~]$ obd web
   start OBD WEB in 0.0.0.0:8680
   please open http://10.10.10.1:8680
   

   説明

   • グラフィカルユーザーインターフェースはデフォルトで8680ポートを使用します。obd web -p <PORT> コマンドでポートを指定できます。

   • Alibaba Cloudなどのクラウド環境では、プログラムがインターネットIPアドレスを取得することができず、イントラネットIPアドレスが出力される場合があります。このIPアドレスはインターネットIPアドレスではないため、グラフィカルユーザーインターフェース(GUI)にアクセスするには正しいアドレスを使用する必要があります。

   • obd web コマンドは 0.0.0.0 に関連付けられているため、マルチNIC環境の下では、任意のアクセス可能なIPアドレスからGUIにアクセスすることができます。

   • nohup または screen コマンドを使用して、obd web コマンドをバックグラウンドで実行するように設定できます。

2. (オプション)グラフィカル操作インターフェースの右上にある言語切り替えアイコンにマウスを置くと、表示されている言語を切り替えることができます。

   

3. グラフィカルユーザーインターフェースで 体験ツアーを開始 をクリックし、表示される OceanBaseデプロイウィザードへようこそ 画面で OceanBaseと関連ツール モジュールを選択し、インストール をクリックした後、OceanBaseデータベースデプロイ画面に進みます。

ステップ2：デプロイ設定

デプロイ設定 画面で、クラスタ名、負荷タイプ、およびデプロイコンポーネントを設定できます。デプロイ設定 画面の内容は以下のとおりです。

1. クラスタ設定

   

   モジュール	説明
   デプロイ設定	クラスタ名はobd専用デプロイプロダクトの唯一の名称で、デフォルトは myoceanbase です。カスタマイズ可能ですが、既存のデプロイ名と重複させることはできません。クラスタ名は英字で始まり、英字または数字で終わり、英数字とアンダースコア(_)を含むことができ、長さは2～32文字となります。obd cluster list コマンドを使用して、obdが管理するクラスタを確認できます。
   データベースのデプロイ	バージョン のドロップダウンリストをクリックして、OceanBaseデータベースのバージョンを選択できます。対応するコンポーネントの後の 詳細はこちら をクリックすると、対応するコンポーネントのドキュメントに切り替わり確認することができます。
   負荷タイプ	タイプ のドロップダウンリストをクリックして、OceanBaseクラスタの負荷タイプを自ら選択することができます。異なるタイプの負荷均衡下に、対応する説明が表示され、各タイプの適用シナリオを理解することができます。 説明 このモジュールは、デプロイする OceanBase データベースのバージョンが V4.2.5 以上である場合にのみ表示されます。

2. コンポーネント選択

   

   デフォルトではOBProxyコンポーネントのみが選択されています。オプションコンポーネント の下にある、各コンポーネントのチェックボックスをクリックして、デプロイするかどうかを設定することができます。コンポーネントのバージョンは最新バージョンに固定されています。各コンポーネントの後の 詳細はこちら をクリックすると、そのコンポーネントのドキュメントに切り替わり確認することができます。

   説明

   Grafana および AlertManager コンポーネントのデプロイは OBAgent および Prometheus コンポーネントに依存し、Prometheus コンポーネントのデプロイは OBAgent コンポーネントに依存します。具体的には、Grafana または AlertManager コンポーネントを選択すると、OBAgent および Prometheus コンポーネントも自動的に選択されます。OBAgent コンポーネントの選択を解除すると、Grafana、AlertManager、および Prometheus コンポーネントの選択も自動的に解除されます。

設定が完了したら、次へ をクリックして ノード設定 ページに進むことができます。

ステップ3：ノード設定

ノード設定 画面で、データベースとコンポーネントノード、デプロイユーザー、およびソフトウェアのインストールパスを設定することができます。ノード設定 画面の内容については以下のとおりです。

設定が完了したら、次へ をクリックして クラスタ設定 ページに進むことができます。

ステップ4：クラスタ構成

クラスタ設定 画面では、クラスタの設定を行うことができます。これには、システムテナントの管理者ユーザー(root@sys)のパスワード、データとログのディレクトリ、データベースおよび各コンポーネントのポートとパラメータの設定などが含まれます。このセクションでは、それぞれについて説明します。

1. クラスタ構成

   

   パラメータ	説明
   モード設定	最大占有 または 最小利用 を選択することができます。最大占有 モードは環境リソースを最大限に活用し、クラスタのパフォーマンスと安定性を確保し、推奨しています。最小利用 モードは、クラスタの正常稼働に必要なリソースパラメータを設定します。2つのモードの詳細については、モード設定ルールを参照してください。
   root@sysパスワード	ランダム生成 をクリックすると、obdによってランダムな文字列が自動生成されます。また、カスタム設定も可能です。カスタム設定時には、パスワードの複雑さは以下の要件を満たす必要があります： 長さは8～32文字 以下の4種類の文字のうち少なくとも3種類を含む：数字(0～9)、大文字(A～Z)、小文字(a～z)と特殊文字(~!@#%^&*_-+=|(){}[]:;,.?/) 設定後、パスワードをコピー をクリックすると設定済みのパスワードが保存されます。
   データディレクトリ	デフォルトでは、/data/1 に設定されます。カスタム設定はサポートされており、/ から始まる絶対パスである必要があります。文字、数字、および特殊文字（-_:@/.）のみを含み、設定したディレクトリが空である必要があります。
   ログディレクトリ	デフォルトでは、/data/log1 に設定されます。カスタム設定はサポートされており、/ から始まる絶対パスである必要があります。文字、数字、および特殊文字（-_:@/.）のみを含み、設定したディレクトリが空である必要があります。
   SQLポート	SQLサービスのプロトコルポート番号。デフォルトは 2881 で、カスタマイズ設定が可能です(1025～65535の範囲のみサポート)。設定ポートが使用されていないことを確認する必要があります。
   RPCポート	リモートアクセスのためのプロトコルポート番号です。デフォルトは 2882 で、カスタマイズ可能です(1025～65535の範囲のみサポート)。設定したポートが使用されていないことを確認する必要があります。
   OBShellポート	OceanBaseデータベースのO&Mポート。デフォルトは 2886 で、カスタマイズ設定が可能です(1025～65535の範囲のみサポート)。設定したポートが使用されていないことを確認する必要があります。
   詳細設定	詳細設定 ボタンをクリックして、対応するクラスタパラメータを確認できます。自動的に割り当てられた値を使用するか、各パラメータをカスタマイズすることもできます。 説明 詳細設定の enable_auto_start パラメータを使用して、observerプロセスのOS起動時の自動起動機能を有効にするかどうかを設定できます。この機能を有効にするには、デプロイユーザーにsudo権限があり、かつデプロイ環境がコンテナ環境でないことを確認する必要があります。

2. コンポーネント設定

   

   パラメータ	説明
   Grafanaパスワード	Grafana管理者アカウントのログインパスワードです。ランダム生成 をクリックすると、obdによってランダムな文字列が自動生成されます。また、カスタム設定も可能です。カスタム設定時には、パスワードの複雑さは以下の要件を満たす必要があります： 長さは8～32文字 以下の4種類の文字をそれぞれ2つ以上含む：数字(0～9)、大文字(A～Z)、小文字(a～z)と特殊文字(~!@#%^&*_-+=|(){}[]:;,.?/`$"<>\) 設定後、パスワードをコピー をクリックしてコピーし、設定済みのパスワードを保存します。
   Prometheusパスワード	Prometheusサービスのログインパスワードです。ランダム生成 をクリックすると、obdによってランダムな文字列が自動生成されます。また、カスタム設定も可能です。カスタム設定時には、パスワードの複雑さは以下の要件を満たす必要があります： 長さは8～32文字 以下の4種類の文字をそれぞれ2つ以上含む：数字(0～9)、大文字(A～Z)、小文字(a～z)と特殊文字(~!@#%^&*_-+=|(){}[]:;,.?/`$"<>\) 設定後、パスワードをコピー をクリックしてコピーし、設定済みのパスワードを保存します。
   AlertManagerパスワード	Alertmanagerサービスのログインパスワードです。ランダム生成 をクリックすると、obdによってランダムな文字列が自動生成されます。また、カスタム設定も可能です。カスタム設定時には、パスワードの複雑さは以下の要件を満たす必要があります： 長さは8～32文字 以下の4種類の文字をそれぞれ2つ以上含む：数字(0～9)、大文字(A～Z)、小文字(a～z)と特殊文字(~!@#%^&*_-+=|(){}[]:;,.?/`$"<>\) 設定後、パスワードをコピー をクリックしてコピーし、設定済みのパスワードを保存します。
   OBProxy SQLポート	ODPリスニングポート。デフォルトは 2883 で、カスタマイズ設定が可能です(1025～65535の範囲のみサポート)。設定したポートが使用されていないことを確認する必要があります。
   OBProxy Exporterポート	PrometheusがOBProxyの監視データを収集するために使用されるOBProxy Exporterのポートです。デフォルトは 2884 で、カスタマイズ設定が可能です(1025～65535の範囲のみサポート)。設定したポートが使用されていないことを確認する必要があります。
   OBProxy RPCポート	デフォルトは 2885 で、カスタマイズ設定が可能です(1025～65535の範囲のみサポート)。設定したポートが使用されていないことを確認する必要があります。
   OBAgent監視サービスポート	デフォルトは 8088 で、カスタマイズ設定が可能です(1025～65535の範囲のみサポート)。設定したポートが使用されていないことを確認する必要があります。
   OBAgent管理サービスポート	デフォルトは 8089 で、カスタマイズ設定が可能です(1025～65535の範囲のみサポート)。設定したポートが使用されていないことを確認する必要があります。
   obconfigserverサービスポート	obconfigserverサービスが監視するポート。デフォルトは 8080 で、カスタマイズ設定が可能です(1025～65535の範囲のみサポート)。設定したポートが使用されていないことを確認する必要があります。
   Prometheusサービスポート	Prometheusサービスが監視するポート。デフォルトは 9090 で、カスタマイズ設定が可能です(1025～65535の範囲のみサポート)。設定したポートが使用されていないことを確認する必要があります。
   Grafanaサービスポート	GrafanaページにアクセスするためのHTTPポート。デフォルトは 3000 で、カスタマイズ設定が可能です(1025～65535の範囲のみサポート)。設定したポートが使用されていないことを確認する必要があります。
   AlertManagerサービスポート	AlertmanagerページにアクセスするためのHTTPポート。デフォルトは 9093 で、カスタマイズ設定が可能です(1025～65535の範囲のみサポート)。設定したポートが使用されていないことを確認する必要があります。
   詳細設定	詳細設定 ボタンをクリックして、対応するコンポーネントのパラメータを確認できます。自動的に割り当てられた値を使用するか、各パラメータをカスタマイズすることもできます。 説明 ノード設定の obconfigserverノードで複数のノードを設定する場合、詳細設定で vip_address と vip_port を設定する必要があります。設定しないと、事前チェックでエラーが発生します。

すべての設定が完了したら、次へ をクリックして 事前チェック ページに進むことができます。

ステップ5：事前チェック

事前チェック ページで設定情報をすべて確認し、問題があれば 戻る ボタンをクリックして修正することができます。問題がなければ 事前チェック ボタンをクリックしてチェックを実行してください。

事前チェックでエラーが発生した場合は、ページの提案に従って 自動修復 (自動修復可能なチェック項目の場合)を選択するか、詳細な解決策を見る をクリックしてエラーコードドキュメントに移動し、ドキュメントを参照して修正を行うことができます。すべてのエラーを修正後、再検査 をクリックして、事前チェックを再度実行することができます。

事前チェックが完了したら、デプロイ をクリックすると、OceanBaseデータベースのデプロイが開始されます。

ステップ6：デプロイ

そのうち：

• デプロイに成功したら、表示された接続文字列をコピーして、対応するコンポーネントに接続します。CLIでOceanBaseデータベースコンポーネントを実行後、接続文字列はroot@sysユーザーでOceanBaseクラスタに接続し、OBProxyコンポーネントを実行後、接続文字列はroot@proxysysユーザーでODPに接続します。

• 出力されたPrometheus、Grafana、AlertManager、およびOB-Dashboardコンポーネントの接続文字列をクリックすると、それぞれのログイン画面に移動できます。デプロイ画面に表示されたアカウントとパスワードでログインします。

  説明

  Alibaba Cloudなどのクラウド環境では、プログラムがインターネットIPアドレスを取得することができず、イントラネットIPアドレスが出力される場合があります。このIPアドレスはインターネットIPアドレスではないため、グラフィカルユーザーインターフェース(GUI)にアクセスするには正しいアドレスを使用する必要があります。

• デプロイメントレポート の該当コンポーネントの手前の展開アイコンをクリックすると、デプロイメントログを確認することができます。対応するコンポーネント一覧の 詳細を見る をクリックした後、対応するコマンドの後のコピーアイコンをクリックすると、コマンドをコピーすることができます。コピーしたコマンドは、コントロールマシンで実行し、対応するコンポーネントのログの場所を確認することができます。

• 情報のコピー をクリックして、OceanBaseクラスタのすべてのアカウントとパスワード情報をコピーして保存した後、終了 をクリックしてデプロイプログラムを終了します。または、ビジネステナントの作成 をクリックして、GUI画面でビジネステナントを作成することもできます。

（オプション）ステップ7：ビジネステナントの作成

OceanBaseクラスタのデプロイが成功した後、デプロイ成功ページの右下にある ビジネステナントの作成 ボタンをクリックして、ビジネステナントの作成プロセスに進みます。以下の表に従って、テナントの関連情報を設定できます。

設定が完了したら、次へ:ビジネステナントの作成 をクリックします。システムが対応するテナントを作成します。作成が完了すると、ページにビジネステナントの情報が表示されます。テナント名、rootユーザーのパスワード、接続文字列などが含まれます。左下の 終了 ボタンをクリックすると、テナント作成プロセスを終了できます。その後、デプロイ結果ページの 終了 ボタンをクリックして、デプロイプログラムを終了するか、ビジネステナントの作成 をクリックして、次のビジネステナントを作成することができます。

関連操作

デプロイ済みクラスタの管理

以下のコマンドを実行して、obdにデプロイされたクラスタを管理することができます。詳細については、クラスタコマンドグループを参照してください。

# クラスタ一覧の表示
[admin@test001 ~]$ obd cluster list

# クラスタ状態の確認は、myoceanbaseをデプロイ名の例とする
[admin@test001 ~]$ obd cluster display myoceanbase

# 実行中のクラスタの停止は、myoceanbaseをデプロイ名の例とする
[admin@test001 ~]$ obd cluster stop myoceanbase

# デプロイ済みクラスタの破棄は、myoceanbaseをデプロイ名の例とする
[admin@test001 ~]$ obd cluster destroy myoceanbase

特定バージョンコンポーネントのデプロイ

OceanBase All in Oneを使用してデプロイする場合、OceanBase All in OneパッケージはOceanBaseデータベースのバージョンに基づいて更新されます。パッケージに他のコンポーネントの更新バージョンが含まれる場合、OceanBaseソフトウェアダウンロードセンターから最新バージョンのコンポーネントをダウンロードし、以下の手順に従ってローカルイメージリポジトリにアップロードすることができます。obdデプロイ時には、ローカルイメージリポジトリ内の最新バージョンが自動的に取得されます。

1. コンポーネントインストールパッケージのあるディレクトリに移動し、パッケージがローカルイメージリポジトリに追加されます

   [admin@test001 rpm]$ obd mirror clone *.rpm
   

2. ローカルイメージリポジトリ内のパッケージ一覧を確認する

   [admin@test001 rpm]$ obd mirror list local