TiDB Cloud
TiDB Self-Managed
Learning Center
お問い合わせ

ローカル TiDBクラスタを迅速にデプロイ

TiDB クラスターは、複数のコンポーネントで構成される分散システムです。一般的な TiDB クラスターは、少なくとも 3 つの PD ノード、3 つの TiKV ノード、および 2 つの TiDB ノードで構成されます。TiDB をすぐに試してみたい場合、多数のコンポーネントを手動でデプロイするのは時間がかかり、複雑であると感じるかもしれません。このドキュメントでは、 TiUPのプレイグラウンドコンポーネントと、それを使用してローカル TiDB テスト環境をすばやく構築する方法を紹介します。

TiUP遊び場の概要

プレイグラウンドコンポーネントの基本的な使用方法は次のとおりです。

tiup playground ${version} [flags]

tiup playgroundコマンドを直接実行すると、 TiUP はローカルにインストールされた TiDB、TiKV、および PD コンポーネントを使用するか、これらのコンポーネントの安定バージョンをインストールして、1 つの TiKV インスタンス、1 つの TiDB インスタンス、1 つの PD インスタンス、および 1 つのTiFlashインスタンスで構成される TiDB クラスターを起動します。

このコマンドは実際には次の操作を実行します。

  • このコマンドはプレイグラウンドコンポーネントのバージョンを指定しないため、 TiUP は最初にインストールされているプレイグラウンドコンポーネントの最新バージョンをチェックします。最新バージョンが v1.12.3 であると仮定すると、このコマンドはtiup playground:v1.12.3と同じように動作します。
  • TiUPプレイグラウンドを使用して TiDB、TiKV、および PD コンポーネントをインストールしていない場合、プレイグラウンドコンポーネントはこれらのコンポーネントの最新の安定バージョンをインストールしてから、これらのインスタンスを起動します。
  • このコマンドは TiDB、PD、および TiKVコンポーネントのバージョンを指定しないため、 TiUPプレイグラウンドはデフォルトで各コンポーネントの最新バージョンを使用します。最新バージョンが v8.5.0 であると仮定すると、このコマンドはtiup playground:v1.12.3 v8.5.0と同じように動作します。
  • このコマンドは各コンポーネントの数を指定しないため、 TiUPプレイグラウンドはデフォルトで、1 つの TiDB インスタンス、1 つの TiKV インスタンス、1 つの PD インスタンス、および 1 つのTiFlashインスタンスで構成される最小のクラスターを起動します。
  • 各 TiDBコンポーネントを起動すると、 TiUPプレイグラウンドはクラスターが正常に起動したことを通知し、MySQL クライアント経由で TiDB クラスターに接続する方法やTiDBダッシュボードにアクセスする方法などの役立つ情報を提供します。

次のコマンドを使用して、プレイグラウンドコンポーネントのコマンドライン フラグを表示できます。

tiup playground --help

例

利用可能なTiDBバージョンを確認する

tiup list tidb

特定のバージョンのTiDBクラスタを起動する

tiup playground ${version}

${version}ターゲットのバージョン番号に置き換えます。

ナイトリーバージョンのTiDBクラスタを起動する

tiup playground nightly

上記のコマンドでは、 nightly TiDB の最新の開発バージョンを示します。

PDのデフォルト設定を上書きする

まず、 PD 構成テンプレートをコピーする必要があります。コピーしたファイルを~/config/pd.tomlに配置し、必要に応じて変更を加えたら、次のコマンドを実行して PD のデフォルト設定を上書きできます。

tiup playground --pd.config ~/config/pd.toml

デフォルトのバイナリファイルを置き換える

デフォルトでは、プレイグラウンドを起動すると、各コンポーネントは公式ミラーからのバイナリ ファイルを使用して起動されます。テスト用に一時的にコンパイルされたローカル バイナリ ファイルをクラスターに配置する場合は、置き換えに--{comp}.binpathフラグを使用できます。たとえば、TiDB のバイナリ ファイルを置き換えるには、次のコマンドを実行します。

tiup playground --db.binpath /xx/tidb-server

複数のコンポーネントインスタンスを起動する

デフォルトでは、TiDB、TiKV、PDコンポーネントごとに 1 つのインスタンスのみが起動されます。各コンポーネントに対して複数のインスタンスを起動するには、次のフラグを追加します。

tiup playground --db 3 --pd 3 --kv 3

TiDBクラスタを起動するときにデータを保存するタグを指定します

TiUPプレイグラウンドを使用して起動した TiDB クラスターを停止すると、すべてのクラスター データもクリーンアップされます。TiUP プレイグラウンドを使用してTiUPクラスターを起動し、クラスター データが自動的にクリーンアップされないようにするには、クラスターの起動時にタグを指定します。タグを指定すると、クラスター データは~/.tiup/dataディレクトリにあります。タグを指定するには、次のコマンドを実行します。

tiup playground --tag ${tag_name}

この方法で起動したクラスターの場合、クラスターが停止した後もデータ ファイルは保持されます。次回クラスターを起動するときにこのタグを使用すると、クラスターが停止してから保持されているデータを使用できます。

プレイグラウンドによって開始された TiDB クラスターにすばやく接続します

TiUP は、プレイグラウンドによって起動されたローカル TiDB クラスターを自動的に検出して接続するために使用されるclientコンポーネントを提供します。使用方法は次のとおりです。

tiup client

このコマンドは、コンソール上の現在のマシンでプレイグラウンドによって起動された TiDB クラスターのリストを表示します。接続する TiDB クラスターを選択します。Enterをクリックすると、組み込みの MySQL クライアントが開き、TiDB に接続します。

起動したクラスターの情報をビュー

tiup playground display

上記のコマンドは次の結果を返します。

Pid    Role     Uptime
---    ----     ------
84518  pd       35m22.929404512s
84519  tikv     35m22.927757153s
86189  tidb     exited
86526  tidb     34m28.293148663s

クラスターをスケールアウトする

クラスターをスケールアウトするためのコマンドライン パラメータは、クラスターを起動するためのものと似ています。次のコマンドを実行すると、2 つの TiDB インスタンスをスケールアウトできます。

tiup playground scale-out --db 2

クラスターのスケールイン

tiup playground scale-inコマンドでpid指定すると、対応するインスタンスをスケールできます。 pidを表示するには、 tiup playground displayを実行します。

tiup playground scale-in --pid 86526

PDマイクロサービスのデプロイ

v8.2.0 以降では、 TiUPを使用してPDマイクロサービスモード (実験的) をデプロイできます。 次のように、 TiUP Playground を使用して、クラスターにtsoマイクロサービスとschedulingマイクロサービスをデプロイできます。

tiup playground v8.5.0 --pd.mode ms --pd 3 --tso 2 --scheduling 2
  • --pd.mode : msに設定すると、PD のマイクロサービス モードが有効になります。
  • --pd <num> : PD マイクロサービスの API の数を指定します。少なくとも1である必要があります。
  • --tso <num> : tsoマイクロサービスにデプロイされるインスタンスの数を指定します。
  • --scheduling <num> : schedulingマイクロサービスにデプロイされるインスタンスの数を指定します。

このページは役に立ちましたか？