重要

このページは英語版のページを機械翻訳しています。原文はこちらからご覧ください。

TiUPコマンドを使用してTiUPコンポーネントを管理する

次のTiUPコマンドを使用して、 TiUPエコシステム内のコンポーネントを管理できます。

list:コンポーネントリストを照会します。このTiUPコマンドを使用すると、インストールするすべてのオプションコンポーネントと、各コンポーネントのすべてのオプションバージョンを確認できます。
install:コンポーネントの特定のバージョンをインストールします。
update:コンポーネントを最新バージョンに更新します。
uninstall:コンポーネントをアンインストールします。
status: 実行中のコンポーネントのステータスを確認します。
clean:コンポーネントがデプロイされているインスタンスをクリーンアップします。
help: ヘルプ情報を出力します。このコマンドに別のTiUPコマンドを追加すると、追加されたコマンドの使用方法が出力されます。
link:コンポーネントのバイナリを実行可能ディレクトリ（ $TIUP_HOME/bin/ ）にリンクします。
unlink: tiup linkコマンドによって生成されたソフトリンクを削除します。

このドキュメントでは、一般的なコンポーネント管理操作と対応する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 v8.1.0 をインストールします。

tiup install tikv:v8.1.0

コンポーネントのアップグレード

コンポーネントの新しいバージョンが公開された後、 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 v8.1.0を操作します。

tiup tidb:v8.1.0

例 2: TiKV が動作するタグを指定します。

tiup --tag=experiment tikv

コンポーネントの動作状態を照会する

tiup statusコマンドを使用して、コンポーネントの動作状態を確認できます。

tiup status

このコマンドを実行すると、インスタンスのリストが 1 行に 1 つずつ表示されます。リストには次の列が含まれます。

Name : インスタンスのタグ名。
Component : インスタンスのコンポーネント名。
PID : 動作中のインスタンスのプロセス ID。
Status : インスタンスのステータス。2 RUNNINGインスタンスが動作中であることを意味します。4 TERMインスタンスが終了していることを意味します。
Created Time : インスタンスの開始時刻。
Directory : インスタンスの作業ディレクトリ。 --tagを使用して指定できます。
Binary : インスタンスの実行可能プログラム。 --binpathを使用して指定できます。
Args : 操作インスタンスの引数。

クリーンなコンポーネントインスタンス

tiup cleanコマンドを使用して、コンポーネントインスタンスをクリーンアップし、作業ディレクトリを削除できます。クリーンアップ前にインスタンスがまだ動作している場合は、関連するプロセスが最初に強制終了されます。コマンドの使用方法は次のとおりです。

tiup clean [tag] [flags]

次のフラグがサポートされています:

--all : すべてのインスタンス情報をクリーンアップします。

上記のコマンドでは、 tagクリーンアップするインスタンスタグです。3 --all使用すると、タグは渡されません。

例 1: experimentタグ名を持つコンポーネントインスタンスをクリーンアップします。

tiup clean experiment

例 2: すべてのコンポーネントインスタンスをクリーンアップします。

tiup clean --all

コンポーネントをアンインストールする

TiUPを使用してインストールされたコンポーネントは、ローカルディスク領域を占有します。古いバージョンのコンポーネントをあまり多く保持したくない場合は、現在インストールされているコンポーネントのバージョンを確認し、このコンポーネントをアンインストールすることができます。

tiup uninstallコマンドを使用して、コンポーネントのすべてのバージョンまたは特定のバージョンをアンインストールできます。このコマンドは、すべてのコンポーネントのアンインストールもサポートしています。コマンドの使用方法は次のとおりです。

tiup uninstall [component][:version] [flags]

このコマンドでは次のフラグがサポートされています。

--all : すべてのコンポーネントまたはバージョンをアンインストールします。
--self : TiUP自体をアンインストールします。

componentはアンインストールするコンポーネントです。2 versionアンインストールするバージョンです。8 コマンドではcomponentとversion両方とも無視できます。これら 2 つのいずれかtiup uninstall無視する場合は、 --allフラグを追加する必要があります。

バージョンが無視される場合、 --all追加すると、このコンポーネントのすべてのバージョンがアンインストールされます。
バージョンとコンポーネントの両方が無視される場合、 --all追加すると、すべてのバージョンのすべてのコンポーネントがアンインストールされます。

例 1: TiDB v8.1.0 をアンインストールします。

tiup uninstall tidb:v8.1.0

例 2: すべてのバージョンの TiKV をアンインストールします。

tiup uninstall tikv --all

例 3: インストールされているすべてのコンポーネントをアンインストールします。

tiup uninstall --all

リンクコンポーネント

TiUP v1.13.0 では、コンポーネントのバイナリを実行可能ディレクトリ ( $TIUP_HOME/bin/ ) にリンクしたり、リンクを削除したりするための実験的コマンドlinkとunlinkが追加されました。この機能により、異なるバージョン間の切り替え機能を維持しながら、毎回TiUPを経由せずにコンポーネントを呼び出すことができます。ただし、この方法では、自動更新チェックや特定の環境変数の設定のプロセスが欠如しており、一部のコンポーネント (ctl など) は使用できません。そのため、必要な場合にのみ使用することをお勧めします。

例1: クラスタコンポーネントの最新バージョンをインストールしてリンクする

tiup install cluster
tiup link cluster

例2: クラスターコンポーネントをバージョンv1.13.0に切り替える

tiup link cluster:v1.13.0

以下はコマンドtiup link clusterの出力です。

package cluster provides these executables: tiup-cluster

これは、クラスターコンポーネントのバイナリ名がtiup-clusterであることを示します。リンクコマンドが完了したら、コマンドラインにtiup-cluster直接入力して、クラスターコンポーネントを使用できます。

例3: クラスターコンポーネントのリンクを解除する

tiup unlink cluster

例4: TiUPのバージョンを管理する

v1.13.0 より前では、 TiUPは~/.tiup/bin/にインストールされており、異なるバージョンは共存できません。v1.13.0 以降では、他のコンポーネントと同様にTiUP をインストールしてリンクできます。

tiup update --self # update tiup itself to a version that supports link
tiup link tiup:v1.13.0