TiUPを使用して DMクラスタを管理

このドキュメントでは、 TiUP DMコンポーネントを使用して DM クラスターを維持する方法を紹介します。

DM クラスターをまだデプロイしていない場合は、手順についてTiUPを使用した DMクラスタのデプロイを参照してください。

注記：
次のコンポーネント間のポートが相互接続されていることを確認してください
DM マスターノードのうちのpeer_port (デフォルトでは8291 ) は相互接続されています。
各 DM マスターノードは、すべての DM ワーカーノードのうちport (デフォルトでは8262 ) に接続できます。
各 DM ワーカーノードは、すべての DM マスターノードのうちport (デフォルトでは8261 ) に接続できます。
TiUPノードは、すべての DM マスターノードのうちのportに接続できます (デフォルトでは8261 )。
TiUPノードは、すべての DM ワーカーノードのうちのportに接続できます (デフォルトでは8262 )。

TiUP DMコンポーネントのヘルプ情報を表示するには、次のコマンドを実行します。

tiup dm --help

Deploy a DM cluster for production

Usage:
  tiup dm [flags]
  tiup dm [command]

Available Commands:
  deploy      Deploy a DM cluster for production
  start       Start a DM cluster
  stop        Stop a DM cluster
  restart     Restart a DM cluster
  list        List all clusters
  destroy     Destroy a specified DM cluster
  audit       Show audit log of cluster operation
  exec        Run shell command on host in the dm cluster
  edit-config Edit DM cluster config
  display     Display information of a DM cluster
  reload      Reload a DM cluster's config and restart if needed
  upgrade     Upgrade a specified DM cluster
  patch       Replace the remote package with a specified package and restart the service
  scale-out   Scale out a DM cluster
  scale-in    Scale in a DM cluster
  import      Import an exist DM 1.0 cluster from dm-ansible and re-deploy 2.0 version
  help        Help about any command

Flags:
  -h, --help               help for tiup-dm
      --native-ssh         Use the native SSH client installed on local system instead of the build-in one.
      --ssh-timeout int    Timeout in seconds to connect host via SSH, ignored for operations that don't need an SSH connection. (default 5)
  -v, --version            version for tiup-dm
      --wait-timeout int   Timeout in seconds to wait for an operation to complete, ignored for operations that don't fit. (default 60)
  -y, --yes                Skip all confirmations and assumes 'yes'

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

クラスターが正常にデプロイされたら、次のコマンドを実行してクラスターのリストを表示します。

tiup dm list

Name  User  Version  Path                                  PrivateKey
----  ----  -------  ----                                  ----------
prod-cluster  tidb  ${version}  /root/.tiup/storage/dm/clusters/test  /root/.tiup/storage/dm/clusters/test/ssh/id_rsa

クラスターを開始する

クラスターが正常にデプロイされたら、次のコマンドを実行してクラスターを起動します。

tiup dm start prod-cluster

クラスターの名前を忘れた場合は、 tiup dm listを実行してクラスターのリストを表示します。

クラスターのステータスを確認する

TiUP には、クラスター内の各コンポーネントのステータスを表示するコマンドがtiup dm displayあります。このコマンドを使用すると、コンポーネントのステータスを確認するために各マシンにログインする必要がなくなります。コマンドの使用方法は次のとおりです。

tiup dm display prod-cluster

dm Cluster: prod-cluster
dm Version: ${version}
ID                 Role          Host          Ports      OS/Arch       Status     Data Dir                           Deploy Dir
--                 ----          ----          -----      -------       ------     --------                           ----------
172.19.0.101:9093  alertmanager  172.19.0.101  9093/9094  linux/x86_64  Up         /home/tidb/data/alertmanager-9093  /home/tidb/deploy/alertmanager-9093
172.19.0.101:8261  dm-master     172.19.0.101  8261/8291  linux/x86_64  Healthy|L  /home/tidb/data/dm-master-8261     /home/tidb/deploy/dm-master-8261
172.19.0.102:8261  dm-master     172.19.0.102  8261/8291  linux/x86_64  Healthy    /home/tidb/data/dm-master-8261     /home/tidb/deploy/dm-master-8261
172.19.0.103:8261  dm-master     172.19.0.103  8261/8291  linux/x86_64  Healthy    /home/tidb/data/dm-master-8261     /home/tidb/deploy/dm-master-8261
172.19.0.101:8262  dm-worker     172.19.0.101  8262       linux/x86_64  Free       /home/tidb/data/dm-worker-8262     /home/tidb/deploy/dm-worker-8262
172.19.0.102:8262  dm-worker     172.19.0.102  8262       linux/x86_64  Free       /home/tidb/data/dm-worker-8262     /home/tidb/deploy/dm-worker-8262
172.19.0.103:8262  dm-worker     172.19.0.103  8262       linux/x86_64  Free       /home/tidb/data/dm-worker-8262     /home/tidb/deploy/dm-worker-8262
172.19.0.101:3000  grafana       172.19.0.101  3000       linux/x86_64  Up         -                                  /home/tidb/deploy/grafana-3000
172.19.0.101:9090  prometheus    172.19.0.101  9090       linux/x86_64  Up         /home/tidb/data/prometheus-9090    /home/tidb/deploy/prometheus-9090

Status列は、サービスが正常に実行されているかどうかを示すためにUpまたはDownを使用します。

DM マスターコンポーネントの場合、ステータスに|L追加される場合があります。これは、DM マスターノードがLeaderであることを示します。 DM ワーカーコンポーネントの場合、 Free現在の DM ワーカーノードがアップストリームにバインドされていないことを示します。

クラスタースケールイン

クラスター内でのスケーリングとは、一部のノードをオフラインにすることを意味します。この操作により、指定されたノードがクラスターから削除され、残りのデータファイルが削除されます。

クラスターをスケールインすると、DM マスターコンポーネントと DM ワーカーコンポーネントに対する DM 操作が次の順序で実行されます。

コンポーネントのプロセスを停止します。
DM マスターの API を呼び出してmemberを削除します。
ノードに関連するデータファイルをクリーンアップします。

スケールインコマンドの基本的な使用法:

tiup dm scale-in <cluster-name> -N <node-id>

このコマンドを使用するには、クラスター名とノード ID という少なくとも 2 つの引数を指定する必要があります。ノード ID は、前のセクションのtiup dm displayコマンドを使用して取得できます。

たとえば、DM ワーカーノードを172.16.5.140でスケーリングするには (DM マスターでのスケーリングと同様)、次のコマンドを実行します。

tiup dm scale-in prod-cluster -N 172.16.5.140:8262

クラスターをスケールアウトする

スケールアウト操作には、デプロイメントの内部ロジックと同様の内部ロジックがあります。TiUP TiUP DMコンポーネントは、最初にノードの SSH 接続を確保し、ターゲットノード上に必要なディレクトリを作成してから、デプロイメント操作を実行して、ノードサービスを開始します。

たとえば、 prod-clusterクラスター内の DM ワーカーノードをスケールアウトするには、次の手順を実行します (DM マスターのスケールアウトにも同様の手順があります)。

scale.yamlファイルを作成し、新しいワーカーノードの情報を追加します。
注記：
トポロジファイルを作成する必要があります。このファイルには、既存のノードではなく、新しいノードの説明のみが含まれます。その他の設定項目 (展開ディレクトリなど) については、このTiUP設定パラメータの例を参照してください。
```
---

worker_servers:
  - host: 172.16.5.140
```
スケールアウト操作を実行します。 TiUP DM は、 scale.yamlで説明したポート、ディレクトリ、およびその他の情報に従って、対応するノードをクラスターに追加します。
```
tiup dm scale-out prod-cluster scale.yaml
```
コマンドの実行後、 tiup dm display prod-clusterを実行してスケールアウトされたクラスターのステータスを確認できます。

ローリングアップグレード

注記：
v2.0.5 以降、 dmctl はデータソースのエクスポートとインポート、およびクラスターのタスクコンフィグレーションをサポートします。
アップグレードする前に、 config exportを使用してクラスターの構成ファイルをエクスポートできます。アップグレード後、以前のバージョンにダウングレードする必要がある場合は、まず以前のクラスターを再デプロイし、次にconfig importを使用して以前の構成ファイルをインポートします。
v2.0.5 より前のクラスターの場合は、dmctl v2.0.5 以降を使用して、データソースおよびタスク構成ファイルをエクスポートおよびインポートできます。
v2.0.2 以降のクラスターの場合、現在、リレーワーカーに関連する構成の自動インポートはサポートされていません。 start-relayコマンドを使用して手動でリレーログの開始実行できます。

ローリングアップグレードプロセスはアプリケーションに対して可能な限り透過的に行われ、ビジネスには影響しません。操作はノードによって異なります。

アップグレードコマンド

tiup dm upgradeコマンドを実行して DM クラスターをアップグレードできます。たとえば、次のコマンドはクラスターを${version}にアップグレードします。このコマンドを実行する前に、 ${version}必要なバージョンに変更します。

tiup dm upgrade prod-cluster ${version}

構成を更新する

コンポーネント構成を動的に更新する場合、 TiUP DMコンポーネントは各クラスターの現在の構成を保存します。この構成を編集するには、 tiup dm edit-config <cluster-name>コマンドを実行します。例えば：

tiup dm edit-config prod-cluster

TiUP DM は、 vi エディターで構成ファイルを開きます。他のエディターを使用する場合は、 EDITOR環境変数を使用してエディターをカスタマイズします ( export EDITOR=nanoなど)。ファイルを編集した後、変更を保存します。新しい構成をクラスターに適用するには、次のコマンドを実行します。

tiup dm reload prod-cluster

このコマンドは、構成をターゲットマシンに送信し、クラスターを再起動して構成を有効にします。

コンポーネントを更新する

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

tiup dm patch --help

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

Usage:
  tiup dm 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 dm-master leaders (default 600)

Global Flags:
      --native-ssh         Use the native SSH client installed on local system instead of the build-in one.
      --ssh-timeout int    Timeout in seconds to connect host via SSH, ignored for operations that don't need an SSH connection. (default 5)
      --wait-timeout int   Timeout in seconds to wait for an operation to complete, ignored for operations that don't fit. (default 60)
  -y, --yes                Skip all confirmations and assumes 'yes'

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

tiup dm patch prod-cluster /tmp/dm-master-hotfix.tar.gz -R dm-master

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

tiup dm patch prod-cluster /tmp/dm--hotfix.tar.gz -N 172.16.4.5:8261

DM-Ansible を使用してデプロイされた DM 1.0 クラスターをインポートおよびアップグレードする

注記：
TiUP は、 DM 1.0 クラスターへの DM Portalコンポーネントのインポートをサポートしていません。
インポートする前に元のクラスターを停止する必要があります。
2.0 にアップグレードする必要があるタスクにはstop-taskを実行しないでください。
TiUP は、v2.0.0-rc.2 以降のバージョンの DM クラスターへのインポートのみをサポートします。
importコマンドは、DM 1.0 クラスターから新しい DM 2.0 クラスターにデータをインポートするために使用されます。 DM 移行タスクを既存の DM 2.0 クラスターにインポートする必要がある場合は、 TiDB データ移行を v1.0.x から v2.0+ に手動でアップグレードするを参照してください。
一部のコンポーネントのデプロイメントディレクトリは、元のクラスターのデプロイメントディレクトリと異なります。 displayコマンドを実行して詳細を表示できます。
インポートする前にtiup update --self && tiup update dmを実行して、 TiUP DMコンポーネントが最新バージョンであることを確認します。
インポート後のクラスターには DM マスターノードが 1 つだけ存在します。 DM マスターをスケールアウトするには、クラスターをスケールアウトするを参照してください。

TiUPがリリースされる前は、DM クラスターのデプロイに DM-Ansible がよく使用されていました。 TiUP がDM-Ansible によってデプロイされた DM 1.0 クラスターを引き継ぐことができるようにするには、 importコマンドを使用します。

たとえば、DM Ansible を使用してデプロイされたクラスターをインポートするには、次のようにします。

tiup dm import --dir=/path/to/dm-ansible --cluster-version ${version}

tiup list dm-masterを実行して、 TiUPでサポートされている最新のクラスターバージョンを表示します。

importコマンドを使用するプロセスは次のとおりです。

TiUP は、 DM-Ansible を使用して以前にデプロイされた DM クラスターに基づいてトポロジファイルtopology.ymlを生成します。
トポロジファイルが生成されたことを確認したら、それを使用して v2.0 以降のバージョンの DM クラスターをデプロイできます。

デプロイメントが完了したら、 tiup dm startコマンドを実行してクラスターを起動し、DM カーネルのアップグレードプロセスを開始できます。

操作ログをビュー

操作ログを表示するには、 auditコマンドを使用します。 auditコマンドの使用方法は次のとおりです。

Usage:
  tiup dm audit [audit-id] [flags]

Flags:
  -h, --help   help for audit

[audit-id]引数が指定されていない場合、コマンドは実行されたコマンドのリストを表示します。例えば：

tiup dm audit

ID      Time                  Command
--      ----                  -------
4D5kQY  2020-08-13T05:38:19Z  tiup dm display test
4D5kNv  2020-08-13T05:36:13Z  tiup dm list
4D5kNr  2020-08-13T05:36:10Z  tiup dm deploy -p prod-cluster ${version} ./examples/dm/minimal.yaml

最初の列はaudit-idです。特定のコマンドの実行ログを表示するには、次のようにaudit-id引数を渡します。

tiup dm audit 4D5kQY

DM クラスター内のホストでコマンドを実行する

DM クラスター内のホストでコマンドを実行するには、 execコマンドを使用します。 execコマンドの使用方法は次のとおりです。

Usage:
  tiup dm exec <cluster-name> [flags]

Flags:
      --command string   the command run on cluster host (default "ls")
  -h, --help             help for exec
  -N, --node strings     Only exec on host with specified nodes
  -R, --role strings     Only exec on host with specified roles
      --sudo             use root permissions (default false)

たとえば、すべての DM ノードでls /tmpを実行するには、次のコマンドを実行します。

tiup dm exec prod-cluster --command='ls /tmp'

dmctl

TiUP はDM クラスターコントローラーを統合しますdmctl 。

dmctl を使用するには、次のコマンドを実行します。

tiup dmctl [args]

dmctlのバージョンを指定します。このコマンドを実行する前に、 ${version}必要なバージョンに変更します。

tiup dmctl:${version} [args]

ソースを追加する前の dmctl コマンドはdmctl --master-addr master1:8261 operate-source create /tmp/source1.ymlです。 dmctl がTiUPに統合された後のコマンドは次のとおりです。

tiup dmctl --master-addr master1:8261 operate-source create /tmp/source1.yml

システムのネイティブ SSH クライアントを使用してクラスターに接続します

クラスターマシン上で実行される上記のすべての操作は、 TiUPに組み込まれた SSH クライアントを使用してクラスターに接続し、コマンドを実行します。ただし、シナリオによっては、そのようなクラスター操作を実行するために、制御マシンシステムにネイティブな SSH クライアントを使用する必要がある場合もあります。例えば：

認証に SSH プラグインを使用するには
カスタマイズされた SSH クライアントを使用するには

次に、 --native-sshコマンドラインフラグを使用して、システムネイティブのコマンドラインツールを有効にします。

クラスターをデプロイ。 tiup dm deploy <cluster-name> <version> <topo> --native-ssh . <cluster-name>にはクラスターの名前を、 <version>にはデプロイする DM バージョン ( v7.1.3など)、 <topo>にはトポロジファイル名を入力します。
クラスターを開始します。 tiup dm start <cluster-name> --native-ssh .
クラスターのアップグレード: tiup dm upgrade ... --native-ssh

システムのネイティブ SSH クライアントを使用するには、上記のすべてのクラスター操作コマンドに--native-sshを追加します。

すべてのコマンドにこのようなフラグを追加しないようにするには、 TIUP_NATIVE_SSHシステム変数を使用してローカル SSH クライアントを使用するかどうかを指定します。

export TIUP_NATIVE_SSH=true
# or
export TIUP_NATIVE_SSH=1
# or
export TIUP_NATIVE_SSH=enable

この環境変数と--native-ssh同時に指定した場合は--native-sshが優先されます。

注記：
クラスター展開のプロセス中に、接続にパスワードを使用する必要がある場合、またはキーファイルにpassphraseが設定されている場合は、制御マシンにsshpassがインストールされていることを確認する必要があります。それ以外の場合は、タイムアウトエラーが報告されます。