重要

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

tiup cluster check

正式な本番環境では、環境が稼働する前に、一連のチェックを実行して、クラスターが最高のパフォーマンスを発揮していることを確認する必要があります。手動チェック手順を簡素化するために、 TiUP クラスタは、指定されたクラスターのターゲットマシンのハードウェアおよびソフトウェア環境が正常に動作するための要件を満たしているかどうかを確認するcheckコマンドを提供します。

チェック項目一覧

オペレーティングシステムのバージョン

展開されたマシンのオペレーティングシステムのディストリビューションとバージョンを確認します。現在、展開では CentOS 7 のみがサポートされています。互換性の向上のため、今後のリリースではさらに多くのシステムバージョンがサポートされる可能性があります。

CPU EPOLLEX限定

対象マシンのCPUがEPOLLEXCLUSIVEをサポートしているかどうかを確認します。

ヌマクトル

ターゲットマシンに numactl がインストールされているかどうかを確認します。ターゲットマシンに結び付けられたコアが構成されている場合は、numactl をインストールする必要があります。

システム時刻

対象マシンのシステム時刻が同期されているかどうかを確認します。対象マシンのシステム時刻と中央制御マシンのシステム時刻を比較し、偏差が一定のしきい値（500 ミリ秒）を超える場合はエラーを報告します。

システムのタイムゾーン

対象マシンのシステムタイムゾーンが同期されているかどうかを確認します。これらのマシンのタイムゾーン構成を比較し、タイムゾーンが一致していない場合はエラーを報告します。

時刻同期サービス

ターゲットマシンで時刻同期サービスが設定されているかどうかを確認します。つまり、ntpd が実行されているかどうかを確認します。

スワップパーティション

ターゲットマシンでスワップパーティションが有効になっているかどうかを確認します。スワップパーティションを無効にすることをお勧めします。

カーネルパラメータ

次のカーネルパラメータの値を確認します。

net.ipv4.tcp_tw_recycle : 0
net.ipv4.tcp_syncookies : 0
net.core.somaxconn : 32768
vm.swappiness : 0
vm.overcommit_memory : 0 または 1
fs.file-max : 1000000

透過的な巨大ページ (THP)

ターゲットマシンで THP が有効になっているかどうかを確認します。THP を無効にすることをお勧めします。

システム制限

/etc/security/limits.confファイルの制限値を確認します。

<deploy-user> soft nofile 1000000
<deploy-user> hard nofile 1000000
<deploy-user> soft stack 10240

<deploy-user>は TiDB クラスターを展開して実行するユーザーであり、最後の列はシステムに必要な最小値です。

カーネル

SELinux が有効になっているかどうかを確認します。SELinux を無効にすることをお勧めします。

ファイアウォール

FirewallD サービスが有効になっているかどうかを確認します。FirewallD サービスを無効にするか、TiDB クラスター内の各サービスに権限ルールを追加することをお勧めします。

irqバランス

irqbalance サービスが有効になっているかどうかを確認します。irqbalance サービスを有効にすることをお勧めします。

ディスクマウントオプション

ext4 パーティションのマウントオプションを確認します。マウントオプションに nodelalloc オプションと noatime オプションが含まれていることを確認します。

ポートの使用

トポロジで定義されているポート (自動補完のデフォルトポートを含む) が、ターゲットマシン上のプロセスによってすでに使用されているかどうかを確認します。

注記：
ポート使用状況チェックでは、クラスターがまだ起動されていないことを前提としています。クラスターがすでにデプロイされ起動されている場合、ポートは使用中であるはずなので、クラスターでのポート使用状況チェックは失敗します。

CPUコア数

対象マシンの CPU 情報を確認します。本番クラスターの場合、CPU 論理コアの数は 16 以上が推奨されます。

注記：
CPU コア数はデフォルトではチェックされません。チェックを有効にするには、コマンドに-enable-cpuオプションを追加する必要があります。

メモリー容量

対象マシンのメモリサイズを確認します。本番クラスターの場合、合計メモリ容量は 32 GB 以上が推奨されます。

注記：
メモリサイズはデフォルトではチェックされません。チェックを有効にするには、コマンドに-enable-memオプションを追加する必要があります。

Fioディスクパフォーマンステスト

フレキシブル I/O テスター (fio) を使用して、次の 3 つのテスト項目を含む、 data_dirが配置されているディスクのパフォーマンスをテストします。

fio_randread_write_latency
fio_randread_write
fio_randread

注記：
fio ディスクパフォーマンステストはデフォルトでは実行されません。テストを実行するには、コマンドに-enable-diskオプションを追加する必要があります。

構文

tiup cluster check <topology.yml | cluster-name> [flags]

クラスターがまだデプロイされていない場合は、クラスターをデプロイするために使用されるトポロジー.ymlファイルを渡す必要があります。このファイルの内容に従って、 tiup-cluster は対応するマシンに接続してチェックを実行します。
クラスターがすでにデプロイされている場合は、チェックオブジェクトとして<cluster-name>使用できます。
既存のクラスターのスケールアウト YAML ファイルをチェックする場合は、チェックオブジェクトとして<scale-out.yml>と<cluster-name>両方を使用できます。

注記：
チェックに<cluster-name>使用する場合は、コマンドに--clusterオプションを追加する必要があります。

オプション

- 適用する

失敗したチェック項目を自動的に修復しようとします。現在、 tiup-cluster は次のチェック項目のみを修復しようとします。
- カーネル
- ファイアウォール
- irqバランス
- カーネルパラメータ
- システム制限
- THP (透過的な巨大ページ)
データ型: BOOLEAN
このオプションは、値falseでデフォルトで無効になっています。このオプションを有効にするには、このオプションをコマンドに追加し、値trueを渡すか、値を渡さないようにする必要があります。

注記：
tiup cluster checkでは、次のコマンド形式を使用して、既存のクラスターのscale-out.ymlファイルの修復もサポートされています。
tiup cluster check <cluster-name> scale-out.yml --cluster --apply --user root [-p] [-i /home/root/.ssh/gcp_rsa]

- 集まる

チェックがデプロイ済みのクラスターに対するものであることを示します。
データ型: BOOLEAN
このオプションは、デフォルトで値falseで無効になっています。このオプションを有効にするには、このオプションをコマンドに追加し、値trueを渡すか、値を渡さないようにする必要があります。

コマンド形式:

tiup cluster check <topology.yml | cluster-name> --cluster [flags]

注記：
tiup cluster check <cluster-name>コマンドを使用する場合は、 --clusterオプションtiup cluster check <cluster-name> --clusterを追加する必要があります。
tiup cluster checkでは、次のコマンド形式を使用して、既存のクラスターのscale-out.ymlファイルを確認することもサポートされています。
tiup cluster check <cluster-name> scale-out.yml --cluster --user root [-p] [-i /home/root/.ssh/gcp_rsa]

-N、--ノード

チェックするノードを指定します。このオプションの値はtiup cluster displayノード ID のコンマ区切りリストです。1 コマンドによって返されるクラスターステータステーブルの最初の列からノード ID を取得できます。
データ型: STRINGS
コマンドでこのオプションが指定されていない場合、デフォルトですべてのノードがチェックされます。

注記：
-R, --roleオプションを同時に指定した場合は、 -N, --nodeと-R, --roleの両方の指定に一致するサービスノードのみがチェックされます。

-R, --役割

チェックするロールを指定します。このオプションの値は、ノードロールのコンマ区切りリストです。1 コマンドによって返されるクラスターステータステーブルの 2 番目の列からtiup cluster displayのロールを取得できます。
データ型: STRINGS
コマンドでこのオプションが指定されていない場合、すべてのロールがデフォルトでチェックされます。

注記：
-N, --nodeオプションを同時に指定した場合は、 -N, --nodeと-R, --roleの両方の指定に一致するサービスノードのみがチェックされます。

--CPUを有効にする

CPU コア数のチェックを有効にします。
データ型: BOOLEAN
このオプションは、デフォルトで値falseで無効になっています。このオプションを有効にするには、このオプションをコマンドに追加し、値trueを渡すか、値を渡さないようにする必要があります。

--ディスクを有効にする

fio ディスクパフォーマンステストを有効にします。
データ型: BOOLEAN
このオプションは、値falseでデフォルトで無効になっています。このオプションを有効にするには、このオプションをコマンドに追加し、値trueを渡すか、値を渡さないようにする必要があります。

--enable-mem

メモリサイズのチェックを有効にします。
データ型: BOOLEAN
このオプションは、値falseでデフォルトで無効になっています。このオプションを有効にするには、このオプションをコマンドに追加し、値trueを渡すか、値を渡さないようにする必要があります。

--u、--ユーザー

ターゲットマシンに接続するためのユーザー名を指定します。指定されたユーザーは、ターゲットマシン上でパスワード不要の sudo ルート権限を持っている必要があります。
データ型: STRING
このオプションがコマンドで指定されていない場合は、コマンドを実行するユーザーがデフォルト値として使用されます。

注記：
このオプションは、 -clusterオプションが false の場合にのみ有効です。それ以外の場合、このオプションの値は、クラスター展開のトポロジファイルで指定されたユーザー名に固定されます。

-i, --identity_file

ターゲットマシンに接続するためのキーファイルを指定します。
データ型: STRING
このオプションは、 ~/.ssh/id_rsa (デフォルト値) が渡されるとデフォルトで有効になります。

注記：
このオプションは、 --clusterオプションが false の場合にのみ有効です。それ以外の場合、このオプションの値は${TIUP_HOME}/storage/cluster/clusters/<cluster-name>/ssh/id_rsaに固定されます。

-p, --パスワード

ターゲットマシンに接続するときにパスワードを使用してログインします。
- クラスターに--clusterオプションが追加された場合、パスワードはクラスターがデプロイされたときにトポロジファイルで指定されたユーザーのパスワードになります。
- クラスターにオプション--clusterが追加されていない場合、パスワードはオプション-u/--userで指定されたユーザーのパスワードになります。
データ型: BOOLEAN
このオプションは、値falseでデフォルトで無効になっています。このオプションを有効にするには、このオプションをコマンドに追加し、値trueを渡すか、値を渡さないようにする必要があります。

-h, --help

関連するコマンドのヘルプ情報を出力します。
データ型: BOOLEAN
このオプションは、デフォルトで値falseで無効になっています。このオプションを有効にするには、このオプションをコマンドに追加し、値trueを渡すか、値を渡さないようにする必要があります。

出力

次のフィールドを含むテーブル:

Node : ターゲットノード
Check : チェック項目
Result : チェック結果 (合格、警告、不合格)
Message : 結果の説明

<< 前のページに戻る - TiUPクラスタコマンドリスト