PlaidCloud GitからDashアプリをデプロイする
このページでは、お使いのマシン上のDashアプリのコードからライブURLまでの全手順を、ワークスペースに組み込まれたマネージドGitサービスである PlaidCloud Git をソースとして説明します。PlaidCloud Gitはマネージドサービスのため、アプリのデプロイ元となる接続には サーバーURL、ユーザー名、トークンは不要 です。PlaidCloudがお客様に代わって認証します。
手順は次の5つです。
- 最小限のDashアプリを作成する。
- PlaidCloud Gitリポジトリに置く。
- マネージドのPlaidCloud Git接続を作成する。
- リポジトリを指すDashアプリを公開する。
- 配信されたアプリを開く。起動しない場合はビルドログを確認する。
この手順は PlaidCloud GitからPanelアプリをデプロイする とほぼ同じです。どちらもGitからビルドされ、同じ方法で配信されるサーバーサイドのPythonアプリだからです。違いはアプリのコードそのものと、公開ダイアログの1つのフィールドだけです。
- ワークスペースから Git を開き、PlaidCloud Gitにアクセスできることを確認します。デフォルトでは、ワークスペースの組織に
appsリポジトリが含まれています。Dashアプリにもそのまま使えます。 - お使いのマシンからコードをプッシュする場合は、
gitをローカルにインストールしておきます(GitのWeb UIでファイルを追加することもできます)。
1. 最小限のDashアプリを作成する
Section titled “1. 最小限のDashアプリを作成する”アプリには エントリポイント が必要です。これはDashアプリを構築してFlaskサーバーを公開するPythonファイルです。必要に応じて、追加パッケージ用の requirements.txt をリポジトリのルート、またはエントリポイントと同じ場所に置きます。
apps/├── app.py # entry point — exposes `server`└── requirements.txt # optional; extra dependencies (repo root or next to app.py)app.py を作成します。
import plaidcloud_dash as pcdfrom dash import Dash, Input, Output, html
app = Dash(__name__) # picks up DASH_URL_BASE_PATHNAME from the platform automaticallyserver = app.server # the platform imports this and wires per-user sign-in for you
app.layout = html.Div( [ html.H1("Hello from PlaidCloud Git"), html.P(id="whoami"), html.Button("Who am I?", id="whoami-btn", n_clicks=0), ])
@app.callback(Output("whoami", "children"), Input("whoami-btn", "n_clicks"))def _whoami(n_clicks): if not n_clicks: return "" return f"Signed in as {pcd.current_user()!r}"
if __name__ == "__main__": app.run(debug=True)これで完全なアプリです。dash、plotly、dash-mantine-components、dash-ag-grid、およびPlaidCloudクライアントライブラリ(plaidcloud-rpc、plaidcloud-utilities)はプリインストールされているため、requirements.txt には 追加の パッケージだけを記載します。Dash(__name__) に requests_pathname_prefix や url_base_pathname を渡さないでください。プラットフォームが DASH_URL_BASE_PATHNAME を通じてURLプレフィックスを自動的に設定するため、両方を設定すると起動時に設定エラーになります。アプリの仕様とデータアクセス用ヘルパーの詳細は、アプリの仕様 と Dashアプリでのデータとサインイン中のユーザーの読み取り を参照してください。
2. アプリをPlaidCloud Gitリポジトリに置く
Section titled “2. アプリをPlaidCloud Gitリポジトリに置く”ワークスペースにある既存の apps リポジトリを使うか、新しいリポジトリを作成 します。そのうえで、コードをリポジトリに入れます。
PlaidCloud経由でサインインするため、Gitアカウントには別のパスワードがありません。write:repository 権限を持つ 個人用アクセストークンを生成 し(アバター → 設定 → アプリケーション)、Gitがパスワードを求めたらそれを入力します。apps へのプッシュには コントリビューター のアクセス権が必要です。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 dash app"git pushリポジトリのパス <org>/apps を控えておいてください。<org> はワークスペースの組織名です。このパスは次の手順で入力します。クローン、コミット、プッシュの詳細は リポジトリ を参照してください。
ここでのトークンは、お客様がコードをプッシュするためだけのものです。 次に作成する接続はマネージドでトークンは不要です。両者を混同しないでください。
3. マネージドのPlaidCloud Git接続を作成する
Section titled “3. マネージドのPlaidCloud Git接続を作成する”接続 は、Dashデプロイメントがコードの置き場所を知るためのものです。PlaidCloud Gitの接続は マネージド で、ホストと認証情報はPlaidCloudが用意するため、入力するのはリポジトリの指定だけです。これはサーバーPanelアプリが使う接続と同じ種類です。
- ツール > 接続 を開き、新規接続 をクリックして PlaidCloud Git を選択します。
- 接続に アカウント名 を付けます(例:
Apps Repo)。 - Repository Path に手順2で控えたパス
<org>/appsを、デフォルトブランチ にmainを設定します。アプリがサブディレクトリにある場合を除き、開始パス は空欄のままにします。 - 作成 をクリックします。
サーバーURL、ユーザー、パスワード、SSL/SSHのフィールドはありません。PlaidCloud Gitはマネージドのため、ホストと認証はプラットフォームが処理します。接続の 使用方法 と セキュリティモデル(ワークスペース内で誰が使用できるか)を含むフォームの詳細は、PlaidCloud Git接続 を参照してください。
4. Dashアプリを公開する
Section titled “4. Dashアプリを公開する”次に、その接続をDashデプロイメントに指定します。
- アプリ を開き、新規アプリ > Dash アプリ を選択します。
- ディレクトリ設定 で アプリ名 と URLスラッグ を設定します。スラッグはアプリのURLと内部名になるため、小文字の英字、数字、ハイフンを使い、英字で始め、40文字以内にしてください(例:
hello-dash)。任意の メモ にはアプリの説明を入力できます。 - Git接続と公開ウォッチャー で次を設定します。
- Git接続 — 手順3で作成したPlaidCloud Git接続。
- ブランチ —
main。このブランチへのプッシュのたびに、アプリが自動的に再ビルドされ再デプロイされます。 - エントリポイント —
app.py。
- ランタイム で、CPU、メモリ、アイドル (分) の時間を選択します。サインインなしでアプリにアクセスできるようにする場合のみ、パブリックアクセスを許可 をオンにします。デザイン の設定はありません。これはPanel固有のオプションです。
- 詳細 (埋め込み配信) — 任意です。アプリを別のサイトに埋め込む場合を除き、空欄のままにします。
- 公開 をクリックします。
5. アプリを開く。起動しない場合はログを確認する
Section titled “5. アプリを開く。起動しない場合はログを確認する”公開すると、アプリの ビルド が始まります。PlaidCloudがブランチをクローンし、requirements.txt をインストールして、platform-dash-base イメージからコンテナーイメージを作成します。その ステータス は アプリ の一覧に表示され、自動的に更新されます。
- ステータスが 準備完了 になったら、
https://<your-tenant-host>/serve/<slug>/でアプリを開きます。アイドル状態の後の最初のリクエストでアプリが起動し、その間はPlaidCloudの短い読み込み画面が表示されます。 - ビルドが失敗した場合は、アプリを開いて ビルド ログを確認します。依存関係の不足やインポートエラーはそこに表示されます。各ステータスの意味、ログの読み方、再ビルドの方法は Dashアプリを使う を参照してください。
以降は、接続のブランチにプッシュするたびに、アプリが自動的に再ビルドされ再デプロイされます。app.py を編集して git push すれば、変更が反映されます。(アプリが ロック されている場合は、ロックを解除するまでプッシュはスキップされます。Dashアプリを使う を参照してください。)
次のステップ
Section titled “次のステップ”- Dashアプリでのデータとサインイン中のユーザーの読み取り — アプリを表示しているユーザーとしてPlaidCloudのデータをクエリします。
- Dashアプリを使う — ビルドステータス、ログ、ロック、アプリの削除。
- PlaidCloud Git接続 — 接続フォームの詳細、使用方法、セキュリティモデル。
- リポジトリ — PlaidCloud Gitでのブランチ、トークン、共同作業。