obshell クラスタコマンド

このドキュメントでは、obshellのクラスタコマンドについて説明します。クラスタコマンドは、OceanBaseクラスタのデプロイおよび管理に使用できます。

コマンド実行時に-h / --helpオプションを指定すると、そのコマンドのヘルプ情報を表示できます。また、タスク実行時にエラーが発生した場合、-v / --verboseオプションを指定すると、コマンドの詳細な実行プロセスを確認できます。

obshell cluster join

このコマンドを使用すると、現在のobshellを指定したクラスタに参加させることができます（OceanBaseクラスタのinit前にこのコマンドを使用します）。

${home_path}/bin/obshell cluster join -z -s [-d] [-r] [-p] [-P] [-o] [-l]

# example
/home/admin/oceanbase/bin/obshell cluster join -z zone1 -s 10.10.10.1

home_pathはOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内のbinディレクトリに配置されています。

コマンドのオプション説明は以下の表のとおりです：

obshell cluster remove

このコマンドを使用すると、指定したobshellをクラスタから削除できます（OceanBaseクラスタのinit前にこのコマンドを使用します）。

${home_path}/bin/obshell cluster remove -s [-y]

# example
/home/admin/oceanbase/bin/obshell cluster remove -s 10.10.10.1

home_pathはOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内のbinディレクトリに配置されています。

オプションの説明は以下の表のとおりです：

obshell cluster init

このコマンドを使用すると、OceanBaseクラスタを初期化できます。

${home_path}/bin/obshell cluster init -n --rp [-i] [-d] [-r] [-p] [-P] [--rs] [-o] [-l] [--create_proxyro_user] [--proxyro_password]

# example
/home/admin/oceanbase/bin/obshell cluster init -n ob-test --rp ********

home_pathはOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内のbinディレクトリに配置されています。

オプションの説明は以下の表のとおりです：

obshell cluster show

このコマンドを使用すると、現在のクラスタ情報を表示できます。

${home_path}/bin/obshell cluster show [-d]

home_pathはOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリのbinディレクトリに配置されています。-d/--show_detailはオプションで、クラスタの詳細情報を表示するかどうかを制御します。値を指定する必要はありません。

OceanBaseクラスタの状態によって、このコマンドの出力は以下の2つの場合があります：

• OceanBaseクラスタが初期化されていない場合、obshellの関連情報のみが表示されます。これにはIPアドレス、バージョン、ポートが含まれます。

• OceanBaseクラスタの初期化が完了した場合、obshellとOceanBaseデータベースの情報が表示されます。OceanBaseデータベースの情報には、cluster、version、zone、sql_port、svr_port、root_server、statusが含まれます。

  statusの状態は以下のとおりです：

  • ACTIVE：OBServerノードとRoot Serviceのハートビートが正常です。

  • INACTIVE：OBServerノードとRoot Serviceのハートビートが途絶えています。

  • DELETING：OBServerノードが削除中です。

  • STOPPED：OBServerノードが停止されました。

obshell cluster start

このコマンドを使用すると、指定された範囲内のOBServerノードを起動したり、OceanBaseクラスタを乗っ取ったりできます。このコマンドで指定範囲内のOBServerノードを起動する場合、その時点でOceanBaseクラスタがすでにobshellによって完全に運用・管理されている必要があります。

クラスタがobshellによって管理されているかどうかの判断方法、およびobshellを使用してOceanBaseクラスタを乗っ取る手順の詳細については、obshell以外でデプロイされたクラスタの乗っ取りを参照してください。OBServerノードを起動する具体的なユースケースについては、OceanBaseクラスタの起動を参照してください。

${home_path}/bin/obshell cluster start [-a] [-s] [-z] [-i] [-y] [--ssh_user] [--ssh_port] [--user_password] [--key_file] [--key_passphrase]

# example
/home/admin/oceanbase/bin/obshell cluster start -s 10.10.10.1:2886,10.10.10.2:2886

home_path はOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。

オプションの説明は以下の表を参照してください：

obshell cluster stop

このコマンドを使用すると、指定された範囲内のobserverプロセスを停止できます。コマンドの詳細なユースケースについては、OceanBaseクラスタの停止を参照してください。

${home_path}/bin/obshell cluster stop [-a] [-s] [-z] [-f] [-t] [-I] [-i] [-y]

# example
/home/admin/oceanbase/bin/obshell cluster stop -s 10.10.10.1:2886 -I

home_path はOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。

オプションの説明は以下の表を参照してください：

obshell cluster upgrade

このコマンドを使用すると、OceanBaseデータベースを指定されたバージョンにアップグレードできます。コマンドの詳細なユースケースについては、OceanBaseクラスタのアップグレードを参照してください。

${home_path}/bin/obshell cluster upgrade -d [-m] [-V] [-t] [-y]

# example
/home/admin/oceanbase/bin/obshell cluster upgrade -d /home/admin/oceanbase/upgrade/ -V 4.2.2.0-20231224224959

home_pathはOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内のbinディレクトリに配置されます。

オプションの説明は以下の表を参照してください：

obshell cluster scale-out

このコマンドを使用すると、現在のノードを指定されたクラスタに拡張できます。コマンドの詳細な使用シナリオについては、obshellを使用したOceanBaseクラスタの拡張を参照してください。

${home_path}/bin/obshell cluster scale-out -z -s [--rp] [-d] [-r] [-p] [-P] [-l] [-o] [-y]

# example
/home/admin/oceanbase/bin/obshell cluster scale-out -s '10.10.10.1:2886' -z 'zone1' -o 'memory_limit=16G,system_memory=8G,log_disk_size=24G,datafile_size=24G' --rp *****

home_path はOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。

オプションの説明は以下の表を参照してください：

obshell cluster scale-in

このコマンドを使用すると、クラスタから指定されたノードまたはZoneを削除できます。

${home_path}/bin/obshell cluster scale-in [-z] [-s]

# example
/home/admin/oceanbase/bin/obshell cluster scale-in -z zone1 
/home/admin/oceanbase/bin/obshell cluster scale-in -s "10.10.10.1:2886" -f

home_path はOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。

オプションの説明は以下の表を参照してください：

obshell cluster backup

このコマンドを使用すると、クラスタ内のすべてのテナントに対してバックアップ関連のパラメータを設定し、バックアップを実行できます。コマンドの詳細な使用方法については、クラスタレベルバックアップの開始を参照してください。

${home_path}/bin/obshell cluster backup [flags]

# example
/home/admin/oceanbase/bin/obshell cluster backup -u /path/to/backup --backup_mode incremental --encryption MySecretPassword

home_path はOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。

オプションの説明は以下の表を参照してください：