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公式Webサイトを参照してください。

• Prometheus

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

• Alertmanager

  Alertmanagerはオープンソースのアラートマネージャーで、Prometheusなどの監視システムからのアラートを処理し、アラートの重複除去、グループ化、ルーティング、ミュートなどの機能を提供します。詳細については、Prometheus公式Webサイトを参照してください。

前提条件

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

• マシンがソフトウェアおよびハードウェア要件を満たしていること。詳細については、ソフトウェアおよびハードウェア要件を参照してください。

• 本番環境では、環境と設定のチェックが必要です。具体的な操作については、デプロイ前の設定の章を参照してください。

• OceanBaseデータベースのみをデプロイする場合、少なくとも2vCPU、6GBメモリ、20GBのディスク空き容量が必要です。要件で指定されているメモリ制限は、free -g コマンドを実行した後の出力における available 列の値を指します。

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

ソフトウェアの準備

obdを使用してOceanBaseデータベースをグラフィカルにデプロイする場合、オンラインデプロイとオフラインデプロイの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ソフトウェアダウンロードセンターから最新のOceanBase All in Oneをダウンロードし、中央管理マシンにコピーします。以下のコマンドを実行して解凍し、インストールします：

[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. グラフィカルインターフェースを起動する

   コマンドラインで obd web コマンドを実行してグラフィカルインターフェースを起動し、出力されたアドレスをクリックしてアクセスします。

   [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 コマンドを使用してポートを指定できます。

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

   • obd webコマンドは0.0.0.0にバインドされています。複数のNICをデプロイした場合でも、アクセス可能な任意のIPからグラフィカルインターフェースにアクセスできます。

   • 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. クラスタ設定

   パラメータ	説明
   モード設定	最大占用または最小可用を選択できます。最大占用モードは環境リソースを最大限に活用し、クラスタのパフォーマンスと安定性を保証するため、推奨されます。最小可用モードは、クラスタの正常な稼働に必要なリソースパラメータを設定します。両モードの詳細については、モード設定ルール を参照してください。
   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データベースの運用管理ポートで、デフォルトは 2886 です。カスタマイズ設定が可能です（1025〜65535の範囲のみサポート）。設定したポートが使用されていないことを確認する必要があります。
   詳細設定	詳細設定 の前の展開ボタンをクリックすると、対応するクラスタパラメータを表示および設定できます。自動割り当てられた値を使用して設定することも、各パラメータをカスタマイズすることもできます。 説明 詳細設定 の enable_auto_start パラメータを使用して、observerプロセスの起動時自動起動機能を有効にするかどうかを制御できます。この機能を有効にするには、デプロイユーザーがsudo権限を持っていること、およびデプロイ環境がコンテナ環境ではないことを確認する必要があります。

2. コンポーネント設定

   パラメータ	説明
   Grafanaパスワード	Grafana管理者アカウントのログインパスワードです。ランダムに生成するをクリックすると、obdが自動的にランダム文字列を生成しますが、手動で設定することもできます。手動設定の場合、パスワードの複雑さは以下の要件を満たす必要があります。 長さが8～32文字であること。 数字(0～9)、大文字(A～Z)、小文字(a～z)、特殊文字(~!@#%^&*_-+=|(){}[]:;,.?/`$"<>\)の各種類から、少なくとも2文字ずつ含むこと。 設定後、パスワードをコピーをクリックして、設定したパスワードを保存します。
   Prometheusパスワード	Prometheusサービスのログインパスワードです。ランダムに生成するをクリックすると、obdが自動的にランダム文字列を生成しますが、手動で設定することもできます。手動設定の場合、パスワードの複雑さは以下の要件を満たす必要があります。 長さが8～32文字であること。 数字(0～9)、大文字(A～Z)、小文字(a～z)、特殊文字(~!@#%^&*_-+=|(){}[]:;,.?/`$"<>\)の各種類から、少なくとも2文字ずつ含むこと。 設定後、パスワードをコピーをクリックして、設定したパスワードを保存します。
   AlertManagerパスワード	Alertmanagerサービスのログインパスワードです。ランダムに生成するをクリックすると、obdが自動的にランダム文字列を生成しますが、手動で設定することもできます。手動設定の場合、パスワードの複雑さは以下の要件を満たす必要があります。 長さが8～32文字であること。 数字(0～9)、大文字(A～Z)、小文字(a～z)、特殊文字(~!@#%^&*_-+=|(){}[]:;,.?/`$"<>\)の各種類から、少なくとも2文字ずつ含むこと。 設定後、パスワードをコピーをクリックして、設定したパスワードを保存します。
   OBProxy SQLポート	ODPのリスニングポートです。デフォルトは2883で、カスタマイズ可能です（1025～65535の範囲のみサポート）。設定したポートが使用されていないことを確認してください。
   OBProxy Exporterポート	OBProxyのExporterポートです。PrometheusがOBProxyの監視データを取得するために使用されます。デフォルトは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：デプロイ

その中で：

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

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

  説明

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

• デプロイレポートで、対応するコンポーネントの前にある展開アイコンをクリックすると、デプロイのログ情報を確認できます。対応するコンポーネントリストの詳細を見るをクリックし、対応するコマンドの後ろのコピーアイコンをクリックするとコマンドをコピーできます。コピー後、中央管理システムで実行して対応するコンポーネントのログファイルの場所を確認できます。

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

（オプション）ステップ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