跳到正文

在 Fly.io 上部署 Kaeso

在 Fly.io 上,以四个应用运行,都在私有网络中:边缘服务、网关、控制台和 Valkey;数据库:Fly Managed Postgres。从创建应用,到您自己的证书,每条命令都在这里。

发布日期
阅读时间
4 分钟
作者
Kaeso Team
浓郁的薰衣草紫与长春花蓝渐变,呈柔和的水平褶皱,一角透着暖光

Fly.io 每个 fly.toml 运行一个应用,而 Kaeso 需要四个。仓库中的 deploy/fly/ 为每个应用准备了一份 Fly Launch 配置,固定为同一版本,数据库则由 Fly Managed Postgres 保存。Fly 没有适用于多应用项目的部署按钮,所以本指南是一组 fly 命令。

您会得到什么

  • …-edge
    文件
    edge.toml
    镜像
    控制台镜像,运行 kaeso-edge
    机器
    shared-cpu-1x,256 MB
  • …-gateway
    文件
    gateway.toml
    镜像
    网关镜像
    机器
    shared-cpu-2x,2 GB
  • …-console
    文件
    console.toml
    镜像
    控制台镜像
    机器
    shared-cpu-1x,256 MB
  • …-valkey
    文件
    valkey.toml
    镜像
    Valkey,使用一个 1 GB 的卷
    机器
    shared-cpu-1x,512 MB

只有边缘服务有公开的服务。其他应用只能在您组织的私有网络中通过 <app>.internal 访问;这个网络是 IPv6 的,所以网关在 [::]:8080 上监听。边缘服务读取由 Fly 代理设置的 Fly-Client-IP,而不是调用方可控制的 X-Forwarded-For。

Valkey 的数据保持在 256 MB 以内,从不驱逐任何键,所以 Valkey 写满时会拒绝写入,而不是丢弃限额计数器。它运行在一台机器上,只有一个卷,Fly 不会复制这个卷。对它保存的内容来说,这可以接受:网关会从 PostgreSQL 重建预算计数器,速率窗口则重新开始。

部署

1. 生成主密钥并存入一个变量,然后把 echo 打印的内容复制到密码管理器:

export KAESO_MASTER_KEYS=$(docker run --rm ghcr.io/logicplanes/kaeso-gateway:0.6.0 master-key generate)echo $KAESO_MASTER_KEYS

2. 登录并克隆 prod 分支,该分支包含最新版本:

fly auth logingit clone --branch prod https://github.com/logicplanes/kaeso.gitcd kaeso

3. 创建四个应用。 应用名称在整个 Fly.io 上是唯一的,所以请选一个自己的前缀:

export KAESO_APP=kaeso-examplefly apps create $KAESO_APP-edgefly apps create $KAESO_APP-gatewayfly apps create $KAESO_APP-consolefly apps create $KAESO_APP-valkey

4. 创建数据库,放在应用所在的区域,并把它挂接到网关。fly mpg list 会显示集群的 ID:

fly mpg create --name $KAESO_APP --region fra --pg-major-version 17fly mpg attach $CLUSTER_ID --app $KAESO_APP-gateway --variable-name KAESO_POSTGRES_URL

5. 设置机密,把示例换成您的 SMTP 服务器:

export VALKEY_PASSWORD=$(openssl rand -hex 24)fly secrets set --stage --app $KAESO_APP-valkey VALKEY_PASSWORD=$VALKEY_PASSWORDfly secrets set --stage --app $KAESO_APP-edge \  KAESO_GATEWAY_UPSTREAM=$KAESO_APP-gateway.internal:8080 \  KAESO_CONSOLE_UPSTREAM=$KAESO_APP-console.internal:3000fly secrets set --stage --app $KAESO_APP-gateway \  KAESO_PUBLIC_URL=https://$KAESO_APP-edge.fly.dev \  KAESO_VALKEY_URL=redis://:$VALKEY_PASSWORD@$KAESO_APP-valkey.internal:6379 \  KAESO_MASTER_KEYS="$KAESO_MASTER_KEYS" \  KAESO_SETUP_EMAIL=owner@example.com KAESO_SMTP_HOST=smtp.example.com KAESO_SMTP_USER=kaeso \  KAESO_SMTP_PASSWORD=secret KAESO_SMTP_FROM="Kaeso <kaeso@example.com>"

6. 部署:Valkey 和控制台各用一台机器,然后是网关和边缘服务:

fly deploy --config deploy/fly/valkey.toml --app $KAESO_APP-valkey --ha=falsefly deploy --config deploy/fly/console.toml --app $KAESO_APP-console --ha=falsefly deploy --config deploy/fly/gateway.toml --app $KAESO_APP-gatewayfly deploy --config deploy/fly/edge.toml --app $KAESO_APP-edge

7. 创建第一个用户,使用网关发送到 KAESO_SETUP_EMAIL 的一次性设置链接。网关镜像没有 shell,所以如果没有收到邮件,请在网关的日志中查看 SMTP 错误并改正机密,网关会在下次启动时发送一个新链接。

如需请求日志,把网关的 KAESO_CLICKHOUSE_URL 设为一个 ClickHouse HTTP URL,例如 ClickHouse Cloud 的。不设置时,请求日志关闭,用量、限额和预算照常工作。

使用自己的域名

为边缘服务添加证书,按 fly certs add 的提示设置 DNS 记录,并把新地址告诉网关:

fly certs add kaeso.example.com --app $KAESO_APP-edgefly secrets set --app $KAESO_APP-gateway KAESO_PUBLIC_URL=https://kaeso.example.com

更新和回滚

发布新版本会修改 edge.toml、gateway.toml 和 console.toml 中的镜像标签。拉取 prod,然后用第 6 步的命令依次部署网关、控制台和边缘服务。网关在启动时迁移数据库,只向前进行;机器停止时有 75 秒的时间处理完剩余请求。要回滚,部署之前的镜像:

fly deploy --config deploy/fly/gateway.toml --app $KAESO_APP-gateway \  --image ghcr.io/logicplanes/kaeso-gateway:0.6.0

须知

  • Fly Machines 没有只读根文件系统,也没有移除 Linux capabilities 的设置,所以这些应用只以镜像自带的用户运行。
  • Managed Postgres 提供 PostgreSQL 16 和 17,而 Compose 软件包运行的是 18。Kaeso 在 17 上运行,与 Google Cloud 上相同。
  • 网关信任组织私有网络中的每个地址。如果组织中的其他应用不应能设置网关记录的客户端地址,请把 Kaeso 放在一个单独的组织中运行。

已验证的内容

这些文件通过了 SchemaStore 的 fly.toml 模式检查,边缘服务的路由、流式传输和客户端地址处理通过了本地边缘测试。Kaeso 尚未从空白账户部署到 Fly.io。如果您部署了,请告诉我们结果如何。

下一步

作者:Kaeso Team

本页内容

网关归您。记录也归您。

curl -fsSLhttps://kaeso.app/install.sh | sh