TiDB ダッシュボードをデプロイ

TiDB ダッシュボード UI は、v4.0 以降のバージョンの PD コンポーネントに組み込まれており、追加のデプロイは必要ありません。標準の TiDB クラスターをデプロイするだけで、TiDB ダッシュボードが表示されます。

標準の TiDB クラスターをデプロイする方法については、次のドキュメントを参照してください。

ノート:

v4.0 より前の TiDB クラスターに TiDB ダッシュボードをデプロイすることはできません。

複数の PD インスタンスを使用した展開

複数の PD インスタンスがクラスターにデプロイされている場合、これらのインスタンスの 1 つだけが TiDB ダッシュボードを提供します。

PD インスタンスが初めて実行されるとき、それらは自動的に相互にネゴシエートして、TiDB ダッシュボードにサービスを提供するインスタンスを 1 つ選択します。 TiDB ダッシュボードは、他の PD インスタンスでは実行されません。 TiDB ダッシュボード サービスは、PD インスタンスが再起動されたり、新しい PD インスタンスが結合されたりしても、選択された PD インスタンスによって常に提供されます。ただし、TiDB ダッシュボードを提供する PD インスタンスがクラスターから削除される (スケールインされる) と、再ネゴシエーションが発生します。ネゴシエーション プロセスでは、ユーザーの介入は必要ありません。

TiDB ダッシュボードを提供しない PD インスタンスにアクセスすると、ブラウザが自動的にリダイレクトされ、TiDB ダッシュボードを提供する PD インスタンスにアクセスするように誘導されるため、通常どおりサービスにアクセスできます。このプロセスを下の図に示します。

Process Schematic

ノート:

TiDB ダッシュボードを提供する PD インスタンスは、PD リーダーではない可能性があります。

実際に TiDB ダッシュボードを提供する PD インスタンスを確認する

TiUP を使用して展開された実行中のクラスターの場合、 tiup cluster displayコマンドを使用して、どの PD インスタンスが TiDB ダッシュボードにサービスを提供しているかを確認できます。 CLUSTER_NAMEをクラスター名に置き換えます。

tiup cluster display CLUSTER_NAME --dashboard

出力例は次のとおりです。

http://192.168.0.123:2379/dashboard/

ノート:

この機能は、 tiup cluster展開ツールの新しいバージョン (v1.0.3 以降) でのみ使用できます。

TiUPクラスタのアップグレード
tiup update --self tiup update cluster --force

TiDB ダッシュボードを提供するために別の PD インスタンスに切り替える

TiUP を使用して展開された実行中のクラスターの場合、 tiup ctl pdコマンドを使用して、TiDB ダッシュボードを提供する PD インスタンスを変更するか、無効になっている場合に TiDB ダッシュボードを提供する PD インスタンスを再指定できます。

tiup ctl pd -u http://127.0.0.1:2379 config set dashboard-address http://9.9.9.9:2379

上記のコマンドでは:

  • 127.0.0.1:2379を任意の PD インスタンスの IP とポートに置き換えます。
  • 9.9.9.9:2379を、TiDB ダッシュボード サービスを実行する新しい PD インスタンスの IP とポートに置き換えます。

tiup cluster displayコマンドを使用して、変更が有効になっているかどうかを確認できます ( CLUSTER_NAMEをクラスター名に置き換えます)。

tiup cluster display CLUSTER_NAME --dashboard

TiDB ダッシュボードを無効にする

TiUP を使用して展開された実行中のクラスターの場合、 tiup ctl pdコマンドを使用して、すべての PD インスタンスで TiDB ダッシュボードを無効にします ( 127.0.0.1:2379を任意の PD インスタンスの IP とポートに置き換えます)。

tiup ctl pd -u http://127.0.0.1:2379 config set dashboard-address none

TiDB ダッシュボードを無効にした後、どの PD インスタンスが TiDB ダッシュボード サービスを提供しているかの確認に失敗します。

Error: TiDB Dashboard is disabled

ブラウザ経由で PD インスタンスの TiDB ダッシュボード アドレスにアクセスしても失敗します。

Dashboard is not started.

TiDB ダッシュボードを再度有効にする

TiUP を使用してデプロイされた実行中のクラスターの場合、 tiup ctl pdコマンドを使用して、TiDB ダッシュボードを実行するインスタンスを再ネゴシエートするよう PD に要求します ( 127.0.0.1:2379を任意の PD インスタンスの IP とポートに置き換えます)。

tiup ctl pd -u http://127.0.0.1:2379 config set dashboard-address auto

上記のコマンドを実行した後、 tiup cluster displayコマンドを使用して、PD によって自動的にネゴシエートされた TiDB ダッシュボード インスタンス アドレスを表示できます ( CLUSTER_NAMEをクラスター名に置き換えます)。

tiup cluster display CLUSTER_NAME --dashboard

TiDB ダッシュボードを提供する PD インスタンスを手動で指定して、TiDB ダッシュボードを再度有効にすることもできます。 TiDB ダッシュボードを提供するために別の PD インスタンスに切り替えるを参照してください。

次は何ですか