本記事では、obshellのプロキシコマンドグループについて説明します。プロキシコマンドグループは、obshellを管理するために使用できます。コマンド内で-h / --helpオプションを設定することで、コマンドのヘルプ情報を表示できます。
obshell agent start
このコマンドを使用して、obshellを起動できます。
${home_path}/bin/obshell agent start [--ip] [-P] [--takeover] [--password]
# example
/home/admin/oceanbase/bin/obshell agent start --ip 10.10.10.1 -P 2886
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。
オプションの説明は以下の表を参照してください：
| オプション名 | 必須 | データ型 | デフォルト値 | 説明 |
|---|---|---|---|---|
| --ip | いいえ | string | なし | このobshellがバインドするIPアドレスを設定します。 |
| -P/--port | いいえ | int | 2886 | このobshellがバインドするポート番号を設定します。 |
| --takeover | いいえ | int | 1 | 値を0以外に設定した場合は、タケオーバー起動を意味し、値を0に設定した場合は、タケオーバー起動ではないことを意味します。デフォルトは1であり、タケオーバー起動を意味します。 |
| --password | いいえ | string | なし | このオプションはOceanBaseクラスタのタケオーバーにのみ使用されます。タケオーバー時には、このオプションを使用してOceanBaseクラスタ内のsysテナントのrootユーザーのパスワードを指定する必要があります。環境変数OB_ROOT_PASSWORDを使用してrootユーザーのパスワードを指定することもできます。 |
obshell agent stop
このコマンドを使用して、obshellを停止できます。
${home_path}/bin/obshell agent stop
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。
OceanBaseクラスタを引き継ぐ際には、オプション --password を使用して、OceanBaseクラスタのsysテナントのrootユーザーのパスワードを指定する必要があります。環境変数 OB_ROOT_PASSWORD を使用してrootユーザーのパスワードを指定することもできます。
obshell agent restart
このコマンドを使用して、obshellを再起動できます。
${home_path}/bin/obshell agent restart
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。
obshell agentのアップグレード
このコマンドを使用して、obshellをアップグレードできます。
${home_path}/bin/obshell agent upgrade -d [-V] [-t] [-y]
# example
/home/admin/oceanbase/bin/obshell agent upgrade -d /home/admin/oceanbase/upgrade/ -V 4.2.2.0-20231224224959
home_pathはOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内のbinディレクトリに配置されています。
オプションの説明は以下の表を参照してください：
| オプション名 | 必須 | データ型 | デフォルト値 | 説明 |
|---|---|---|---|---|
| -d/--pkg_directory | はい | string | なし | アップグレードパッケージの保存パスを設定します。 |
| -V/--target_version | いいえ | string | なし | ターゲットバージョンを指定します。正しい形式で指定する必要があります。例：4.2.2.0または4.2.2.0-20231224224959。指定しない場合、-dディレクトリ内の最新バージョンのobshell RPMパッケージが選択されます。 |
| -t/--tmp_directory | いいえ | string | ${home_path}/upgrade | アップグレード中の一時ディレクトリを指定します。ダウンロードしたインストールパッケージおよび解凍インストール中に生成されるすべてのファイルを格納するために使用されます。絶対パスで設定する必要があります。 |
| -y/--yes | いいえ | なし | なし | -y/--yesを設定すると、再確認がキャンセルされることを意味します。値を渡す必要はありません。 |
| -v/--verbose | いいえ | なし | なし | -v/--verboseを設定すると、実行プロセスの詳細情報が出力されることを意味します。値を渡す必要はありません。 |