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

クラスターの状態をビューする

クラスタを起動したら、各コンポーネントのステータスをチェックして、正常に動作していることを確認します。 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 300)

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}