obdのグラフィカルインターフェースを使用したOceanBaseクラスタのデプロイ

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

用語解説

• OceanBaseデータベース

  企業向けに完全自社開発されたネイティブ分散型データベースです。詳細については、OceanBaseデータベースドキュメントを参照してください。

• obd

  OceanBase Deployerの略称で、OceanBaseのインストールおよびデプロイツールです。詳細については、OceanBaseインストール・デプロイツールドキュメントを参照してください。

• ODP

  OceanBase Database Proxyの略称で、OceanBaseデータベース専用のプロキシサーバーです。詳細については、OceanBaseデータベースプロキシドキュメントを参照してください。

• OBAgent

  OBAgentはOceanBaseデータベースの監視データ収集フレームワークで、プッシュ型とプル型の2種類のデータ収集モードをサポートし、さまざまなアプリケーションシナリオに対応できます。

• obconfigserver

  OceanBase Configserverの略称で、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文字 少なくとも以下の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ポート	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データベースコンポーネントの後に続く接続文字列をコマンドラインで実行すると、root@sysユーザーがOceanBaseクラスターに接続されます。OBProxyコンポーネントの後に続く接続文字列を実行すると、root@proxysysユーザーがODPに接続されます。

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

  説明

  Aliyunなどのクラウド環境では、プログラムがパブリック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