コンテンツにスキップ

PlaidCloud Git接続

PlaidCloud Git接続は、ワークフロー、またはサーバーPanelアプリのビルドを、ワークスペース専用のマネージド Git サーバー上のリポジトリに接続します。この Git サーバーは git.<your-workspace>.plaid.cloud でお客様のために提供されており、通常の PlaidCloud ログインですでにサインインしているため、接続フォームは外部 Git プロバイダーのものよりはるかにシンプルです。サーバーURLを入力する必要はなく、ユーザー名、トークン、SSHキーを管理する必要もありません。

読み取り元のリポジトリが外部ホストではなく、ワークスペース内蔵の Git サービスである PlaidCloud Git にある場合は、PlaidCloud Git接続を使用します。最も一般的な用途は、マネージドリポジトリからのサーバーPanelアプリまたはDash アプリのビルドの自動化です。ブランチへのプッシュによってアプリが再ビルド・再デプロイされるため、外部の GitHub アカウントや個人用アクセストークンは不要です。

GitHub、GitLab、Bitbucket、Forgejo、Gitea など外部サービスでホストされているリポジトリには、代わりに外部 Git 接続を使用します。外部 Git 接続には、サーバーURL、ユーザー/トークンまたは SSO 認証、SSL タブと SSH タブを備えた完全なフォームがあります。

  1. Tools > Connections を開きます
  2. New Connection をクリックし、メニューから PlaidCloud Git を選択します
  3. 簡略化されたフォームに入力します。
    • アカウント名 — 接続の表示名
    • メモ — 接続の用途に関する任意のメモ
    • リポジトリ — Refresh をクリックしてワークスペースから到達できるリポジトリを一覧表示し、1 つ選択します(たとえば udfs や apps リポジトリ)。パスを入力するのではなく、一覧から選択します。
    • デフォルトブランチ — 選択したリポジトリのブランチ一覧から、デフォルトで読み取るブランチを選択します
    • 開始パス — 任意で、リポジトリを参照してフォルダーを選択すると、すべてのファイル検索がそのサブフォルダーに限定されます。未設定の場合はリポジトリ全体が対象です
  4. 使用方法を設定します。接続を有効にするには Active、接続で書き込みを一切行わない場合は Read Only を選択します
  5. セキュリティモデルを設定します。ワークスペース内で誰がこの接続を使用できるかを決めます
  6. Create をクリックして保存します

フォームはこれですべてです。外部 Git プロバイダーとは異なり、サーバーURL、認証タブ、SSL や SSH の設定はなく、これらはすべて自動的に処理されます。

Security Modelは、ワークスペース内で誰が接続を使用できるかを制御します。

オプション 接続を使用できるユーザー
非公開(オーナーのみ) オーナーのみ。
特定のメンバーのみ オーナーと、明示的に指定したメンバーの一覧。
特定のセキュリティグループのみ オーナーと、指定したセキュリティグループのメンバー。
すべてのワークスペースメンバー ワークスペース内の全員。

Specific Members OnlyまたはSpecific Security Groups Onlyの場合は、保存後に一覧の Actions メニューからアクセス権を付与します。共通の接続の仕組みについては、接続の作成と管理を参照してください。

リポジトリを閲覧できるユーザー

Section titled “リポジトリを閲覧できるユーザー”

PlaidCloud がお客様のために作成するすべてのリポジトリは、ワークスペースのサインイン済みのすべてのメンバーが読み取れます。これには、Panelアプリと Dashアプリの基盤となるリポジトリや、組み込みの apps および udfs リポジトリも含まれます。サインインしていないユーザーは読み取れません。

このため、メンバーはリポジトリごとの設定なしで、アプリを開いて再公開したり、PlaidCloud Git接続用のリポジトリを選択したりできます。

Git 管理者は、Git のインターフェースでリポジトリを非公開にできます。非公開リポジトリはすべてのメンバーには表示されなくなるため、次のようになります。

  • PlaidCloud Git接続のリポジトリ一覧に表示されません。
  • Git ベースの UDF コードを読み取れないため、非公開リポジトリに保存された Git ベースの UDF は実行されません。
  • メンバーはそのリポジトリからアプリを公開できません。

非公開リポジトリをソースとして使用するには、代わりに専用のアクセストークンを使った外部 Git 接続を作成します。

マネージド Git からの Panelアプリと Dashアプリのビルドを自動化する

Section titled “マネージド Git からの Panelアプリと Dashアプリのビルドを自動化する”

サーバーPanelアプリまたは Dashアプリは Git ブランチからビルドされ、そのブランチへのプッシュのたびに自動的に再ビルドされます。これを PlaidCloud Git接続に向けると、ループ全体がワークスペース内で完結し、外部ホストも、維持が必要な個人用アクセストークンも不要になります。

  1. アプリをワークスペースの PlaidCloud Git サーバー上のリポジトリにプッシュします。エントリポイントとなる .py ファイル(Panel では .servable() を呼び出し、Dash では server = app.server を公開します)と、リポジトリのルートまたはエントリポイントの隣に任意の requirements.txt を置きます。リポジトリの構成については、Panelアプリの作成または PlaidCloud Git からの Dashアプリのデプロイを参照してください。
  2. 上記の手順に従って、リポジトリにそのリポジトリを指定した PlaidCloud Git接続を作成します。
  3. アプリで 新規アプリ > サーバーベースまたはDash アプリを選択し、Git接続と公開ウォッチャーで次のように設定します。
    • Git接続 — 先ほど作成した PlaidCloud Git接続を選択します
    • ブランチ — ビルド元のブランチ。このブランチへのプッシュでアプリが再ビルド・再デプロイされます
    • エントリポイント — アプリが提供する .py ファイル
  4. 公開ダイアログを完了し、公開をクリックします。

以降は、マネージド Git サーバー上のそのブランチへのプッシュのたびにアプリが再ビルドされます。PlaidCloud の外に出ることのない、エンドツーエンドの自動ビルドです。