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 v6.5.2 をインストールします。
tiup install tikv:v6.5.2
コンポーネントのアップグレード
コンポーネントの新しいバージョンが公開された後、 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 v6.5.2 を操作します。
tiup tidb:v6.5.2
例 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 v6.5.2 をアンインストールします。
tiup uninstall tidb:v6.5.2
例 2: すべてのバージョンの TiKV をアンインストールします。
tiup uninstall tikv --all
例 3: インストールされているすべてのコンポーネントをアンインストールします。
tiup uninstall --all