重要

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

TiUP共通操作

このドキュメントでは、 TiUPを使用して TiDB クラスターを操作および保守する場合の次の一般的な操作について説明します。

クラスターリストをビュー
クラスターを起動する
クラスターのステータスをビュー
設定を変更する
クラスターを停止する
クラスターを破壊する

クラスターリストをビュー

TiUPクラスターコンポーネントを使用して、複数の TiDB クラスターを管理できます。TiDB クラスターがデプロイされると、そのクラスターはTiUPクラスターリストに表示されます。

リストを表示するには、次のコマンドを実行します。

tiup cluster list

クラスターを起動する

TiDB クラスター内のコンポーネントは次の順序で起動されます。

PD > TiKV >Pump> TiDB > TiFlash >Drainer> TiCDC > Prometheus > Grafana > Alertmanager

クラスターを起動するには、次のコマンドを実行します。

tiup cluster start ${cluster-name}

注記：
${cluster-name}クラスターの名前に置き換えます。クラスター名を忘れた場合は、 tiup cluster list実行して確認してください。

コマンドに-Rまたは-Nパラメータを追加することで、一部のコンポーネントのみを起動できます。例:

このコマンドは PDコンポーネントのみを起動します。
```
tiup cluster start ${cluster-name} -R pd
```
このコマンドは、ホスト1.2.3.4と1.2.3.5上の PD コンポーネントのみを起動します。
```
tiup cluster start ${cluster-name} -N 1.2.3.4:2379,1.2.3.5:2379
```

注記：
-Rまたは-Nパラメータを使用して指定されたコンポーネントを起動する場合は、起動順序が正しいことを確認してください。たとえば、PDコンポーネントを TiKVコンポーネントの前に起動します。そうしないと、起動が失敗する可能性があります。

クラスターのステータスをビュー

クラスターを起動した後、各コンポーネントのステータスをチェックして、正常に動作していることを確認します。TiUPはdisplayコマンドを提供するため、コンポーネントのステータスを表示するためにすべてのマシンにログインする必要はありません。

tiup cluster display ${cluster-name}

設定を変更する

クラスターが稼働しているときに、コンポーネントのパラメータを変更する必要がある場合は、 edit-configコマンドを実行します。詳細な手順は次のとおりです。

クラスターの構成ファイルを編集モードで開きます。
```
tiup cluster edit-config ${cluster-name}
```
パラメータを設定します。
- 構成がコンポーネントに対してグローバルに有効な場合は、 server_configs編集します。
```
server_configs:
  tidb:
    log.slow-threshold: 300
```
- 特定のノードで設定を有効にする場合は、ノードのconfigで設定を編集します。
```
tidb_servers:
- host: 10.0.1.11
  port: 4000
  config:
      log.slow-threshold: 300
```
パラメータの形式についてはTiUPパラメータテンプレート参照してください。
構成項目の階層を表すには . を使用します.
コンポーネントの構成パラメータの詳細については、 TiDB config.toml.example 、 TiKV config.toml.example 、およびPD config.toml.exampleを参照してください。
reloadコマンドを実行して、構成をローリング更新し、対応するコンポーネントを再起動します。
```
tiup cluster reload ${cluster-name} [-N <nodes>] [-R <roles>]
```

例

tidb-server でトランザクションサイズ制限パラメータ ( パフォーマンスモジュールのtxn-total-size-limit ) を1Gに設定する場合は、次のように設定を編集します。

server_configs:
  tidb:
    performance.txn-total-size-limit: 1073741824

次に、 tiup cluster reload ${cluster-name} -R tidbコマンドを実行して、TiDBコンポーネントをローリング再起動します。

修正プログラムパッケージに置き換える

通常のアップグレードについては、 TiUPを使用して TiDB をアップグレードする参照してください。ただし、デバッグなどの一部のシナリオでは、現在実行中のコンポーネントを一時パッケージに置き換える必要がある場合があります。これを実現するには、 patchコマンドを使用します。

tiup cluster patch --help

Replace the remote package with a specified package and restart the service

Usage:
  cluster patch <cluster-name> <package-path> [flags]

Flags:
  -h, --help                   help for patch
  -N, --node strings           Specify the nodes
      --overwrite              Use this package in the future scale-out operations
  -R, --role strings           Specify the role
      --transfer-timeout int   Timeout in seconds when transferring PD and TiKV store leaders (default 600)

Global Flags:

      --native-ssh        Use the system's native SSH client
      --wait-timeout int  Timeout of waiting the operation
      --ssh-timeout int   Timeout in seconds to connect host via SSH, ignored for operations that don't need an SSH connection. (default 5)
  -y, --yes               Skip all confirmations and assumes 'yes'

TiDB ホットフィックスパッケージが/tmp/tidb-hotfix.tar.gzにあり、クラスター内のすべての TiDB パッケージを置き換える場合は、次のコマンドを実行します。

tiup cluster patch test-cluster /tmp/tidb-hotfix.tar.gz -R tidb

クラスター内の 1 つの TiDB パッケージのみを置き換えることもできます。

tiup cluster patch test-cluster /tmp/tidb-hotfix.tar.gz -N 172.16.4.5:4000

クラスターの名前を変更する

クラスターをデプロイして起動した後、 tiup cluster renameコマンドを使用してクラスターの名前を変更できます。

tiup cluster rename ${cluster-name} ${new-name}

注記：
クラスターの名前を変更する操作により、監視システム (Prometheus および Grafana) が再起動されます。
クラスターの名前を変更した後、古いクラスター名を持つパネルが Grafana に残る場合があります。それらを手動で削除する必要があります。

クラスターを停止する

TiDB クラスター内のコンポーネントは次の順序で停止されます (監視コンポーネントも停止されます)。

Alertmanager > Grafana > Prometheus > TiCDC > Drainer > TiFlash > TiDB > Pump > TiKV > PD

クラスターを停止するには、次のコマンドを実行します。

tiup cluster stop ${cluster-name}

startコマンドと同様に、 stopコマンドは-Rまたは-Nパラメータを追加することで一部のコンポーネントを停止することをサポートします。例:

このコマンドは TiDBコンポーネントのみを停止します。
```
tiup cluster stop ${cluster-name} -R tidb
```
このコマンドは、ホスト1.2.3.4と1.2.3.5上の TiDB コンポーネントのみを停止します。
```
tiup cluster stop ${cluster-name} -N 1.2.3.4:4000,1.2.3.5:4000
```

クラスターデータをクリーンアップする

クラスターデータをクリーンアップする操作では、すべてのサービスが停止し、データディレクトリまたはログディレクトリがクリーンアップされます。この操作は元に戻すことができないため、注意して実行してください。

クラスター内のすべてのサービスのデータをクリーンアップしますが、ログは保持します。
```
tiup cluster clean ${cluster-name} --data
```
クラスター内のすべてのサービスのログをクリーンアップしますが、データは保持します。
```
tiup cluster clean ${cluster-name} --log
```
クラスター内のすべてのサービスのデータとログをクリーンアップします。
```
tiup cluster clean ${cluster-name} --all
```
Prometheus を除くすべてのサービスのログとデータをクリーンアップします。
```
tiup cluster clean ${cluster-name} --all --ignore-role prometheus
```
172.16.13.11:9000インスタンスを除くすべてのサービスのログとデータをクリーンアップします。
```
tiup cluster clean ${cluster-name} --all --ignore-node 172.16.13.11:9000
```
172.16.13.12ノードを除くすべてのサービスのログとデータをクリーンアップします。
```
tiup cluster clean ${cluster-name} --all --ignore-node 172.16.13.12
```

クラスターを破壊する

破棄操作はサービスを停止し、データディレクトリとデプロイメントディレクトリをクリアします。この操作は元に戻すことができないため、注意して続行してください。

tiup cluster destroy ${cluster-name}