📣
TiDB Cloud Premium はパブリックプレビュー中です。エンタープライズワークロード向けの無制限のスケーリング、即時の弾力性、高度なセキュリティを提供します。このページは自動翻訳されたものです。原文はこちらからご覧ください。
AI
開発者
ベストプラクティス
API

GitHub を使用してデータアプリを自動的にデプロイ

TiDB Cloudは、 JSON構文を使用してデータアプリの構成全体をコードとして表現する、コンフィグレーションコード（CaC）アプローチを提供します。

データアプリをGitHubに接続することで、 TiDB CloudはCaC方式を使用し、データアプリの設定を設定ファイルとして、指定したGitHubリポジトリとブランチにプッシュできます。

GitHub接続でAuto Sync & Deploymentが有効になっている場合、GitHub上の設定ファイルを更新することでデータアプリを変更することもできます。設定ファイルの変更をGitHubにプッシュすると、新しい設定がTiDB Cloudに自動的にデプロイされます。

このドキュメントでは、GitHub を使用してデータアプリを自動的にデプロイする方法と、GitHub 接続を管理する方法について説明します。

始める前に

データアプリをGitHubに接続する前に、以下のものを用意してください。

  • GitHubアカウント。
  • ターゲットブランチを含むGitHubリポジトリ。

ステップ1：データアプリをGitHubに接続する

アプリを作成するときに、データアプリを GitHub に接続できます。詳細については、データアプリを作成するを参照してください。

アプリ作成時にGitHub接続を有効にしなかった場合でも、以下の手順で有効にすることができます。

  1. プロジェクトのData Serviceページに移動します。

  2. 左側のペインで、対象のデータアプリの名前をクリックすると、その詳細が表示されます。

  3. Settingsタブで、 Connect to GitHubエリアのConnectをクリックします。接続設定用のダイアログボックスが表示されます。

  4. ダイアログボックスで、以下の手順を実行してください。

    1. Install on GitHubをクリックし、画面の指示に従って、 TiDB Cloud Data Serviceをアプリケーションとして対象のリポジトリにインストールしてください。

    2. Authorizeをクリックして、GitHub上のアプリケーションへのアクセスを承認してください。

    3. データアプリの設定ファイルを保存する対象リポジトリ、ブランチ、およびディレクトリを指定してください。

    4. TiDB CloudコンソールまたはGitHubで行われたデータアプリの変更を相互に同期させるには、 Configure Auto Sync & Deploymentを有効にします。

      • この機能を有効にすると、指定したGitHubディレクトリで行われた変更がTiDB Cloudに自動的にデプロイされ、 TiDB Cloudコンソールで行われた変更もGitHubにプッシュされます。関連するデプロイおよびコミット情報は、データアプリのデプロイ履歴で確認できます。
      • この機能を無効にすると、指定したGitHubディレクトリで行われた変更はTiDB Cloudにデプロイされず、 TiDB Cloudコンソールで行われた変更もGitHubにプッシュされません。

  5. Confirm Connectをクリックしてください。

ステップ2. データアプリの設定をGitHubと同期する

データアプリデータアプリを作成するときに GitHub 接続が有効になっている場合、 TiDB Cloud はアプリの作成直後にこのデータアプリの構成ファイルを GitHub にプッシュします。

アプリ作成後にGitHub接続が有効になっている場合は、データアプリの設定をGitHubと同期するためにデプロイ操作を実行する必要があります。たとえば、 [Deployments]タブをクリックし、このデータアプリのデプロイを再デプロイすることができます。

デプロイ操作後、指定したGitHubディレクトリを確認してください。 tidb-cloud-data-serviceによってData Appの設定ファイルがディレクトリにコミットされていることが確認できます。これは、Data AppがGitHubに正常に接続されたことを意味します。ディレクトリ構造は以下のとおりです。

├── <Your Data App directory on GitHub>
│   ├── data_sources
│   │   └── cluster.json  # specifies the linked TiDB Cloud Starter instances or TiDB Cloud Dedicated clusters.
│   ├── dataapp_config.json # specifies the Data APP ID, name, type, version, and description.
│   ├── http_endpoints
│   │   ├── config.json # specifies the endpoints.
│   │   └── sql # contains SQL files of the endpoints.
│   │       ├── <method>-<endpoint-path1>.sql
│   │       ├── <method>-<endpoint-path2>.sql
│   │       └── <method>-<endpoint-path3>.sql

ステップ3．データアプリを変更する

Auto Sync & Deploymentが有効になっている場合、GitHubまたはTiDB Cloudコンソールのいずれかを使用してデータアプリを変更できます。

オプション1：GitHub上のファイルを更新してデータアプリを修正する

設定ファイルを更新する際は、以下の点に注意してください。

ファイルディレクトリ注記
data_source/cluster.jsonこのファイルを更新する際は、リンクされているTiDB Cloud StarterインスタンスまたはTiDB Cloud Dedicatedクラスターにアクセスできることを確認してください。TiDB Cloud StarterインスタンスまたはTiDB Cloud Dedicatedクラスターの ID は、その URL から取得できます。たとえば、URL がhttps://tidbcloud.com/tidbs/1234567891234567890/overview?orgId=<organization-id>の場合、ID は1234567891234567890です。
http_endpoints/config.jsonエンドポイントを変更する場合は、 HTTPエンドポイント構成で説明されているルールに従ってください。
http_endpoints/sql/method-<endpoint-path>.sqlhttp_endpoints/sqlディレクトリに SQL ファイルを追加または削除するには、対応するエンドポイント構成も更新する必要があります。
datapp_config.jsonapp_idファイルが別のデータアプリからコピーされたもので、現在のデータアプリの ID に更新したい場合を除き、このファイルのdataapp_config.jsonフィールドを変更しないでください。そうしないと、この変更によってトリガーされるデプロイが失敗します。

これらのファイルのフィールド構成の詳細については、 データアプリの設定ファイルを参照してください。

ファイルの変更がコミットされプッシュされると、 TiDB CloudはGitHub上の最新の変更内容を反映したデータアプリを自動的にデプロイします。デプロイのステータスとコミット情報は、デプロイ履歴で確認できます。

オプション2： TiDB Cloudコンソールでデータアプリを変更する

TiDB Cloudコンソールでデータアプリのエンドポイントデータアプリのエンドポイントを変更する後 (エンドポイントの変更など)、次のように変更を確認して GitHub にデプロイできます。

  1. 右上隅のDeployをクリックしてください。変更内容を確認するためのダイアログが表示されます。

  2. レビュー内容に応じて、以下のいずれかを実行してください。

    • 現在の草稿に基づいてさらに変更を加えたい場合は、このダイアログを閉じて変更を行ってください。
    • 現在の変更を前回のデプロイメントの状態に戻したい場合は、 Discard Draftをクリックしてください。
    • 変更内容に問題がなければ、変更内容の説明（任意）を入力し、 Deploy and Push to GitHubをクリックします。デプロイ状況は上部のバナーに表示されます。

デプロイが成功すると、 TiDB Cloudコンソールで行われた変更は自動的にGitHubにプッシュされます。

既存のデータアプリの設定をインポートする

既存のデータアプリの設定を新しいデータアプリにインポートするには、次の手順を実行します。

  1. 既存のデータアプリの設定ファイルを、GitHub上の新しいブランチまたはディレクトリにコピーします。

  2. プロジェクトのData Serviceページで、GitHub に接続せずに新しいデータアプリを作成する。

  3. Auto Sync & Deploymentを有効にして、新しいデータアプリをGitHubに接続します。新しいデータアプリのターゲット リポジトリ、ブランチ、ディレクトリを指定するときは、コピーした構成ファイルを含む新しいパスを使用します。

  4. 新しいデータアプリのIDと名前を取得します。左側のペインで新しいデータアプリの名前をクリックすると、右側のペインのData App Properties領域にアプリのIDと名前が表示されます。

  5. GitHub の新しいパスで、 app_idファイル内のapp_nameとdatapp_config.jsonを取得した ID と名前に更新し、変更をプッシュしてください。

    ファイルの変更がGitHubにプッシュされると、 TiDB Cloudは最新の変更内容を反映した新しいデータアプリを自動的にデプロイします。

  6. GitHubからインポートされた設定を表示するには、 TiDB Cloudコンソールのウェブページを更新してください。

    デプロイ履歴では、デプロイ状況やコミット情報も確認できます。

GitHub接続を編集する

データアプリのGitHub接続を編集する場合（リポジトリ、ブランチ、ディレクトリの切り替えなど）、以下の手順を実行してください。

  1. プロジェクトのData Serviceページに移動します。

  2. 左側のペインで、対象のデータアプリの名前をクリックすると、その詳細が表示されます。

  3. Connect to GitHubエリアで、 接続設定用のダイアログボックスが表示されます。

  4. ダイアログボックスで、データアプリのリポジトリ、ブランチ、およびディレクトリを変更します。

  5. TiDB CloudコンソールまたはGitHubで行われたデータアプリの変更を相互に同期させるには、 Configure Auto Sync & Deploymentを有効にします。

    • この機能を有効にすると、指定したGitHubディレクトリで行われた変更がTiDB Cloudに自動的にデプロイされ、 TiDB Cloudコンソールで行われた変更もGitHubにプッシュされます。関連するデプロイおよびコミット情報は、データアプリのデプロイ履歴で確認できます。
    • この機能を無効にすると、指定したGitHubディレクトリで行われた変更はTiDB Cloudにデプロイされず、 TiDB Cloudコンソールで行われた変更もGitHubにプッシュされません。

  6. Confirm Connectをクリックしてください。

GitHub接続を削除

データアプリをGitHubに接続しなくなった場合は、以下の手順に従ってください。

  1. プロジェクトのData Serviceページに移動します。
  2. 左側のペインで、対象のデータアプリの名前をクリックすると、その詳細が表示されます。
  3. Settingsタブで、 Connect to GitHubエリアのDisconnectをクリックします。
  4. 切断を確定するには、 Disconnectをクリックしてください。

接続解除操作後、データアプリの設定ファイルは GitHub ディレクトリに残りますが、 tidb-cloud-data-serviceによって同期されなくなります。

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