TiUPコマンドを使用してTiUPコンポーネントを管理する
次のTiUPコマンドを使用して、 TiUPエコシステム内のコンポーネントを管理できます。
- list:コンポーネントリストを問い合わせます。このTiUPコマンドを使用すると、インストールするすべてのオプション コンポーネントと、各コンポーネントのすべてのオプション バージョンを確認できます。
- install:コンポーネントの特定のバージョンをインストールします。
- update:コンポーネントを最新バージョンに更新します。
- uninstall:コンポーネントをアンインストールします。
- status: 実行中のコンポーネントのステータスを確認します。
- clean:コンポーネントがデプロイされているインスタンスをクリーンアップします。
- help: ヘルプ情報を出力します。このコマンドに別のTiUPコマンドを追加すると、追加されたコマンドの使用法が出力されます。
このドキュメントでは、一般的なコンポーネント管理操作と、対応するTiUPコマンドを紹介します。
コンポーネントリストをクエリする
tiup listコマンドを使用してコンポーネントリストをクエリできます。このコマンドの使用法は次のとおりです。
tiup list: インストールできるコンポーネントを確認します。tiup list ${component}: 特定のコンポーネントのどのバージョンをインストールできるかを確認します。
上記のコマンドで次のフラグを使用することもできます。
--installed: どのコンポーネントまたは特定のコンポーネントのどのバージョンがローカルにインストールされているかを確認します。 ---all: 非表示のコンポーネントを含むすべてのコンポーネントを表示します ---verbose: すべての列を表示します (インストールされているバージョンとサポートされているプラットフォームを含む)
例 1: 現在インストールされているすべてのコンポーネントをビュー。
tiup list --installed
例 2: インストール可能なすべてのバージョンの TiKVコンポーネントのリストをサーバーから取得します。
tiup list tikv
コンポーネントのインストール
tiup installコマンドを使用してコンポーネントリストをクエリできます。このコマンドの使用法は次のとおりです。
tiup install <component>: 指定されたコンポーネントの最新の安定したバージョンをインストールします。tiup install <component>:[version]: 指定されたコンポーネントの指定されたバージョンをインストールします。
例 1: TiUPを使用して、TiDB の最新の安定バージョンをインストールします。
tiup install tidb
例 2: TiUPを使用して、TiDB の夜間バージョンをインストールします。
tiup install tidb:nightly
例 3: TiUPを使用して TiKV v7.1.3 をインストールします。
tiup install tikv:v7.1.3
コンポーネントをアップグレードする
コンポーネントの新しいバージョンが公開された後、 tiup updateコマンドを使用してこのコンポーネントをアップグレードできます。このコマンドの使用法は、次のフラグを除き、基本的にtiup installの使用法と同じです。
--all: すべてのコンポーネントをアップグレードします。--nightly: 夜間バージョンにアップグレードします。--self: TiUP自体を最新バージョンにアップグレードします。--force: 強制的に最新バージョンにアップグレードします。
例 1: すべてのコンポーネントを最新バージョンにアップグレードします。
tiup update --all
例 2: すべてのコンポーネントを夜間バージョンにアップグレードします。
tiup update --all --nightly
例 3: TiUP を最新バージョンにアップグレードします。
tiup update --self
コンポーネントの操作
インストールが完了したら、 tiup <component>コマンドを使用して、対応するコンポーネントを起動できます。
tiup [flags] <component>[:version] [args...]
Flags:
-T, --tag string Specifies the tag for the component instance.
このコマンドを使用するには、コンポーネント名とオプションのバージョンを指定する必要があります。バージョンが指定されていない場合は、このコンポーネントの最新の安定バージョン (インストールされている) が使用されます。
コンポーネントが開始される前に、 TiUP はコンポーネント用のディレクトリを作成し、このコンポーネントを操作用のディレクトリに置きます。コンポーネントはすべてのデータをこのディレクトリに生成します。このディレクトリの名前は、コンポーネントの動作時に指定されたタグ名になります。タグが指定されていない場合、タグ名はランダムに生成されます。この作業ディレクトリは、インスタンスが終了すると自動的に削除されます。
同じコンポーネントを複数回起動して、以前の作業ディレクトリを再利用する場合は、コンポーネントの起動時に--tagを使用して同じ名前を指定できます。タグを指定すると、インスタンス終了時に作業ディレクトリが自動的に削除されなくなるため、作業ディレクトリを再利用するのに便利です。
例 1: TiDB v7.1.3 を動作させます。
tiup tidb:v7.1.3
例2：TiKVが動作するタグを指定します。
tiup --tag=experiment tikv
コンポーネントの動作ステータスを問い合わせる
tiup statusコマンドを使用して、コンポーネントの動作ステータスを確認できます。
tiup status
このコマンドを実行すると、インスタンスのリストが 1 行に 1 つずつ表示されます。リストには次の列が含まれます。
Name: インスタンスのタグ名。Component: インスタンスのコンポーネント名。PID: 動作中のインスタンスのプロセスID。Status: インスタンスのステータス。RUNNINGインスタンスが動作していることを意味します。TERMインスタンスが終了したことを意味します。Created Time: インスタンスの開始時刻。Directory: インスタンスの作業ディレクトリ。--tagを使用して指定できます。Binary: インスタンスの実行可能プログラム。--binpathを使用して指定できます。Args: 動作中のインスタンスの引数。
クリーンコンポーネントインスタンス
tiup cleanコマンドを使用すると、コンポーネントインスタンスをクリーンアップし、作業ディレクトリを削除できます。クリーニング前にインスタンスがまだ動作している場合は、関連するプロセスが最初に強制終了されます。コマンドの使用方法は次のとおりです。
tiup clean [tag] [flags]
次のフラグがサポートされています。
--all: すべてのインスタンス情報をクリーンアップします。
上記のコマンドでは、 tagがクリーニング対象のインスタンス タグです。 --allを使用すると、タグは渡されません。
例 1: experimentタグ名を持つコンポーネントインスタンスをクリーンアップします。
tiup clean experiment
例 2: すべてのコンポーネントインスタンスをクリーンアップします。
tiup clean --all
コンポーネントのアンインストール
TiUPを使用してインストールされたコンポーネントは、ローカル ディスク領域を占有します。古いバージョンのコンポーネントをあまり保持したくない場合は、現在インストールされているコンポーネントのバージョンを確認してから、このコンポーネントをアンインストールします。
tiup uninstallコマンドを使用すると、コンポーネントのすべてのバージョンまたは特定のバージョンをアンインストールできます。このコマンドは、すべてのコンポーネントのアンインストールもサポートしています。コマンドの使用方法は次のとおりです。
tiup uninstall [component][:version] [flags]
このコマンドでは次のフラグがサポートされています。
--all: すべてのコンポーネントまたはバージョンをアンインストールします。--self: TiUP自体をアンインストールします。
componentはアンインストールするコンポーネントです。 versionはアンインストールするバージョンです。 tiup uninstallコマンドでは、 componentとversionは両方とも無視できます。これら 2 つのいずれかを無視した場合は、 --allフラグを追加する必要があります。
- バージョンが無視される場合、
--allを追加すると、このコンポーネントのすべてのバージョンがアンインストールされます。 - バージョンとコンポーネントの両方が無視される場合、
--allを追加すると、すべてのバージョンのすべてのコンポーネントがアンインストールされます。
例 1: TiDB v7.1.3 をアンインストールします。
tiup uninstall tidb:v7.1.3
例 2: すべてのバージョンの TiKV をアンインストールします。
tiup uninstall tikv --all
例 3: インストールされているすべてのコンポーネントをアンインストールします。
tiup uninstall --all