本記事では、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ユーザーのパスワードを指定する必要があります。rootユーザーのパスワードは、環境変数OB_ROOT_PASSWORDでも指定できます。
obshell agent restart
このコマンドを使用して、obshellを再起動します。
${home_path}/bin/obshell agent restart
home_pathはOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内のbinディレクトリに配置されています。
obshell agent upgrade
このコマンドを使用して、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 を設定すると実行プロセスの詳細情報を出力します。値を指定する必要はありません。 |