PlaidCloud GitからのPanelアプリのデプロイ
ここでは、手元のマシンにあるPanelアプリのコードから、公開URLまでの一連の流れを、ワークスペースに組み込まれた管理対象のGitサービスである PlaidCloud Git をソースとして説明します。PlaidCloud Gitは管理対象のため、アプリのデプロイに使用する接続には、サーバーのURL、ユーザー名、トークンが不要です。PlaidCloudが代わりに認証します。
手順は5つあります。
- 最小限のPanelアプリを作成します。
- PlaidCloud Gitリポジトリに配置します。
- 管理対象のPlaidCloud Git接続を作成します。
- リポジトリを指すサーバーアプリを公開します。
- 提供されているアプリを開きます。起動しない場合は、ビルドログを確認します。
各手順には、その内容を詳しく説明したガイドへのリンクがあります。このページは、それらを1つの流れにまとめたものです。
- ワークスペースからGitを開き、PlaidCloud Gitにアクセスできることを確認します。デフォルトでは、ワークスペースの組織に
appsリポジトリ(とudfsリポジトリ)が含まれています。Panelアプリの置き場所として最適です。 - 手元のマシンからコードをプッシュする場合は、ローカルに
gitをインストールしておきます(Gitのウェブ UIでファイルを追加することもできます)。
1. 最小限のPanelアプリを作成する
Section titled “1. 最小限のPanelアプリを作成する”アプリには、エントリポイント(Panelアプリを構築し、.servable()でマークするPythonファイル)が必要です。追加のパッケージが必要な場合は、requirements.txt を、リポジトリのルート、またはエントリポイントの隣に配置します。
apps/├── app.py # entry point — calls .servable()└── requirements.txt # optional; extra dependencies (repo root or next to app.py)app.pyを作成します。
import panel as pn
pn.extension()
pn.pane.Markdown("# Hello from PlaidCloud Git 👋\n\nServed straight from your workspace repository.").servable()これで完全なアプリです。PlaidCloudが提供するのは.servable()の呼び出しです。panel、bokeh、PlaidCloudのクライアントライブラリ(plaidcloud-rpc、plaidcloud-utilities)はプリインストールされているため、requirements.txtには追加のパッケージのみを記載します。より充実した例、依存関係、ライト/ダークのテーマ設定については、Panelアプリの作成を参照してください。
2. アプリをPlaidCloud Gitリポジトリに配置する
Section titled “2. アプリをPlaidCloud Gitリポジトリに配置する”ワークスペースの既存の apps リポジトリを使用するか、新しいリポジトリを作成します。次に、コードをそこに配置します。Panel Studioで構築したアプリは、すでにapps内のフォルダーになっているため、自分のアプリの隣にあります。
PlaidCloudを通じてサインインするため、Gitアカウントには別のパスワードがありません。write:repository権限を持つパーソナルアクセストークンを生成し(アバター → Settings → Applications)、Gitからプロンプトが表示されたときに、パスワードとして使用します。appsへのプッシュにはContributorアクセスが必要です。Gitタブで閲覧者と表示されている場合は、ワークスペース管理者にGit Contributorsへの追加を依頼してください。Gitタブで、リポジトリのクローンアドレスの横にあるコピーボタンを使用し、次を実行します。
git clone <clone URL>cd apps# add app.py (and requirements.txt), then:git add app.py requirements.txtgit commit -m "Add hello panel app"git pushリポジトリのパス<org>/apps(<org>はワークスペースの組織名)を控えておいてください。次の手順で、そのパスを入力します。クローン、コミット、プッシュの詳細は、リポジトリにあります。
ここでのトークンは、ご自身がコードをプッシュするためだけのものです。次に作成する接続は管理対象で、トークンは不要です。この2つを混同しないでください。
3. 管理対象のPlaidCloud Git接続を作成する
Section titled “3. 管理対象のPlaidCloud Git接続を作成する”接続は、Panelのデプロイメントに、コードの場所を伝えます。PlaidCloud Gitの接続は管理対象です。PlaidCloudがホストと認証情報を提供するため、入力するのはリポジトリのターゲットのみです。
- Tools > Connectionsを開き、新規接続をクリックして、PlaidCloud Gitを選択します。
- 接続にアカウント名を付けます(たとえば、
Apps Repo)。 - Repository Pathを
<org>/apps(手順2で控えたパス)に、デフォルトブランチをmainに設定します。アプリがサブディレクトリにある場合を除き、開始パスは空白のままにします。 - 作成をクリックします。
サーバーURL、ユーザー、パスワード、SSL/SSHのフィールドはありません。PlaidCloud Gitは管理対象のため、ホストと認証はプラットフォームが処理します。接続の使用方法とセキュリティモデル(ワークスペース内で誰が使用できるか)を含む、フォーム全体については、PlaidCloud Git接続を参照してください。
古いワークスペースのビルドの場合は、 サーバーURLや認証情報のフィールドがまだ表示される場合は、空白のままにしてください。どちらの場合も、プラットフォームが代わりに認証します。
4. サーバーアプリを公開する
Section titled “4. サーバーアプリを公開する”次に、サーバーのデプロイメントを、その接続に向けます。
- アプリを開き、新規アプリ > サーバーベースを選択します。
- ディレクトリ設定で、アプリ名とURLスラッグを設定します。スラッグはアプリのURLと内部名になるため、小文字、数字、ハイフンのみで、文字で始まり、40文字以内にします(たとえば、
hello-panel)。 - Git接続と公開ウォッチャーで:
- Git接続 — 手順3で作成したPlaidCloud Git接続です。
- ブランチ —
mainです。このブランチにプッシュすると、アプリが自動的に再ビルドされ、再デプロイされます。 - エントリポイント —
app.pyです。
- ランタイムで、CPU、メモリ、デザイン(PlaidCloudのモダンな外観にはFAST)、Idleウィンドウを選択します。サインインなしでアプリにアクセスできるようにする場合のみ、パブリックアクセスを許可をチェックします。
- 公開をクリックします。
このダイアログのすべてのフィールドについては、Panelアプリの作成で説明しています。
5. アプリを開く。起動しない場合はログを確認する
Section titled “5. アプリを開く。起動しない場合はログを確認する”公開すると、アプリはビルドされます。PlaidCloudがブランチをクローンし、requirements.txt(リポジトリのルートのものと、あればアプリのフォルダーのもの)をインストールして、コンテナーイメージをビルドします。ステータスはアプリリストに表示され、自動的に更新されます。
- ステータスが準備完了になったら、
https://<your-tenant-host>/serve/<slug>/でアプリを開きます。アイドル状態の後の最初のリクエストでアプリが起動し、その間はPlaidCloudの短い読み込み画面が表示されます。 - ビルドが失敗した場合は、アプリを開いてビルドログを確認します。不足している依存関係やインポートエラーが、そこに表示されます。各ステータスの意味、ログの読み方、再ビルドの実行方法については、Panelアプリの使い方を参照してください。
以降は、接続のブランチにプッシュするたびに、アプリが自動的に再ビルドされ、再デプロイされます。app.pyを編集してgit pushすれば、変更が反映されます。(ただし、アプリがロックされている場合は除きます。アプリのロックを参照してください。その場合、ロックを解除するまで、プッシュはスキップされます。)
次のステップ
Section titled “次のステップ”- Panelアプリの作成 — より充実した例、依存関係、ライト/ダークのテーマ設定
- PlaidCloud Git接続 — 接続フォーム全体、使用方法、セキュリティモデル
- データとサインイン中のユーザーの読み取り — アプリを閲覧しているユーザーとして、PlaidCloudのデータをクエリします
- リポジトリ — PlaidCloud Gitでのブランチ、トークン、共同作業