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

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

データ アプリを GitHub に接続することにより、 TiDB CloudはCaC アプローチを使用して、データ アプリ構成を設定ファイルとして優先 GitHub リポジトリおよびブランチにプッシュできます。

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

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

あなたが始める前に

データ アプリを GitHub に接続する前に、次のものが揃っていることを確認してください。

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

注記：

GitHub リポジトリは、データ アプリを接続した後にデータアプリ構成ファイルを保存するために使用されます。構成ファイル内の情報 (クラスター ID やエンドポイント URL など) が機密である場合は、パブリック リポジトリではなくプライベート リポジトリを必ず使用してください。

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

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

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

1. プロジェクトのデータサービスページに移動します。

2. 左側のペインで、ターゲット データ アプリの名前をクリックして詳細を表示します。

3. [設定]タブの[GitHub に接続]領域で[接続] をクリックします。接続設定のダイアログボックスが表示されます。

4. ダイアログ ボックスで、次の手順を実行します。

   1. [GitHub にインストール] をクリックし、画面上の指示に従ってTiDB Cloud Data Serviceをアプリケーションとしてターゲット リポジトリにインストールします。

   2. 「承認」をクリックして、GitHub 上のアプリケーションへのアクセスを承認します。

   3. データ アプリの構成ファイルを保存するターゲット リポジトリ、ブランチ、ディレクトリを指定します。

      注記：

      • ディレクトリはスラッシュ ( / ) で始まる必要があります。たとえば、 /mydata 。指定したディレクトリがターゲット リポジトリおよびブランチに存在しない場合は、自動的に作成されます。
      • リポジトリ、ブランチ、ディレクトリの組み合わせによって構成ファイルのパスが識別されます。このパスはデータ アプリ間で一意である必要があります。指定したパスがすでに別のデータ アプリで使用されている場合は、代わりに新しいパスを指定する必要があります。そうしないと、現在のデータ アプリのTiDB Cloudコンソールで構成されたエンドポイントによって、指定したパス内のファイルが上書きされます。
      • 指定したパスに別のデータ アプリからコピーされた構成ファイルが含まれており、これらのファイルを現在のデータ アプリにインポートする場合は、 既存のデータ アプリの構成をインポートするを参照してください。

   4. TiDB Cloudコンソールまたは GitHub で行われたデータ アプリの変更が相互に同期されるようにするには、 [自動同期とデプロイメントの構成]を有効にします。

      • これを有効にすると、指定した GitHub ディレクトリで行われた変更をTiDB Cloudに自動的にデプロイでき、 TiDB Cloudコンソールで行われた変更も同様に GitHub にプッシュできます。データ アプリのデプロイ履歴で、対応するデプロイとコミットの情報を見つけることができます。
      • これを無効にすると、指定した GitHub ディレクトリで行われた変更はTiDB Cloudにデプロイされず、 TiDB Cloudコンソールで行われた変更も GitHub にプッシュされません。

5. [接続の確認]をクリックします。

ステップ 2. データ アプリ構成を GitHub と同期する

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

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

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

├── 
│   ├── data_sources
│   │   └── cluster.json  # specifies the linked 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.
│   │       ├── -.sql
│   │       ├── -.sql
│   │       └── -.sql

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

自動同期とデプロイメントが有効になっている場合、GitHub またはTiDB Cloudコンソールを使用してデータ アプリを変更できます。

• オプション 1: GitHub 上のファイルを更新してデータ アプリを変更する
• オプション 2: TiDB Cloudコンソールでデータ アプリを変更する

注記：

GitHub とTiDB Cloudコンソールでデータ アプリを同時に変更した場合、競合を解決するには、コンソールで加えた変更を破棄するか、コンソールの変更で GitHub の変更を上書きするかを選択できます。

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

構成ファイルを更新するときは、次の点に注意してください。

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

ファイルの変更がコミットされてプッシュされると、 TiDB Cloud は最新の変更を含むデータ アプリを GitHub に自動的にデプロイします。デプロイメント履歴でデプロイメントのステータスとコミット情報を表示できます。

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

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

1. 右上隅にある「デプロイ」をクリックします。加えた変更を確認するためのダイアログが表示されます。

2. レビューに応じて、次のいずれかを実行します。

   • 現在のドラフトに基づいてさらに変更を加えたい場合は、このダイアログを閉じて変更を加えます。
   • 現在の変更を最後のデプロイメントに戻す場合は、 「ドラフトを破棄」をクリックします。
   • 現在の変更に問題がない場合は、変更の説明 (オプション) を入力し、 [デプロイ and Push to GitHub]をクリックします。導入ステータスは上部のバナーに表示されます。

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

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

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

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

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

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

4. 新しいデータ アプリの ID と名前を取得します。左側のペインで新しいデータ アプリの名前をクリックし、右側のペインのデータ アプリのプロパティ領域でアプリ ID と名前を取得できます。

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

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

6. GitHub からインポートされた構成を表示するには、 TiDB Cloudコンソールの Web ページを更新します。

   デプロイメント履歴でデプロイメントのステータスとコミット情報を表示することもできます。

GitHub接続を編集する

データ アプリの GitHub 接続を編集する場合 (リポジトリ、ブランチ、ディレクトリの切り替えなど)、次の手順を実行します。

1. プロジェクトのデータサービスページに移動します。

2. 左側のペインで、ターゲット データ アプリの名前をクリックして詳細を表示します。

3. 「GitHub に接続」領域で、 をクリックします。 。接続設定のダイアログボックスが表示されます。

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

   注記：

   • ディレクトリはスラッシュ ( / ) で始まる必要があります。たとえば、 /mydata 。指定したディレクトリがターゲット リポジトリおよびブランチに存在しない場合は、自動的に作成されます。
   • リポジトリ、ブランチ、ディレクトリの組み合わせによって構成ファイルのパスが識別されます。このパスはデータ アプリ間で一意である必要があります。指定したパスがすでに別のデータ アプリで使用されている場合は、代わりに新しいパスを指定する必要があります。そうしないと、現在のデータ アプリのTiDB Cloudコンソールで構成されたエンドポイントによって、指定したパス内のファイルが上書きされます。
   • 指定したパスに別のデータ アプリからコピーされた構成ファイルが含まれており、これらのファイルを現在のデータ アプリにインポートする場合は、 既存のデータ アプリの構成をインポートするを参照してください。

5. TiDB Cloudコンソールまたは GitHub で行われたデータ アプリの変更が相互に同期されるようにするには、 [自動同期とデプロイメントの構成]を有効にします。

   • これを有効にすると、指定した GitHub ディレクトリで行われた変更を自動的にTiDB Cloudにデプロイでき、 TiDB Cloudコンソールで行われた変更も同様に GitHub にプッシュできます。データ アプリのデプロイ履歴で、対応するデプロイとコミットの情報を見つけることができます。
   • これを無効にすると、指定した GitHub ディレクトリで行われた変更はTiDB Cloudにデプロイされず、 TiDB Cloudコンソールで行われた変更も GitHub にプッシュされません。

6. [接続の確認]をクリックします。

GitHub 接続を削除する

データ アプリを GitHub に接続したくない場合は、次の手順を実行します。

1. プロジェクトのデータサービスページに移動します。
2. 左側のペインで、ターゲット データ アプリの名前をクリックして詳細を表示します。
3. [設定]タブの[GitHub に接続]領域で[切断]をクリックします。
4. 「切断」をクリックして切断を確認します。

切断操作後、データ アプリ構成ファイルは GitHub ディレクトリに残りますが、 tidb-cloud-data-serviceによって同期されなくなります。