跳转到内容

从 PlaidCloud Git 部署 Dash 应用

这是从本机上的 Dash 应用代码到在线 URL 的完整流程,以 PlaidCloud Git (工作区内置的托管 Git 服务)作为源。由于 PlaidCloud Git 是托管的,应用部署所用的连接无需服务器 URL、用户名或令牌:PlaidCloud 会代为完成身份验证。

共有五个步骤:

  1. 编写一个最小的 Dash 应用。
  2. 将其放入 PlaidCloud Git 存储库。
  3. 创建托管的 PlaidCloud Git 连接。
  4. 发布指向该存储库的 Dash 应用。
  5. 打开已提供服务的应用,如果无法启动,请查看构建日志。

本演练与从 PlaidCloud Git 部署 Panel 应用几乎相同:两者都是基于 Git 构建、以相同方式提供服务的服务器端 Python 应用。区别在于应用代码本身和发布对话框中的一个字段。

  • 在工作区中打开 Git,确认可以访问 PlaidCloud Git。默认情况下,工作区的组织包含一个 apps 存储库,同样适合存放 Dash 应用。
  • 如果要从本机推送代码,请在本地安装 git(也可以在 Git 网页界面中添加文件)。

应用需要一个入口点,即构建 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 pcd
from dash import Dash, Input, Output, html
app = Dash(__name__) # picks up DASH_URL_BASE_PATHNAME from the platform automatically
server = 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 需要 Contributor 访问权限;如果 Git 选项卡显示您为查看者,请让工作区管理员将您添加到 Git Contributors。使用 Git 选项卡中存储库克隆地址旁边的复制按钮,然后执行:

终端窗口
git clone <clone URL>
cd apps
# add app.py (and requirements.txt), then:
git add app.py requirements.txt
git commit -m "Add hello dash app"
git push

请记下存储库路径 <org>/apps,其中 <org> 是工作区的组织名称,下一步需要输入该路径。有关克隆、提交和推送的完整说明,请参阅存储库。

此处的令牌仅用于您自己推送代码。 接下来创建的连接是托管的,不需要令牌,请勿混淆两者。

连接用于告知 Dash 部署其代码所在的位置。对于 PlaidCloud Git,该连接是托管的:PlaidCloud 提供主机和凭据,因此只需输入存储库目标。这与服务器 Panel 应用使用的连接类型相同。

  1. 打开 Tools > Connections,单击新建连接,然后选择 PlaidCloud Git。
  2. 为连接指定账户名称(例如 Apps Repo)。
  3. 将 Repository Path 设置为 <org>/apps(即步骤 2 中记下的路径),将默认分支设置为 main。除非应用位于子目录中,否则请将起始路径留空。
  4. 单击创建。

没有服务器 URL、用户、密码或 SSL/SSH 字段:PlaidCloud Git 是托管的,由平台处理主机和身份验证。有关完整表单(包括连接的用法和安全模型,即工作区中哪些人可以使用它),请参阅 PlaidCloud Git 连接。

现在让 Dash 部署指向该连接。

  1. 打开应用,然后选择新建应用 > Dash 应用。
  2. 在目录设置下,设置应用名称和 URL 标识;该标识是应用的 URL 和内部名称,因此请使用小写字母、数字和连字符,以字母开头,不超过 40 个字符(例如 hello-dash)。可选的备注用于描述应用。
  3. 在 Git 连接和发布监视器下:
    • Git 连接:在步骤 3 中创建的 PlaidCloud Git 连接。
    • 分支:main。推送到该分支会自动重新构建并重新部署应用。
    • 入口点:app.py。
  4. 在运行时下,选择 CPU、内存和空闲(分钟) 时长。仅当应用应在无需登录的情况下即可访问时,才勾选允许公共访问。这里没有设计设置,那是 Panel 特有的选项。
  5. 在高级(嵌入式服务) 下(可选):除非要将应用嵌入其他站点,否则请留空。
  6. 单击发布。

5. 打开应用,如果无法启动请查看日志

Section titled “5. 打开应用,如果无法启动请查看日志”

发布后,应用会进行构建:PlaidCloud 克隆该分支,安装 requirements.txt 中的依赖,并基于 platform-dash-base 镜像构建容器镜像。其状态显示在应用列表中并自动更新。

  • 状态为就绪时,可通过 https://<your-tenant-host>/serve/<slug>/ 打开应用。闲置后的第一次请求会将其启动,期间会短暂显示 PlaidCloud 加载屏幕。
  • 如果构建失败,请打开应用并查看其构建日志,缺少依赖或导入错误会在其中显示。有关各状态的含义、如何读取日志以及如何触发重新构建,请参阅使用 Dash 应用。

此后,每次推送到连接的分支都会自动重新构建并重新部署应用:编辑 app.py,执行 git push,更改即可上线。(如果应用已锁定,则会跳过推送,直到解锁为止,请参阅使用 Dash 应用。)