TiDB データベース プラットフォームのクイック スタート ガイド

このガイドでは、TiDB を使い始めるための最も簡単な方法を紹介します。非本番環境では、次のいずれかの方法で TiDB データベースをデプロイできます。

さらに、 TiDB プレイグラウンドで TiDB の機能を試すこともできます。

注記:

このガイドで提供されるデプロイメント方法は、クイック スタートのみを目的としており、本番や包括的な機能および安定性のテストには使用できません

ローカルテストクラスタをデプロイ

  • シナリオ: 単一の macOS または Linuxサーバーを使用して、テスト用のローカル TiDB クラスターを迅速にデプロイします。このようなクラスターをデプロイすることで、TiDB の基本的なアーキテクチャと、TiDB、TiKV、PD、監視コンポーネントなどのコンポーネントの操作を学習できます。
  • macOS
  • Linux

分散システムとして、基本的な TiDB テスト クラスターは通常、2 つの TiDB インスタンス、3 つの TiKV インスタンス、3 つの PD インスタンス、およびオプションのTiFlashインスタンスで構成されます。TiUP Playground を使用すると、次の手順に従ってテスト クラスターをすばやく構築できます。

  1. TiUPをダウンロードしてインストールします:

    curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh

    次のメッセージが表示されたら、 TiUP は正常にインストールされています。

    Successfully set mirror to https://tiup-mirrors.pingcap.com Detected shell: zsh Shell profile: /Users/user/.zshrc /Users/user/.zshrc has been modified to add tiup to PATH open a new terminal or source /Users/user/.zshrc to use it Installed path: /Users/user/.tiup/bin/tiup =============================================== Have a try: tiup playground ===============================================

    上記の出力の Shell プロファイル パスをメモします。次の手順でこのパスを使用する必要があります。

  2. グローバル環境変数を宣言します。

    注記:

    インストール後、 TiUP は対応するシェル プロファイル ファイルの絶対パスを表示します。パスに応じて、次のsourceのコマンドの${your_shell_profile}変更する必要があります。この場合、 ${your_shell_profile}手順 1 の出力の/Users/user/.zshrcになります。

    source ${your_shell_profile}
  3. 現在のセッションでクラスターを起動します。

    • 1 つの TiDB インスタンス、1 つの TiKV インスタンス、1 つの PD インスタンス、および 1 つのTiFlashインスタンスを含む最新バージョンの TiDB クラスターを起動するには、次のコマンドを実行します。

      tiup playground
    • TiDB のバージョンと各コンポーネントのインスタンスの数を指定するには、次のようなコマンドを実行します。

      tiup playground v7.5.3 --db 2 --pd 3 --kv 3

      このコマンドは、バージョン クラスター (v7.5.3 など) をローカル マシンにダウンロードして起動します。最新バージョンを表示するには、 tiup list tidb実行します。

      このコマンドは、クラスターのアクセス方法を返します。

      CLUSTER START SUCCESSFULLY, Enjoy it ^-^ To connect TiDB: mysql --comments --host 127.0.0.1 --port 4001 -u root -p (no password) To connect TiDB: mysql --comments --host 127.0.0.1 --port 4000 -u root -p (no password) To view the dashboard: http://127.0.0.1:2379/dashboard PD client endpoints: [127.0.0.1:2379 127.0.0.1:2382 127.0.0.1:2384] To view Prometheus: http://127.0.0.1:9090 To view Grafana: http://127.0.0.1:3000

      注記:

      • v5.2.0 以降、TiDB は Apple M1 チップを使用するマシン上でtiup playground実行をサポートしています。
      • このように操作したプレイグラウンドでは、テストのデプロイメントが終了した後、 TiUP元のクラスター データがクリーンアップされます。コマンドを再実行すると、新しいクラスターが取得されます。
      • データをstorage上に永続化したい場合は、 tiup --tag <your-tag> playground ...実行します。詳細については、 TiUPリファレンスガイドを参照してください。
  4. TiDB にアクセスするには、新しいセッションを開始します。

    • TiUPクライアントを使用して TiDB に接続します。

      tiup client
    • あるいは、MySQL クライアントを使用して TiDB に接続することもできます。

      mysql --host 127.0.0.1 --port 4000 -u root
  5. http://127.0.0.1:9090で TiDB の Prometheus ダッシュボードにアクセスします。

  6. http://127.0.0.1:2379/ダッシュボードTiDBダッシュボードにアクセスします。デフォルトのユーザー名はrootで、パスワードは空です。

  7. http://127.0.0.1:3000から TiDB の Grafana ダッシュボードにアクセスします。デフォルトのユーザー名とパスワードはどちらもadminです。

  8. (オプション) 分析用にTiFlashにデータをロードする

  9. テストデプロイ後にクラスターをクリーンアップします。

    1. Control+Cを押して上記の TiDB サービスを停止します。
    2. サービスが停止したら、次のコマンドを実行します。

      tiup clean --all

注記:

TiUP Playground はデフォルトで127.0.0.1でリッスンし、サービスはローカルでのみアクセスできます。サービスを外部からアクセス可能にする場合は、 --hostパラメータを使用してリッスン アドレスを指定し、ネットワーク インターフェイス カード (NIC) を外部からアクセス可能な IP アドレスにバインドします。

分散システムとして、基本的な TiDB テスト クラスターは通常、2 つの TiDB インスタンス、3 つの TiKV インスタンス、3 つの PD インスタンス、およびオプションのTiFlashインスタンスで構成されます。TiUP Playground を使用すると、次の手順に従ってテスト クラスターをすばやく構築できます。

  1. TiUPをダウンロードしてインストールします:

    curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh

    次のメッセージが表示されたら、 TiUP は正常にインストールされています。

    Successfully set mirror to https://tiup-mirrors.pingcap.com Detected shell: zsh Shell profile: /Users/user/.zshrc /Users/user/.zshrc has been modified to add tiup to PATH open a new terminal or source /Users/user/.zshrc to use it Installed path: /Users/user/.tiup/bin/tiup =============================================== Have a try: tiup playground ===============================================

    上記の出力の Shell プロファイル パスをメモします。次の手順でこのパスを使用する必要があります。

  2. グローバル環境変数を宣言します。

    注記:

    インストール後、 TiUP は対応するシェル プロファイル ファイルの絶対パスを表示します。パスに応じて、次のsourceのコマンドの${your_shell_profile}変更する必要があります。

    source ${your_shell_profile}
  3. 現在のセッションでクラスターを起動します。

    • 1 つの TiDB インスタンス、1 つの TiKV インスタンス、1 つの PD インスタンス、および 1 つのTiFlashインスタンスを含む最新バージョンの TiDB クラスターを起動するには、次のコマンドを実行します。

      tiup playground
    • TiDB のバージョンと各コンポーネントのインスタンスの数を指定するには、次のようなコマンドを実行します。

      tiup playground v7.5.3 --db 2 --pd 3 --kv 3

      このコマンドは、バージョン クラスター (v7.5.3 など) をローカル マシンにダウンロードして起動します。最新バージョンを表示するには、 tiup list tidb実行します。

      このコマンドは、クラスターのアクセス方法を返します。

      CLUSTER START SUCCESSFULLY, Enjoy it ^-^ To connect TiDB: mysql --host 127.0.0.1 --port 4000 -u root -p (no password) --comments To view the dashboard: http://127.0.0.1:2379/dashboard PD client endpoints: [127.0.0.1:2379] To view the Prometheus: http://127.0.0.1:9090 To view the Grafana: http://127.0.0.1:3000

      注記:

      このように運用したプレイグラウンドでは、テストのデプロイが完了した後、 TiUPによって元のクラスター データがクリーンアップされます。コマンドを再実行すると、新しいクラスターが取得されます。データをstorageに永続化したい場合は、 tiup --tag <your-tag> playground ...実行します。詳細については、 TiUPリファレンスガイドを参照してください。

  4. TiDB にアクセスするには、新しいセッションを開始します。

    • TiUPクライアントを使用して TiDB に接続します。

      tiup client
    • あるいは、MySQL クライアントを使用して TiDB に接続することもできます。

      mysql --host 127.0.0.1 --port 4000 -u root
  5. http://127.0.0.1:9090で TiDB の Prometheus ダッシュボードにアクセスします。

  6. http://127.0.0.1:2379/ダッシュボードTiDBダッシュボードにアクセスします。デフォルトのユーザー名はrootで、パスワードは空です。

  7. http://127.0.0.1:3000から TiDB の Grafana ダッシュボードにアクセスします。デフォルトのユーザー名とパスワードはどちらもadminです。

  8. (オプション) 分析用にTiFlashにデータをロードする

  9. テストデプロイ後にクラスターをクリーンアップします。

    1. Control+Cを押してプロセスを停止します。
    2. サービスが停止したら、次のコマンドを実行します。

      tiup clean --all

注記:

TiUP Playground はデフォルトで127.0.0.1をリッスンし、サービスはローカルでのみアクセスできます。サービスを外部からアクセス可能にする場合は、 --hostパラメータを使用してリッスン アドレスを指定し、ネットワーク インターフェイス カード (NIC) を外部からアクセス可能な IP アドレスにバインドします。

単一のマシンで本番の展開をシミュレートする

  • シナリオ: 完全なトポロジを備えた最小の TiDB クラスターを体験し、単一の Linuxサーバー上で本番展開手順をシミュレートします。

このセクションでは、 TiUPで最小トポロジの YAML ファイルを使用して TiDB クラスターをデプロイする方法について説明します。

準備する

TiDB クラスターを展開する前に、ターゲット マシンが次の要件を満たしていることを確認してください。

  • CentOS 7.3以降のバージョンがインストールされています。
  • Linux OS はインターネットにアクセスでき、TiDB および関連ソフトウェアのインストール パッケージをダウンロードするために必要です。

最小の TiDB クラスター トポロジは、次のインスタンスで構成されます。

注記:

インスタンスの IP アドレスは例としてのみ提供されています。実際の展開では、IP アドレスを実際の IP アドレスに置き換えてください。

実例カウントIPコンフィグレーション
ティクヴ310.0.1.1
10.0.1.1
10.0.1.1
ポートとディレクトリ間の競合を避ける
ティビ110.0.1.1デフォルトポート
グローバルディレクトリ構成
PD110.0.1.1デフォルトポート
グローバルディレクトリ構成
TiFlash110.0.1.1デフォルトポート
グローバルディレクトリ構成
モニター110.0.1.1デフォルトポート
グローバルディレクトリ構成

ターゲット マシンのその他の要件は次のとおりです。

  • rootユーザーとそのパスワードが必要です

  • 対象マシンのファイアウォールサービスを停止します 、またはTiDBクラスタノードに必要なポートを開く

  • 現在、 TiUPクラスターは、x86_64 (AMD64) および ARM アーキテクチャでの TiDB のデプロイをサポートしています。

    • AMD64 では CentOS 7.3 以降のバージョンを使用することをお勧めします。
    • ARM では CentOS 7.6 1810 を使用することをお勧めします。

デプロイ

注記:

対象マシンには、通常のユーザーまたはrootユーザーとしてログインできます。次の手順では、 rootユーザーを例として使用します。

  1. TiUPをダウンロードしてインストールします:

    curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
  2. グローバル環境変数を宣言します。

    注記:

    インストール後、 TiUP は対応するシェル プロファイル ファイルの絶対パスを表示します。パスに応じて、次のsourceのコマンドの${your_shell_profile}変更する必要があります。

    source ${your_shell_profile}
  3. TiUPのクラスターコンポーネントをインストールします。

    tiup cluster
  4. TiUPクラスターがすでにマシンにインストールされている場合は、ソフトウェア バージョンを更新します。

    tiup update --self && tiup update cluster
  5. ルート ユーザー権限を使用して、 sshdサービスの接続制限を増やします。これは、 TiUP が複数のマシンへの展開をシミュレートする必要があるためです。

    1. /etc/ssh/sshd_config変更し、 MaxSessions20に設定します。

    2. sshdサービスを再起動します。

      service sshd restart
  6. クラスターを作成して起動します。

    次のテンプレートに従って構成ファイルを編集し、名前をtopo.yamlにします。

    # # Global variables are applied to all deployments and used as the default value of # # the deployments if a specific deployment value is missing. global: user: "tidb" ssh_port: 22 deploy_dir: "/tidb-deploy" data_dir: "/tidb-data" # # Monitored variables are applied to all the machines. monitored: node_exporter_port: 9100 blackbox_exporter_port: 9115 server_configs: tidb: instance.tidb_slow_log_threshold: 300 tikv: readpool.storage.use-unified-pool: false readpool.coprocessor.use-unified-pool: true pd: replication.enable-placement-rules: true replication.location-labels: ["host"] tiflash: logger.level: "info" pd_servers: - host: 10.0.1.1 tidb_servers: - host: 10.0.1.1 tikv_servers: - host: 10.0.1.1 port: 20160 status_port: 20180 config: server.labels: { host: "logic-host-1" } - host: 10.0.1.1 port: 20161 status_port: 20181 config: server.labels: { host: "logic-host-2" } - host: 10.0.1.1 port: 20162 status_port: 20182 config: server.labels: { host: "logic-host-3" } tiflash_servers: - host: 10.0.1.1 monitoring_servers: - host: 10.0.1.1 grafana_servers: - host: 10.0.1.1
    • user: "tidb" : tidbシステム ユーザー (デプロイメント中に自動的に作成) を使用して、クラスターの内部管理を実行します。デフォルトでは、ポート 22 を使用して SSH 経由でターゲット マシンにログインします。
    • replication.enable-placement-rules : この PD パラメータは、 TiFlash が正常に実行されるように設定されます。
    • host : ターゲットマシンの IP。
  7. クラスター デプロイメント コマンドを実行します。

    tiup cluster deploy <cluster-name> <version> ./topo.yaml --user root -p
    • <cluster-name> : クラスター名を設定する

    • <version> : TiDBクラスタバージョンを設定します(例: v7.5.3 tiup list tidbコマンドを実行すると、サポートされているすべてのTiDBバージョンを確認できます。

    • -p : ターゲットマシンに接続するために使用するパスワードを指定します。

      注記:

      秘密鍵を使用する場合は、 -iで鍵のパスを指定できます。 -i-p同時に使用しないでください。

    展開を完了するには、「y」とrootのユーザーのパスワードを入力します。

    Do you want to continue? [y/N]: y Input SSH password:
  8. クラスターを起動します。

    tiup cluster start <cluster-name>
  9. クラスターにアクセスします。

    • MySQL クライアントをインストールします。すでにインストールされている場合は、この手順をスキップしてください。

      yum -y install mysql
    • TiDB にアクセスします。パスワードが空です:

      mysql -h 10.0.1.1 -P 4000 -u root
    • http://{grafana-ip}:3000で Grafana 監視ダッシュボードにアクセスします。デフォルトのユーザー名とパスワードはどちらもadminです。

    • http://{pd-ip}:2379/ダッシュボードTiDBダッシュボードにアクセスします。デフォルトのユーザー名はrootで、パスワードは空です。

    • 現在デプロイされているクラスターのリストを表示するには:

      tiup cluster list
    • クラスターのトポロジとステータスを表示するには:

      tiup cluster display <cluster-name>

次は何ですか

ローカル テスト環境用に TiDB クラスターをデプロイしたばかりの場合は、次の手順に従います。

本番環境用に TiDB クラスターをデプロイする準備ができたら、次の手順に従います。

TiFlashを使用した分析ソリューションをお探しの場合は、次の手順に従ってください。

このページは役に立ちましたか?