TiUPクラスター

TiUP Clusterは、Golangで記述されたTiUPのクラスタ管理コンポーネントです。 TiUPクラスターコンポーネントを使用して、展開、開始、シャットダウン、破棄、エラスティックスケーリング、TiDBクラスターのアップグレード、TiDBクラスタパラメーターの管理など、日常の操作とメンテナンスを実行できます。

構文

tiup cluster [command] [flags]

[command]はコマンドの名前です。サポートされているコマンドについては、以下のコマンドリストを参照してください。

オプション

--ssh

• コマンド実行のためにリモートエンド（TiDBサービスが展開されているマシン）に接続するSSHクライアントを指定します。

• データ型： STRING

• サポートされている値：

  • builtin ：SSHクライアントとしてtiup-clusterに組み込まれているeasysshクライアントを使用します。
  • system ：現在のオペレーティングシステムのデフォルトのSSHクライアントを使用します。
  • none ：SSHクライアントは使用されません。展開は、現在のマシンのみを対象としています。

• コマンドでこのオプションが指定されていない場合、デフォルト値としてbuiltinが使用されます。

--ssh-timeout

• SSH接続タイムアウトを秒単位で指定します。
• データ型： UINT
• このオプションがコマンドで指定されていない場合、デフォルトのタイムアウトは5秒です。

--wait-timeout

• 操作プロセスの各ステップの最大待機時間（秒単位）を指定します。操作プロセスは、サービスを開始または停止するようにsystemctlを指定したり、ポートがオンラインまたはオフラインになるのを待機したりするなど、多くのステップで構成されます。各ステップには数秒かかる場合があります。ステップの実行時間が指定されたタイムアウトを超えると、ステップはエラーで終了します。
• データ型： UINT
• コマンドでこのオプションが指定されていない場合、各ステップの最大待機時間は120秒です。

-y、-yes

• すべての危険な操作の二次確認をスキップします。スクリプトを使用してTiUPを呼び出す場合を除いて、このオプションの使用はお勧めしません。
• このオプションは、デフォルトでfalseの値で無効になっています。このオプションを有効にするには、このオプションをコマンドに追加し、 trueの値を渡すか、値を渡さないようにします。

-v、-version

• TiUPクラスターの現在のバージョンを印刷します。
• データ型： BOOLEAN
• このオプションは、デフォルトでfalseの値で無効になっています。このオプションを有効にするには、このオプションをコマンドに追加し、 trueの値を渡すか、値を渡さないようにします。

-h、-help

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

コマンドリスト

• 輸入 ：Ansibleによってデプロイされたクラスタをインポートします
• テンプレート ：トポロジーテンプレートを出力します
• 小切手 ：デプロイの前後にクラスタをチェックします
• 配備 ：指定されたトポロジに基づいてクラスタをデプロイします
• リスト ：デプロイされたクラスターのリストを照会します
• 画面 ：指定したクラスタの状態を表示します
• 始める ：指定されたクラスタを開始します
• 止まる ：指定されたクラスタを停止します
• 再起動 ：指定したクラスタを再起動します
• スケールイン ：指定されたクラスタのスケール
• 規格外 ：指定されたクラスタをスケールアウトします
• アップグレード ：指定されたクラスタをアップグレードします
• プルーン ：指定されたクラスタのトゥームストーンステータスのインスタンスをクリーンアップします
• edit-config ：指定したクラスタの構成を変更します
• リロード ：指定されたクラスタの構成を再ロードします
• パッチ ：デプロイされたクラスタのサービスを置き換えます
• 名前を変更 ：クラスタの名前を変更します
• 掃除 ：指定したクラスタからデータを削除します
• 破壊する ：指定されたクラスタを破棄します
• 監査 ：指定されたクラスタの操作監査ログを照会します
• リプレイ ：指定したコマンドを再試行します
• 有効 ：マシンの再起動後にクラスタサービスの自動有効化を有効にします。
• 無効にする ：マシンの再起動後にクラスタサービスの自動有効化を無効にします。
• ヘルプ ：ヘルプ情報を出力します

<<前のページに戻る-TiUPリファレンスコンポーネントリスト