リバースプロキシの背後で TiDB ダッシュボードを使用する

HAプロキシリバース プロキシとして使用する場合は、次の手順を実行します。

1. たとえば、 8033ポートで TiDB ダッシュボードのリバース プロキシを使用します。HAProxy 構成ファイルに、次の構成を追加します。

   frontend tidb_dashboard_front
     bind *:8033
     use_backend tidb_dashboard_back if { path /dashboard } or { path_beg /dashboard/ }
   
   backend tidb_dashboard_back
     mode http
     server tidb_dashboard 192.168.0.123:2379
   

   192.168.0.123:2379を、 ステップ1で取得した TiDB ダッシュボードの実際のアドレスの IP とポートに置き換えます。

   警告

   このパス内のサービスのみがリバース プロキシの背後にあることを保証するために、 use_backendディレクティブのif部分を保持する必要があります。そうしないと、セキュリティ リスクが発生する可能性があります。 セキュリティTiDB ダッシュボードを参照してください。

2. 設定を有効にするには、HAProxy を再起動します。

3. リバース プロキシが有効かどうかをテストします。HAProxy が配置されているマシンの8033ポート ( http://example.com:8033/dashboard/など) の/dashboard/アドレスにアクセスして、TiDB ダッシュボードにアクセスします。

NGINX とはリバース プロキシとして使用する場合は、次の手順を実行します。

1. たとえば、 8033ポートで TiDB ダッシュボードのリバース プロキシを使用します。NGINX 構成ファイルに次の構成を追加します。

   server {
       listen 8033;
       location /dashboard/ {
       proxy_pass http://192.168.0.123:2379/dashboard/;
       }
   }
   

   http://192.168.0.123:2379/dashboard/ ステップ1で取得した TiDB ダッシュボードの実際のアドレスに置き換えます。

   警告

   このパスの下にあるサービスのみがリバース プロキシされるようにするには、 proxy_passディレクティブに/dashboard/パスを保持する必要があります。そうしないと、セキュリティ リスクが発生します。 セキュリティTiDB ダッシュボードを参照してください。

2. 設定を有効にするには、NGINX をリロードします。

   sudo nginx -s reload
   

3. リバース プロキシが有効かどうかをテストします。NGINX が配置されているマシンの8033ポートの/dashboard/アドレス ( http://example.com:8033/dashboard/など) にアクセスして、TiDB ダッシュボードにアクセスします。

新しいクラスターを展開する場合は、上記の構成をtopology.yaml TiUPトポロジ ファイルに追加してクラスターを展開できます。具体的な手順については、 TiUP展開ドキュメントを参照してください。

デプロイされたクラスターの場合:

1. クラスターの構成ファイルを編集モードで開きます ( CLUSTER_NAMEクラスター名に置き換えます)。

   tiup cluster edit-config CLUSTER_NAME
   

2. server_configsのpd構成の下にある構成項目を変更または追加します。 server_configs存在しない場合は、最上位レベルに追加します。

   monitored:
     ...
   server_configs:
     tidb: ...
     tikv: ...
     pd:
       dashboard.public-path-prefix: /foo
     ...
   

   変更後の設定ファイルは次のファイルのようになります。

   server_configs:
     pd:
       dashboard.public-path-prefix: /foo
     global:
       user: tidb
       ...
   

   または

   monitored:
     ...
   server_configs:
     tidb: ...
     tikv: ...
     pd:
       dashboard.public-path-prefix: /foo
   

3. 変更した設定を有効にするには、すべての PD インスタンスに対してローリング再起動を実行します ( CLUSTER_NAMEクラスター名に置き換えます)。

   tiup cluster reload CLUSTER_NAME -R pd
   

詳細は一般的なTiUP操作 - 構成の変更参照。

http://example.com:8033/foo/例にとると、対応する HAProxy 構成は次のようになります。

frontend tidb_dashboard_front
  bind *:8033
  use_backend tidb_dashboard_back if { path /foo } or { path_beg /foo/ }

backend tidb_dashboard_back
  mode http
  http-request set-path %[path,regsub(^/foo/?,/dashboard/)]
  server tidb_dashboard 192.168.0.123:2379

192.168.0.123:2379を、 ステップ1で取得した TiDB ダッシュボードの実際のアドレスの IP とポートに置き換えます。

TiDB ダッシュボード サービスをルート パス ( http://example.com:8033/など) で実行する場合は、次の構成を使用します。

frontend tidb_dashboard_front
  bind *:8033
  use_backend tidb_dashboard_back
backend tidb_dashboard_back
  mode http
  http-request set-path /dashboard%[path]
  server tidb_dashboard 192.168.0.123:2379

設定を変更し、変更した設定を有効にするために HAProxy を再起動します。

http://example.com:8033/foo/例にとると、対応する NGINX 構成は次のようになります。

server {
  listen 8033;
  location /foo/ {
    proxy_pass http://192.168.0.123:2379/dashboard/;
  }
}

http://192.168.0.123:2379/dashboard/ ステップ1で取得した TiDB ダッシュボードの実際のアドレスに置き換えます。

TiDB ダッシュボード サービスをルート パス ( http://example.com:8033/など) で実行する場合は、次の構成を使用します。

server {
  listen 8033;
  location / {
    proxy_pass http://192.168.0.123:2379/dashboard/;
  }
}

設定を変更し、変更した設定を有効にするために NGINX を再起動します。

sudo nginx -s reload